drjaniuk 学习知识库

Appearance

使用指南 ​

有效使用 Context7 的实用技巧。

快速取胜 ​

自动调用 Context7 ​

通过设置自动规则，停止在每个提示中添加 use context7。

向您的 MCP 客户端添加规则 ​

使用特定库 ID ​

通过指定确切的库 ID 跳过搜索步骤并立即获取文档。

如何查找库 ID ​

  1. 访问 context7.com
  2. 搜索您的库
  3. ID 显示为 /owner/repository 格式

在您的提示中使用 ​

txt
Implement JWT auth with Supabase. use library /supabase/supabase
txt
Build a rate limiter. use library /upstash/ratelimit
txt
Set up Next.js middleware. use library /vercel/next.js/v15.1.0

优势 ​

  • 更快：无需库解析
  • 精确：获取确切库和版本的文档
  • 可靠：关于使用哪个库没有歧义

配置 HTTPS 代理 ​

如果您在企业代理后面，请配置 Context7 以通过它进行路由。

设置环境变量 ​

或在 MCP 设置中配置 ​

将代理直接添加到您的 MCP 配置中：

json
{
  "mcpServers": {
    "context7": {
      "command": "npx",
      "args": ["-y", "@upstash/context7-mcp", "--api-key", "YOUR_API_KEY"],
      "env": {
        "https_proxy": "http://proxy.example.com:8080",
        "HTTPS_PROXY": "http://proxy.example.com:8080"
      }
    }
  }
}

支持小写和大写环境变量。

使用私有仓库 ​

添加您的私有 GitHub、GitLab 或 Bitbucket 仓库，使内部文档可通过 Context7 访问。需要专业版或企业版计划。

有关添加、刷新和管理私有仓库的完整说明，请参阅 私有仓库 指南。

成本：解析时每 100万 tokens $15。详情请见 计划与定价。

设置团队协作 ​

与您的团队共享 Context7 访问权限。创建团队，邀请具有不同角色（所有者、管理员、开发者）的成员，并从您的仪表板管理权限。

有关创建团队、邀请成员和管理角色的完整说明，请参阅 团队管理 指南。

成本：专业版计划每位团队成员每月 $7。详情请见 计划与定价。

刷新库文档 ​

保持您的文档最新。

Web 界面 ​

  1. 前往 context7.com/refresh-library
  2. 输入库 ID (例如 /vercel/next.js)
  3. 提交

API ​

bash
POST https://context7.com/api/v1/refresh
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
  "docsRepoUrl": "https://github.com/vercel/next.js"
}

何时刷新 ​

  • 在主要版本发布后
  • 当文档更新时
  • 当您注意到过时信息时

监控使用情况 ​

从仪表板跟踪您的 API 使用情况、解析 tokens 和成本。查看搜索请求、查询 tokens、解析 tokens 和包含详细明细的每月总成本的指标。

有关使用统计和成本计算的完整详情，请参阅 使用统计 指南。

最佳实践 ​

安全性 ​

  • 永远不要将 API 密钥提交到版本控制。使用 .env 文件并将它们添加到 .gitignore。
  • 使用环境变量存储密钥，如：export CONTEXT7_API_KEY=your_key_here。
  • 定期轮换密钥 —— 每 90 天或在泄露时立即轮换。
  • 仅授予团队成员所需的权限。为非管理员使用 "开发者" 角色。

请参阅 安全性 以获取全面的安全指南。

性能 ​

  • 尽可能使用特定库 ID 如 /vercel/next.js 而不是通用短语如 "next.js docs"。
  • 使用主题过滤聚焦结果。尝试添加特定主题如 "authentication" 或 "routing"。
  • 当您需要更多上下文时使用分页 —— API 每个主题最多支持 10 页。检查响应中的 hasNext 字段以了解何时有更多页面可用。
  • 在本地缓存经常使用的文档 6-24 小时以减少 API 调用。

库管理 ​

  • 保持仓库中的 context7.json 文件最新。添加新文档或更改结构时更新它。
  • 排除不必要的文件夹，例如测试和构建工件：excludeFolders: ["test", "dist", "node_modules"]。
  • 为 AI 代理添加有用的规则，例如 "Always validate user input" 或 "Use TypeScript strict mode"。
  • 维护重要版本的版本标签。例如，即使在发布 v2.x 后也保留 v1.x 文档。

有关配置详情，请参阅 库所有者。

需要帮助？ ​

要查找此文档中的导航和其他页面，请获取 llms.txt 文件：https://context7.com/docs/llms.txt