diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md
index 95a0b32..49f034e 100644
--- a/docs/README.zh-CN.md
+++ b/docs/README.zh-CN.md
@@ -30,7 +30,11 @@ Context7将最新的代码示例和文档直接获取到你的LLM上下文中。
- 2️⃣ 告诉LLM`使用 context7`
- 3️⃣ 获取可用的代码回复
-无需在标签间切换,不存在幻觉API,不会生成过时的代码。
+无需在标签间切换,不存在幻觉API,不会生成过时的代码生成。
+
+## 📚 添加项目
+
+查看我们的[项目添加指南](./docs/adding-projects.md)来学习如何将你最喜欢的库添加(或更新)到 Context7。
## 🛠️ 开始使用
@@ -39,26 +43,52 @@ Context7将最新的代码示例和文档直接获取到你的LLM上下文中。
- Node.js >= v18.0.0
- Cursor, Windsurf, Claude Desktop或其他MCP客户端
-### 通过Smithery安装
+
+通过 Smithery 安装
-要通过[Smithery](https://smithery.ai/server/@upstash/context7-mcp)自动安装Context7 MCP Server for Claude Desktop:
+通过 [Smithery](https://smithery.ai/server/@upstash/context7-mcp) 为任何客户端自动安装 Context7 MCP 服务器:
```bash
-npx -y @smithery/cli install @upstash/context7-mcp --client claude
+npx -y @smithery/cli@latest install @upstash/context7-mcp --client --key
```
-### 在Cursor中安装
+你可以在 [Smithery.ai 网页](https://smithery.ai/server/@upstash/context7-mcp)中找到你的 Smithery 密钥。
+
+
+
+
+在 Cursor 中安装
前往:`Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`
-推荐的方法是将以下配置粘贴到你的Cursor `~/.cursor/mcp.json`文件中。更多信息请参见[Cursor MCP文档](https://docs.cursor.com/context/model-context-protocol)。
+推荐将以下配置粘贴到你的 Cursor `~/.cursor/mcp.json` 文件中。你也可以通过在项目文件夹中创建 `.cursor/mcp.json` 在特定项目中安装。更多信息请参阅 [Cursor MCP 文档](https://docs.cursor.com/context/model-context-protocol)。
+
+> 自 Cursor 1.0 起,你可以点击下面的安装按钮进行即时一键安装。
+
+#### Cursor 远程服务器连接
+
+[](https://cursor.com/en/install-mcp?name=context7&config=eyJ1cmwiOiJodHRwczovL21jcC5jb250ZXh0Ny5jb20vbWNwIn0%3D)
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+}
+```
+
+#### Cursor 本地服务器连接
+
+[](https://cursor.com/en/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IC15IEB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)
```json
{
"mcpServers": {
"context7": {
"command": "npx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
+ "args": ["-y", "@upstash/context7-mcp"]
}
}
}
@@ -67,12 +97,14 @@ npx -y @smithery/cli install @upstash/context7-mcp --client claude
替代方案:使用Bun
+[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoiYnVueCAteSBAdXBzdGFzaC9jb250ZXh0Ny1tY3AifQ%3D%3D)
+
```json
{
"mcpServers": {
"context7": {
"command": "bunx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
+ "args": ["-y", "@upstash/context7-mcp"]
}
}
}
@@ -83,12 +115,19 @@ npx -y @smithery/cli install @upstash/context7-mcp --client claude
替代方案:使用Deno
+[](https://cursor.com/install-mcp?name=context7&config=eyJjb21tYW5kIjoiZGVubyBydW4gLS1hbGxvdy1lbnYgLS1hbGxvdy1uZXQgbnBtOkB1cHN0YXNoL2NvbnRleHQ3LW1jcCJ9)
+
```json
{
"mcpServers": {
"context7": {
"command": "deno",
- "args": ["run", "--allow-net", "npm:@upstash/context7-mcp"]
+ "args": [
+ "run",
+ "--allow-env=NO_DEPRECATION,TRACE_DEPRECATION",
+ "--allow-net",
+ "npm:@upstash/context7-mcp"
+ ]
}
}
}
@@ -96,41 +135,152 @@ npx -y @smithery/cli install @upstash/context7-mcp --client claude
-### 在Windsurf中安装
+
-将此内容添加到你的Windsurf MCP配置文件中。更多信息请参见[Windsurf MCP文档](https://docs.windsurf.com/windsurf/mcp)。
+
+在 Windsurf 中安装
+
+将此内容添加到你的 Windsurf MCP 配置文件中。更多信息请参阅 [Windsurf MCP 文档](https://docs.windsurf.com/windsurf/cascade/mcp)。
+
+#### Windsurf 远程服务器连接
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "serverUrl": "https://mcp.context7.com/sse"
+ }
+ }
+}
+```
+
+#### Windsurf 本地服务器连接
```json
{
"mcpServers": {
"context7": {
"command": "npx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
+ "args": ["-y", "@upstash/context7-mcp"]
}
}
}
```
-### 在VSCode中安装
+
-[
](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522context7%2522%252C%2522config%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540upstash%252Fcontext7-mcp%2540latest%2522%255D%257D%257D)
-[
](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522context7%2522%252C%2522config%2522%253A%257B%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522-y%2522%252C%2522%2540upstash%252Fcontext7-mcp%2540latest%2522%255D%257D%257D)
+
+在 Trae 中安装
-将此内容添加到你的VSCode MCP配置文件中。更多信息请参见[VSCode MCP文档](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)。
+使用手动添加功能并填写该 MCP 服务器的 JSON 配置信息。
+更多详情,请访问 [Trae 文档](https://docs.trae.ai/ide/model-context-protocol?_lang=en)。
+
+#### Trae 远程服务器连接
```json
{
- "servers": {
- "Context7": {
- "type": "stdio",
- "command": "npx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
}
}
}
```
-### 在Zed中安装
+#### Trae 本地服务器连接
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+在 VS Code 中安装
+
+[
](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)
+[
](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22context7%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40upstash%2Fcontext7-mcp%40latest%22%5D%7D)
+
+将此内容添加到你的 VS Code MCP 配置文件中。更多信息请参阅 [VS Code MCP 文档](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)。
+
+#### VS Code 远程服务器连接
+
+```json
+"mcp": {
+ "servers": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+}
+```
+
+#### VS Code 本地服务器连接
+
+```json
+"mcp": {
+ "servers": {
+ "context7": {
+ "type": "stdio",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+在 Visual Studio 2022 中安装
+
+你可以按照 [Visual Studio MCP 服务器文档](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022) 在 Visual Studio 2022 中配置 Context7 MCP。
+
+将此内容添加到你的 Visual Studio MCP 配置文件中(详细信息请参阅 [Visual Studio 文档](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022)):
+
+```json
+{
+ "mcp": {
+ "servers": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+ }
+}
+```
+
+或者,对于本地服务器:
+
+```json
+{
+ "mcp": {
+ "servers": {
+ "context7": {
+ "type": "stdio",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+ }
+}
+```
+
+更多信息和故障排除,请参阅 [Visual Studio MCP 服务器文档](https://learn.microsoft.com/visualstudio/ide/mcp-servers?view=vs-2022)。
+
+
+
+
+在 Zed 中安装
可以通过[Zed扩展](https://zed.dev/extensions?query=Context7)安装,或者你可以将以下内容添加到你的Zed `settings.json`文件中。更多信息请参见[Zed Context Server文档](https://zed.dev/docs/assistant/context-servers)。
@@ -140,7 +290,7 @@ npx -y @smithery/cli install @upstash/context7-mcp --client claude
"Context7": {
"command": {
"path": "npx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
+ "args": ["-y", "@upstash/context7-mcp"]
},
"settings": {}
}
@@ -148,54 +298,200 @@ npx -y @smithery/cli install @upstash/context7-mcp --client claude
}
```
-### 在Claude Code中安装
+
-运行此命令。更多信息请参见[Claude Code MCP文档](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp)。
+
+在 Gemini CLI 中安装
-```sh
-claude mcp add context7 -- npx -y @upstash/context7-mcp@latest
-```
+详细信息请参阅 [Gemini CLI 配置](https://github.com/google-gemini/gemini-cli/blob/main/docs/cli/configuration.md)。
-### 在Claude Desktop中安装
-
-将此内容添加到你的Claude Desktop `claude_desktop_config.json`文件中。更多信息请参见[Claude Desktop MCP文档](https://modelcontextprotocol.io/quickstart/user)。
-
-```json
-{
- "mcpServers": {
- "Context7": {
- "command": "npx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
- }
- }
-}
-```
-
-### 在 Copilot Coding Agent 中安装
-
-将以下配置添加到 Copilot Coding Agent 的 `mcp` 配置部分(Repository->Settings->Copilot->Coding agent->MCP configuration):
+1. 打开 Gemini CLI 设置文件。位置是 `~/.gemini/settings.json`(其中 `~` 是你的主目录)。
+2. 将以下内容添加到你的 `settings.json` 文件中的 `mcpServers` 对象:
```json
{
"mcpServers": {
"context7": {
- "type": "http",
- "url": "https://mcp.context7.com/mcp",
- "tools": ["get-library-docs", "resolve-library-id"]
+ "httpUrl": "https://mcp.context7.com/mcp"
}
}
}
```
-更多信息请参见[官方GitHub文档](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp)。
+或者,对于本地服务器:
-### 使用Docker(容器部署)
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
-如果你希望使用Docker容器运行MCP服务器:
+如果 `mcpServers` 对象不存在,请创建它。
-1. **构建Docker镜像:**
+
- **确保Docker Desktop(或Docker守护进程)正在运行。** 在项目根目录运行:
+
+在 Claude Code 中安装
+
+运行此命令。更多信息请参阅 [Claude Code MCP 文档](https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp)。
+
+#### Claude Code 远程服务器连接
+
+```sh
+claude mcp add --transport http context7 https://mcp.context7.com/mcp
+```
+
+或使用 SSE 传输:
+
+```sh
+claude mcp add --transport sse context7 https://mcp.context7.com/sse
+```
+
+#### Claude Code 本地服务器连接
+
+```sh
+claude mcp add context7 -- npx -y @upstash/context7-mcp
+```
+
+
+
+
+在 Claude Desktop 中安装
+
+将此内容添加到你的 Claude Desktop `claude_desktop_config.json` 文件中。更多信息请参阅 [Claude Desktop MCP 文档](https://modelcontextprotocol.io/quickstart/user)。
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+在 Crush 中安装
+
+将此内容添加到你的 Crush 配置文件中。更多信息请参阅 [Crush MCP 文档](https://github.com/charmbracelet/crush#mcps)。
+
+#### Crush 远程服务器连接 (HTTP)
+
+```json
+{
+ "$schema": "https://charm.land/crush.json",
+ "mcp": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+}
+```
+
+#### Crush 远程服务器连接 (SSE)
+
+```json
+{
+ "$schema": "https://charm.land/crush.json",
+ "mcp": {
+ "context7": {
+ "type": "sse",
+ "url": "https://mcp.context7.com/sse"
+ }
+ }
+}
+```
+
+#### Crush 本地服务器连接
+
+```json
+{
+ "$schema": "https://charm.land/crush.json",
+ "mcp": {
+ "context7": {
+ "type": "stdio",
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+
+在 Cline 中安装
+
+
+你可以按照以下说明通过 [Cline MCP 服务器市场](https://cline.bot/mcp-marketplace) 轻松安装 Context7:
+
+1. 打开 **Cline**。
+2. 点击汉堡菜单图标 (☰) 进入 **MCP 服务器** 部分。
+3. 在 **市场** 标签中使用搜索栏查找 _Context7_。
+4. 点击 **安装** 按钮。
+
+
+
+
+在 BoltAI 中安装
+
+打开应用的"设置"页面,导航到"插件",并输入以下 JSON:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+保存后,在聊天中输入 `get-library-docs` 后跟你的 Context7 文档 ID(例如,`get-library-docs /nuxt/ui`)。更多信息请参阅 [BoltAI 文档网站](https://docs.boltai.com/docs/plugins/mcp-servers)。对于 iOS 上的 BoltAI,[请参阅此指南](https://docs.boltai.com/docs/boltai-mobile/mcp-servers)。
+
+
+
+
+使用 Docker
+
+如果你更喜欢在 Docker 容器中运行 MCP 服务器:
+
+1. **构建 Docker 镜像:**
+
+ 首先,在项目根目录(或任何你喜欢的地方)创建一个 `Dockerfile`:
+
+
+ 点击查看 Dockerfile 内容
+
+ ```Dockerfile
+ FROM node:18-alpine
+
+ WORKDIR /app
+
+ # 全局安装最新版本
+ RUN npm install -g @upstash/context7-mcp
+
+ # 如果需要,暴露默认端口(可选,取决于 MCP 客户端交互)
+ # EXPOSE 3000
+
+ # 运行服务器的默认命令
+ CMD ["context7-mcp"]
+ ```
+
+
+
+ 然后,使用标签(例如,`context7-mcp`)构建镜像。**确保 Docker Desktop(或 Docker 守护进程)正在运行。** 在保存 `Dockerfile` 的同一目录中运行以下命令:
```bash
docker build -t context7-mcp .
@@ -222,16 +518,21 @@ claude mcp add context7 -- npx -y @upstash/context7-mcp@latest
}
```
- _注意事项:_
-
+ _注意:这是一个示例配置。请参考前面 README 中针对你的 MCP 客户端(如 Cursor、VS Code 等)的具体示例来调整结构(例如,`mcpServers` 与 `servers`)。另外,确保 `args` 中的镜像名称与 `docker build` 命令期间使用的标签匹配。_
- - 此为示例配置。请参考前面README中针对具体MCP客户端(如Cursor、VS Code等)的示例来调整结构(如`mcpServers`与`servers`)。同时确保`args`中的镜像名称与`docker build`命令使用的标签一致。
- - 当前Cursor版本(0.49.5), 请不要使用本方式启动MCP server,详情:[Cursor官方说明](https://docs.cursor.com/context/model-context-protocol#remote-development)
-
+
-### 在Windows上安装
+
+使用桌面扩展安装
-在windows上的配置相对于linux或macos来说有些许不同,(_示例使用的`Cline`_), 其它编辑器同理, 参考`command`和`args`的配置即可
+安装 dxt 文件夹下的 [context7.dxt](dxt/context7.dxt) 文件并将其添加到你的客户端。更多信息请查看[桌面扩展文档](https://github.com/anthropics/dxt#desktop-extensions-dxt)。
+
+
+
+
+在 Windows 中安装
+
+在 Windows 上的配置与 Linux 或 macOS 略有不同(_示例中使用了 `Cline`_), 其它编辑器同理, 参考`command`和`args`的配置即可。
```json
{
@@ -246,16 +547,424 @@ claude mcp add context7 -- npx -y @upstash/context7-mcp@latest
}
```
-### 可用工具
+
-- `resolve-library-id`: 将通用库名称解析为Context7兼容的库ID。
- - `libraryName` (必需)
-- `get-library-docs`: 使用Context7兼容的库ID获取库的文档。
- - `context7CompatibleLibraryID` (必需)
- - `topic` (可选): 将文档集中在特定主题上(例如"routing"、"hooks")
- - `tokens` (可选,默认10000): 返回的最大令牌数。小于10000的值会自动增加到10000。
+
+在 Augment Code 中安装
-## 开发
+要在 Augment Code 中配置 Context7 MCP,你可以使用图形界面或手动配置。
+
+### **A. 使用 Augment Code UI**
+
+1. 点击汉堡菜单。
+2. 选择 **设置**。
+3. 导航到 **工具** 部分。
+4. 点击 **+ 添加 MCP** 按钮。
+5. 输入以下命令:
+
+ ```
+ npx -y @upstash/context7-mcp@latest
+ ```
+
+6. 命名 MCP:**Context7**。
+7. 点击 **添加** 按钮。
+
+一旦添加了 MCP 服务器,你就可以直接在 Augment Code 中开始使用 Context7 的最新代码文档功能。
+
+---
+
+### **B. 手动配置**
+
+1. 按 Cmd/Ctrl Shift P 或进入 Augment 面板中的汉堡菜单
+2. 选择编辑设置
+3. 在高级下,点击在 settings.json 中编辑
+4. 将服务器配置添加到 `augment.advanced` 对象中的 `mcpServers` 数组
+
+"augment.advanced": {
+"mcpServers": [
+{
+"name": "context7",
+"command": "npx",
+"args": ["-y", "@upstash/context7-mcp"]
+}
+]
+}
+
+一旦添加了 MCP 服务器,重启你的编辑器。如果你收到任何错误,请检查语法以确保没有遗漏结束括号或逗号。
+
+
+
+
+在 Roo Code 中安装
+
+将此内容添加到你的 Roo Code MCP 配置文件中。更多信息请参阅 [Roo Code MCP 文档](https://docs.roocode.com/features/mcp/using-mcp-in-roo)。
+
+#### Roo Code 远程服务器连接
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "type": "streamable-http",
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+}
+```
+
+#### Roo Code 本地服务器连接
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+在 Rovo Dev CLI 中安装
+
+通过运行以下命令编辑你的 Rovo Dev CLI MCP 配置 -
+
+```bash
+acli rovodev mcp
+```
+
+示例配置 -
+
+#### 远程服务器连接
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+}
+```
+
+#### 本地服务器连接
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+在 Zencoder 中安装
+
+要在 Zencoder 中配置 Context7 MCP,请按照以下步骤操作:
+
+1. 转到 Zencoder 菜单 (...)
+2. 从下拉菜单中选择代理工具
+3. 点击添加自定义 MCP
+4. 从下面添加名称和服务器配置,并确保点击安装按钮
+
+```json
+{
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp@latest"]
+}
+```
+
+添加 MCP 服务器后,你可以轻松继续使用它。
+
+
+
+
+在 Amazon Q Developer CLI 中安装
+
+将此内容添加到你的 Amazon Q Developer CLI 配置文件中。更多详情请参阅 [Amazon Q Developer CLI 文档](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-mcp-configuration.html)。
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp@latest"]
+ }
+ }
+}
+```
+
+
+
+
+在 Qodo Gen 中安装
+
+更多详情请参阅 [Qodo Gen 文档](https://docs.qodo.ai/qodo-documentation/qodo-gen/qodo-gen-chat/agentic-mode/agentic-tools-mcps)。
+
+1. 在 VSCode 或 IntelliJ 中打开 Qodo Gen 聊天面板。
+2. 点击连接更多工具。
+3. 点击 + 添加新 MCP。
+4. 添加以下配置:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "url": "https://mcp.context7.com/mcp"
+ }
+ }
+}
+```
+
+
+
+
+在 JetBrains AI Assistant 中安装
+
+更多详情请参阅 [JetBrains AI Assistant 文档](https://www.jetbrains.com/help/ai-assistant/configure-an-mcp-server.html)。
+
+1. 在 JetBrains IDE 中转到 `设置` -> `工具` -> `AI Assistant` -> `模型上下文协议 (MCP)`
+2. 点击 `+ 添加`。
+3. 点击对话框左上角的 `命令`,从列表中选择 As JSON 选项
+4. 添加此配置并点击 `确定`
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+5. 点击 `应用` 保存更改。
+6. 同样地,context7 可以在 `设置` -> `工具` -> `Junie` -> `MCP 设置` 中为 JetBrains Junie 添加
+
+
+
+
+在 Warp 中安装
+
+详细信息请参阅 [Warp 模型上下文协议文档](https://docs.warp.dev/knowledge-and-collaboration/mcp#adding-an-mcp-server)。
+
+1. 导航 `设置` > `AI` > `管理 MCP 服务器`。
+2. 通过点击 `+ 添加` 按钮添加新的 MCP 服务器。
+3. 粘贴下面给出的配置:
+
+```json
+{
+ "Context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"],
+ "env": {},
+ "working_directory": null,
+ "start_on_launch": true
+ }
+}
+```
+
+4. 点击 `保存` 应用更改。
+
+
+
+
+在 Opencode 中安装
+
+将此内容添加到你的 Opencode 配置文件中。更多信息请参阅 [Opencode MCP 文档](https://opencode.ai/docs/mcp-servers)。
+
+#### Opencode 远程服务器连接
+
+```json
+"mcp": {
+ "context7": {
+ "type": "remote",
+ "url": "https://mcp.context7.com/mcp",
+ "enabled": true
+ }
+}
+```
+
+#### Opencode 本地服务器连接
+
+```json
+{
+ "mcp": {
+ "context7": {
+ "type": "local",
+ "command": ["npx", "-y", "@upstash/context7-mcp"],
+ "enabled": true
+ }
+ }
+}
+```
+
+
+
+
+
+在 Copilot Coding Agent 中安装
+
+## 在 Copilot Coding Agent 中使用 Context7
+
+将以下配置添加到你的 Copilot Coding Agent 配置文件的 `mcp` 部分 Repository->Settings->Copilot->Coding agent->MCP configuration:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "type": "http",
+ "url": "https://mcp.context7.com/mcp",
+ "tools": ["get-library-docs", "resolve-library-id"]
+ }
+ }
+}
+```
+
+更多信息,请参阅[官方 GitHub 文档](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp)。
+
+
+
+
+
+在 Kiro 中安装
+
+详细信息请参阅 [Kiro 模型上下文协议文档](https://kiro.dev/docs/mcp/configuration/)。
+
+1. 导航 `Kiro` > `MCP 服务器`
+2. 通过点击 `+ 添加` 按钮添加新的 MCP 服务器。
+3. 粘贴下面给出的配置:
+
+```json
+{
+ "mcpServers": {
+ "Context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"],
+ "env": {},
+ "disabled": false,
+ "autoApprove": []
+ }
+ }
+}
+```
+
+4. 点击 `保存` 应用更改。
+
+
+
+在 OpenAI Codex 中安装
+
+更多信息请参阅 [OpenAI Codex](https://github.com/openai/codex)。
+
+将以下配置添加到你的 OpenAI Codex MCP 服务器设置:
+
+```toml
+[mcp_servers.context7]
+args = ["-y", "@upstash/context7-mcp"]
+command = "npx"
+```
+
+
+
+在 LM Studio 中安装
+
+更多信息请参阅 [LM Studio MCP 支持](https://lmstudio.ai/blog/lmstudio-v0.3.17)。
+
+#### 一键安装:
+
+[](https://lmstudio.ai/install-mcp?name=context7&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB1cHN0YXNoL2NvbnRleHQ3LW1jcCJdfQ%3D%3D)
+
+#### 手动设置:
+
+1. 导航到 `程序`(右侧)> `安装` > `编辑 mcp.json`。
+2. 粘贴下面给出的配置:
+
+```json
+{
+ "mcpServers": {
+ "Context7": {
+ "command": "npx",
+ "args": ["-y", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+3. 点击 `保存` 应用更改。
+4. 从右侧的 `程序` 下或通过点击聊天框底部的插头图标来打开/关闭 MCP 服务器。
+
+
+
+在 Perplexity Desktop 中安装
+
+更多信息请参阅 [Perplexity 的本地和远程 MCP](https://www.perplexity.ai/help-center/en/articles/11502712-local-and-remote-mcps-for-perplexity)。
+
+1. 导航 `Perplexity` > `设置`
+2. 选择 `连接器`。
+3. 点击 `添加连接器`。
+4. 选择 `高级`。
+5. 输入服务器名称:`Context7`
+6. 在文本区域粘贴以下 JSON:
+
+```json
+{
+ "args": ["-y", "@upstash/context7-mcp"],
+ "command": "npx",
+ "env": {}
+}
+```
+
+7. 点击 `保存`。
+
+
+## 🔨 可用工具
+
+Context7 MCP 提供以下 LLM 可以使用的工具:
+
+- `resolve-library-id`:将通用库名称解析为 Context7 兼容的库 ID。
+
+ - `libraryName`(必需):要搜索的库名称
+
+- `get-library-docs`:使用 Context7 兼容的库 ID 获取库的文档。
+ - `context7CompatibleLibraryID`(必需):精确的 Context7 兼容库 ID(例如,`/mongodb/docs`、`/vercel/next.js`)
+ - `topic`(可选):将文档重点放在特定主题上(例如,"routing"、"hooks")
+ - `tokens`(可选,默认 10000):返回的最大令牌数。小于默认值 10000 的值会自动增加到 10000。
+
+## 🛟 技巧
+
+### 添加规则
+
+> 如果你不想在每个提示中添加 `use context7`,你可以在 Windsurf 的 `.windsurfrules` 文件中或从 Cursor 的 `Cursor Settings > Rules` 部分(或你的 MCP 客户端中的等效位置)定义一个简单规则,以在任何代码问题上自动调用 Context7:
+>
+> ```toml
+> [[calls]]
+> match = "when the user requests code examples, setup or configuration steps, or library/API documentation"
+> tool = "context7"
+> ```
+>
+> 从那时起,你将在任何相关对话中获得 Context7 的文档,而无需键入任何额外内容。你可以将你的用例添加到匹配部分。
+
+### 使用库 ID
+
+> 如果你已经确切地知道要使用哪个库,请将其 Context7 ID 添加到你的提示中。这样,Context7 MCP 服务器可以跳过库匹配步骤,直接继续检索文档。
+>
+> ```txt
+> 使用 supabase 实现基本身份验证。使用库 /supabase/supabase 获取 API 和文档
+> ```
+>
+> 斜杠语法告诉 MCP 工具确切要为哪个库加载文档。
+
+## 💻 开发
克隆项目并安装依赖:
@@ -269,7 +978,27 @@ bun i
bun run build
```
-### 本地配置示例
+运行服务器:
+
+```bash
+bun run dist/index.js
+```
+
+### CLI 参数
+
+`context7-mcp` 接受以下 CLI 标志:
+
+- `--transport ` – 要使用的传输(默认为 `stdio`)。
+- `--port ` – 使用 `http` 或 `sse` 传输时监听的端口(默认 `3000`)。
+
+使用 http 传输和端口 8080 的示例:
+
+```bash
+bun run dist/index.js --transport http --port 8080
+```
+
+
+本地配置示例
```json
{
@@ -282,24 +1011,30 @@ bun run build
}
```
-### 使用MCP Inspector测试
+
+
+
+使用 MCP Inspector 测试
```bash
-npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp@latest
+npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp
```
-## 故障排除
+
-### ERR_MODULE_NOT_FOUND
+## 🚨 故障排除
-如果你看到这个错误,请尝试使用`bunx`而不是`npx`。
+
+模块未找到错误(ERR_MODULE_NOT_FOUND)
+
+如果你遇到 `ERR_MODULE_NOT_FOUND`,请尝试使用 `bunx` 而不是 `npx`:
```json
{
"mcpServers": {
"context7": {
"command": "bunx",
- "args": ["-y", "@upstash/context7-mcp@latest"]
+ "args": ["-y", "@upstash/context7-mcp"]
}
}
}
@@ -307,9 +1042,48 @@ npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp@latest
这通常可以解决模块解析问题,特别是在`npx`无法正确安装或解析包的环境中。
-### MCP客户端错误
+
-1. 尝试从包名中删除`@latest`。
+
+ESM 解析问题
+
+对于像 `Error: Cannot find module 'uriTemplate.js'` 这样的错误,请尝试 `--experimental-vm-modules` 标志:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "--node-options=--experimental-vm-modules", "@upstash/context7-mcp@1.0.6"]
+ }
+ }
+}
+```
+
+
+
+
+TLS/证书问题
+
+使用 `--experimental-fetch` 标志绕过 TLS 相关问题:
+
+```json
+{
+ "mcpServers": {
+ "context7": {
+ "command": "npx",
+ "args": ["-y", "--node-options=--experimental-fetch", "@upstash/context7-mcp"]
+ }
+ }
+}
+```
+
+
+
+
+通用 MCP 客户端错误
+
+1. 尝试在包名中添加 `@latest` 。
2. 尝试使用`bunx`作为替代方案。
@@ -317,19 +1091,35 @@ npx -y @modelcontextprotocol/inspector npx @upstash/context7-mcp@latest
4. 确保你使用的是Node v18或更高版本,以便使用`npx`时获得原生fetch支持。
-## Context7媒体报道
+
-- [Better Stack: "免费工具让Cursor变得更智能10倍"](https://youtu.be/52FC3qObp9E)
-- [Cole Medin: "这绝对是AI编码助手的最佳MCP服务器"](https://www.youtube.com/watch?v=G7gK8H6u7Rs)
-- [Income stream surfers: "Context7 + SequentialThinking MCPs: 这是AGI吗?"](https://www.youtube.com/watch?v=-ggvzyLpK6o)
-- [Julian Goldie SEO: "Context7: 新的MCP AI代理更新"](https://www.youtube.com/watch?v=CTZm6fBYisc)
-- [JeredBlu: "Context 7 MCP: 即时获取文档 + VS Code设置"](https://www.youtube.com/watch?v=-ls0D-rtET4)
-- [Income stream surfers: "Context7: 将改变AI编码的新MCP服务器"](https://www.youtube.com/watch?v=PS-2Azb-C3M)
+## ⚠️ 免责声明
-## Star历史
+Context7 项目由社区贡献,虽然我们努力保持高质量,但我们不能保证所有库文档的准确性、完整性或安全性。Context7 中列出的项目由其各自的所有者开发和维护,而不是由 Context7 开发和维护。如果你遇到任何可疑、不当或潜在有害的内容,请使用项目页面上的"举报"按钮立即通知我们。我们认真对待所有举报,并将及时审查标记的内容,以维护我们平台的完整性和安全性。通过使用 Context7,你承认你是自行判断和承担风险的。
-[](https://www.star-history.com/#upstash/context7&Date)
+## 🤝 与我们联系
-## 许可证
+保持更新并加入我们的社区:
-MIT
+- 📢 在 [X](https://x.com/context7ai) 上关注我们获取最新新闻和更新
+- 🌐 访问我们的[网站](https://context7.com)
+- 💬 加入我们的 [Discord 社区](https://upstash.com/discord)
+
+## 📺 Context7媒体报道
+
+- [Better Stack: "免费工具让 Cursor 智能 10 倍"](https://youtu.be/52FC3qObp9E)
+- [Cole Medin: "这绝对是 AI 编码助手的最佳 MCP 服务器"](https://www.youtube.com/watch?v=G7gK8H6u7Rs)
+- [Income Stream Surfers: "Context7 + SequentialThinking MCPs:这是 AGI 吗?"](https://www.youtube.com/watch?v=-ggvzyLpK6o)
+- [Julian Goldie SEO: "Context7:新的 MCP AI 代理更新"](https://www.youtube.com/watch?v=CTZm6fBYisc)
+- [JeredBlu: "Context 7 MCP:即时获取文档 + VS Code 设置"](https://www.youtube.com/watch?v=-ls0D-rtET4)
+- [Income Stream Surfers: "Context7:将改变 AI 编码的新 MCP 服务器"](https://www.youtube.com/watch?v=PS-2Azb-C3M)
+- [AICodeKing: "Context7 + Cline & RooCode:这个 MCP 服务器让 CLINE 效果提升 100 倍!"](https://www.youtube.com/watch?v=qZfENAPMnyo)
+- [Sean Kochel: "5 个让编码更爽的 MCP 服务器(即插即用)"](https://www.youtube.com/watch?v=LqTQi8qexJM)
+
+## ⭐ Star 历史
+
+[](https://www.star-history.com/#upstash/context7&Date)
+
+## 📄 许可证
+
+MIT
\ No newline at end of file