关于 context7
用于查询软件库当前文档的技能,面向需要核对 API 用法、版本变化或代码示例的开发者。它先搜索 Context7 文档库,再按具体查询获取相关片段,并要求设置 `CONTEXT7_API_KEY`。
主要功能
- 01搜索软件库并获取 ID
- 02按主题检索文档片段
- 03设置令牌预算控制返回量
- 04提供 API 与代码示例查询
适用场景
- 01核对库函数的当前用法
- 02确认新版 API 是否变更
- 03查找特定功能的代码示例
- 04查询安装与配置文档
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ trancong12102/ agentskills --skill context7安装后在 Claude Code 中输入/context7确认已加载。
附带文件scripts/context7.py
详细介绍
Context7
通过查询 Context7 API,检索软件库的最新文档。当你不确定某个 API 的当前接口时,这尤其有用——库文档会频繁变更,而你的训练数据可能已经过时。
需要 CONTEXT7_API_KEY 环境变量。
适用场景
- 查询库函数的工作方式(例如,“
useEffect的清理函数如何工作?”) - 检查 API 在较新版本中是否有变化
- 查找特定库功能的代码示例
- 验证正确的导入路径或函数签名
- 安装或配置库时需要查阅设置文档
不适用场景
- 一般编程问题(例如,“JS 中的闭包如何工作?”)
- 有关你自己的项目内部代码的问题
- 与特定开源库或框架无关的主题
工作流
不要读取脚本源代码。 直接运行脚本,并使用 --help 查看用法。
步骤 1:搜索库
python3 scripts/context7.py search <library> <topic>
返回包含前 5 个匹配项的 TSV:id、title、snippets。在获取步骤中使用最佳匹配行的 id。
步骤 2:获取文档
python3 scripts/context7.py fetch <library_id> <topic> [--max-tokens N]
获取与主题相关的文档片段,并将其截断至令牌预算(默认值:5000)。
选择 --max-tokens:
| 场景 | 令牌数 | 原因 |
|---|---|---|
| 快速查询(一个函数签名) | 2000 | 输出更聚焦,响应更快 |
| 常见用法(API 模式、示例) | 5000(默认值) | 兼顾深度与简洁性 |
| 广泛探索(迁移指南、完整 API 范围) | 8000–10000 | 主题涉及多个章节时需要 |
运行 python3 scripts/context7.py --help 查看完整用法。
示例
# Find React library ID, then fetch useState docs
python3 scripts/context7.py search react "useState hook"
python3 scripts/context7.py fetch /websites/react_dev "useState hook with objects"
# Smaller budget for a quick lookup
python3 scripts/context7.py fetch /vercel/next.js "middleware redirect" --max-tokens 2000
# Broader exploration
python3 scripts/context7.py fetch /langchain-ai/langchainjs "retrieval chain setup" --max-tokens 8000
规则
- 编写具体的查询——与
"hooks"相比,"useState hook with objects"能检索到与查询更相关的结果。 - 始终先搜索再获取——无法猜出库 ID(例如,
/websites/react_dev),因此需要先执行搜索步骤来找到正确的 ID。 - 根据任务选择
--max-tokens——使用上表。超出所需会浪费上下文窗口;不足则可能遗漏答案。
评论
支持 Markdown