使用说明

项目简介

Context7 MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务，它利用 Context7 平台的海量文档资源，为 LLM 客户端（如 Cursor, Windsurf, Claude Desktop 等）提供便捷的软件包和库文档访问能力。用户可以通过自然语言提问，快速检索和获取所需的文档信息，提升开发效率。

主要功能点

列出可用软件包 (list-available-packages): 允许用户查询 Context7 上所有可用的文档软件包列表，方便用户了解当前支持的文档范围。
获取软件包文档 (get-package-documentation): 根据指定的软件包名称和可选的主题，从 Context7 获取相关的文档内容。用户可以指定最大返回的 token 数量，以控制文档的详细程度和上下文窗口的使用。

安装步骤

该 MCP 服务器可以通过 'npm' 直接运行，无需复杂的安装步骤。

确保已安装 Node.js: 需要 Node.js v18.0.0 或更高版本。
使用 npx 运行: 在支持 MCP 客户端的环境中（如 Cursor, Windsurf），可以直接使用 'npx' 命令运行该 MCP 服务器。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令才能连接并使用 Context7 文档服务。以下是在 Cursor 和 Windsurf 中配置 Context7 MCP 服务器的示例。

Cursor 配置:

在 Cursor 的 MCP 服务器列表中，添加以下命令即可：

npx -y @upstash/context7-mcp

Windsurf 配置:

在 Windsurf 的 MCP 配置文件中，添加以下 JSON 配置：

{
  "server name": "context7",
  "command": "npx",
  "args": [
    "-y",
    "@upstash/context7-mcp"
  ]
}

'server name': 为该 MCP 服务器指定一个名称，例如 "context7"，用于在 Windsurf 中标识和管理。
'command': 指定启动 MCP 服务器的命令，这里使用 'npx' 来运行 npm 包。
'args': 命令参数，'-y' 表示自动确认安装，'@upstash/context7-mcp' 是要运行的 npm 包名称，即 Context7 MCP 服务器。

基本使用方法

启动 MCP 服务器: 根据 MCP 客户端的要求配置并启动 Context7 MCP 服务器。

在 MCP 客户端中使用工具:

'list-available-packages' 工具: 调用此工具可以获取 Context7 上所有可用的软件包名称列表。您可以将此列表作为参考，用于 'get-package-documentation' 工具的 'packageName' 参数。
'get-package-documentation' 工具: 调用此工具并提供 'packageName' 参数（软件包名称，务必与 'list-available-packages' 返回的名称一致），即可获取指定软件包的文档。您还可以选择性地提供 'topic' 参数（文档主题）以缩小文档范围，以及 'tokens' 参数（最大 token 数量）以控制返回的文档长度。

例如，在支持 MCP 的编辑器或客户端中，您可以这样提问：

@context7/list-available-packages  // 获取可用软件包列表
@context7/get-package-documentation packageName:react topic:hooks // 获取 React hooks 的文档
@context7/get-package-documentation packageName:nextjs topic:authentication tokens:3000 // 获取 Next.js 认证相关的文档，限制 token 数量为 3000

注意: 'packageName' 参数必须与 'list-available-packages' 工具返回的软件包名称完全一致。

关键词