Context7 MCP

Context7 为任何库提供智能文档搜索和上下文，由 LLM 驱动。

设置

1. 复制.env.example为.env并添加你的 Context7 API 密钥：

   cp .env.example .env

   将你的 API 密钥添加到.env文件中：

   CONTEXT7_API_KEY=your-api-key-here

   从context7.com/dashboard

2. 获取你的密钥

   npm install

安装依赖：

使用

Context7 提供两个主要命令：

搜索命令

npx tsx query.ts search <library_name> <query>

# Examples:
npx tsx query.ts search "nextjs" "setup ssr"
npx tsx query.ts search "react" "useEffect cleanup"
npx tsx query.ts search "better-auth" "authentication flow"

按名称搜索库，并采用由 LLM 驱动的智能排名：

GET https://context7.com/api/v2/libs/search?libraryName=<name>&query=<query>

这会调用 Context7 搜索 API：

• 响应包括：id: 库 ID（例如，/vercel/next.js
• ）
• trustScore: 来源可信度评分（0-100）
• benchmarkScore: 质量指标评分（0-100）
• versions: 可用的版本标签

上下文命令

检索经过智能LLM重新排序的文档上下文：

npx tsx query.ts context <owner/repo> <query>

# Examples:
npx tsx query.ts context "vercel/next.js" "setup ssr"
npx tsx query.ts context "facebook/react" "useState hook"

这调用的是Context7上下文API：

GET https://context7.com/api/v2/context?libraryId=<repo>&query=<query>&type=txt

响应内容包括：

• title: 文档章节标题
• content: 文档文本/片段
• source: 源页面URL

快速参考

# Search for documentation
npx tsx query.ts search "library-name" "your search query"

# Get context from a specific repo
npx tsx query.ts context "owner/repo" "your question"

最佳实践

通过以下最佳实践，充分利用Context7 API：

优化搜索相关性

当使用/libs/search端点时，务必在查询参数中包含用户的原始问题。这使得API能够利用LLM驱动的排序功能，为特定任务找到最相关的库，而不是依赖简单的名称匹配。

示例：如果用户询问有关Next.js中的SSR，请使用以下内容进行搜索：

• libraryName=nextjs
• query=setup+ssr

这确保了针对特定任务的最佳排名。

使用具体的库ID

为了通过/context端点获得最快和最准确的结果，请提供完整的 libraryId（例如，/vercel/next.js）。如果您已经知道用户询问的是哪个库，跳过搜索步骤并直接调用上下文端点可以减少延迟。

利用版本控制

为了确保较旧版本或特定项目需求的文档准确性，请使用/owner/repo/version格式在 libraryId 中包含版本号。您可以在搜索端点的响应中找到可用的版本标签。

选择正确的响应类型

使用type参数，根据您的需求定制/context响应：

• 使用type=json当您需要以编程方式处理标题、内容摘要和来源URL时（非常适合UI显示）。
• 使用type=txt当您希望将文档直接以纯文本形式输入到LLM提示中时。

按质量分数筛选

当以编程方式从搜索结果中选择一个库时，请使用trustScore和benchmarkScore来为用户优先选择高质量、信誉良好的文档来源。

查找导航页面

通过获取以下位置的llms.txt文件来查找此文档中的导航页面和其他页面：

https://context7.com/docs/llms.txt

API参考

Context7 REST API

搜索端点：

GET https://context7.com/api/v2/libs/search
  ?libraryName=<library_name>
  &query=<user_query>

上下文端点：

GET https://context7.com/api/v2/context
  ?libraryId=<owner/repo>
  &query=<user_query>
  &type=txt|json

故障排除

没有找到结果？

• 检查您的API密钥是否有效
• 确认库名称正确（例如应为'react'而非'React'）

遇到身份验证错误？

• 请确保已在.env文件中设置CONTEXT7_API_KEY
• 请前往context7.com/dashboard检查密钥是否过期

许可证

MIT许可证