mirror of
https://github.com/upstash/context7.git
synced 2025-12-12 15:31:42 +00:00
Merge pull request #69 from upstash/chore/readme
Feat: improve readme and add 5000 tokens minimum enforcement
This commit is contained in:
commit
aab899b31e
27
README.md
27
README.md
@ -1,4 +1,5 @@
|
||||
# Context7 MCP - Up-to-date Docs For Any Prompt
|
||||
|
||||
[](https://context7.com) [](https://smithery.ai/server/@upstash/context7-mcp)
|
||||
|
||||
## ❌ Without Context7
|
||||
@ -23,7 +24,6 @@ Create a basic Next.js project with app router. use context7
|
||||
Create a script to delete the rows where the city is "" given PostgreSQL credentials. use context7
|
||||
```
|
||||
|
||||
|
||||
Context7 fetches up-to-date code examples and documentation right into your LLM's context.
|
||||
|
||||
- 1️⃣ Write your prompt naturally
|
||||
@ -153,11 +153,11 @@ Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude D
|
||||
### Available Tools
|
||||
|
||||
- `resolve-library-id`: Resolves a general library name into a Context7-compatible library ID.
|
||||
- `libraryName` (optional): Search and rerank results
|
||||
- `libraryName` (required)
|
||||
- `get-library-docs`: Fetches documentation for a library using a Context7-compatible library ID.
|
||||
- `context7CompatibleLibraryID` (required)
|
||||
- `topic` (optional): Focus the docs on a specific topic (e.g., "routing", "hooks")
|
||||
- `tokens` (optional, default 5000): Max number of tokens to return
|
||||
- `tokens` (optional, default 5000): Max number of tokens to return. Values less than 5000 are automatically increased to 5000.
|
||||
|
||||
## Development
|
||||
|
||||
@ -211,9 +211,26 @@ If you see this error, try using `bunx` instead of `npx`.
|
||||
|
||||
This often resolves module resolution issues, especially in environments where `npx` does not properly install or resolve packages.
|
||||
|
||||
## Context7 in media
|
||||
### MCP Client Errors
|
||||
|
||||
+ [Better Stack: "Free Tool Makes Cursor 10x Smarter"](https://youtu.be/52FC3qObp9E)
|
||||
1. Try removing `@latest` from the package name.
|
||||
|
||||
2. Try using `bunx` as an alternative.
|
||||
|
||||
3. Try using `deno` as an alternative.
|
||||
|
||||
## Context7 In Media
|
||||
|
||||
- [Better Stack: "Free Tool Makes Cursor 10x Smarter"](https://youtu.be/52FC3qObp9E)
|
||||
- [Cole Medin: "This is Hands Down the BEST MCP Server for AI Coding Assistants"](https://www.youtube.com/watch?v=G7gK8H6u7Rs)
|
||||
- [Income stream surfers: "Context7 + SequentialThinking MCPs: Is This AGI?"](https://www.youtube.com/watch?v=-ggvzyLpK6o)
|
||||
- [Julian Goldie SEO: "Context7: New MCP AI Agent Update"](https://www.youtube.com/watch?v=CTZm6fBYisc)
|
||||
- [JeredBlu: "Context 7 MCP: Get Documentation Instantly + VS Code Setup"](https://www.youtube.com/watch?v=-ls0D-rtET4)
|
||||
- [Income stream surfers: "Context7: The New MCP Server That Will CHANGE AI Coding"](https://www.youtube.com/watch?v=PS-2Azb-C3M)
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://www.star-history.com/#upstash/context7&Date)
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@ -81,9 +81,7 @@ server.tool(
|
||||
.describe("Topic to focus documentation on (e.g., 'hooks', 'routing')."),
|
||||
tokens: z
|
||||
.preprocess((val) => (typeof val === "string" ? Number(val) : val), z.number())
|
||||
.refine((val) => typeof val === "number" && val >= DEFAULT_MINIMUM_TOKENS, {
|
||||
message: `Must be a number >= ${DEFAULT_MINIMUM_TOKENS}`,
|
||||
})
|
||||
.transform((val) => (val < DEFAULT_MINIMUM_TOKENS ? DEFAULT_MINIMUM_TOKENS : val))
|
||||
.optional()
|
||||
.describe(
|
||||
`Maximum number of tokens of documentation to retrieve (default: ${DEFAULT_MINIMUM_TOKENS}). Higher values provide more context but consume more tokens.`
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user