关于 context7
context7 是通过 Context7 API 获取软件库和组件最新文档的技能,适用于需要查阅特定主题资料的开发者和编码 Agent,避免依赖可能过时的模型知识。
主要功能
- 01搜索库标识符
- 02获取主题相关文档
- 03以文本或 JSON 返回文档
- 04使用 curl 和 jq 调用 API
适用场景
- 01查询当前 React hooks 文档
- 02查找 Next.js 路由说明
- 03获取 FastAPI 依赖注入资料
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ intellectronica/ agent-skills --skill context7安装后在 Claude Code 中输入/context7确认已加载。
详细介绍
Context7
概述
此技能通过 curl 查询 Context7 API,检索软件库和组件的最新文档。请使用此技能,而不要依赖可能已过时的训练数据。
工作流
步骤 1:搜索库
要查找 Context7 库 ID,请查询搜索端点:
curl -s "https://context7.com/api/v2/libs/search?libraryName=LIBRARY_NAME&query=TOPIC" | jq '.results[0]'
参数:
libraryName(必需):要搜索的库名称(例如,“react”“nextjs”“fastapi”“axios”)query(必需):用于相关性排序的主题描述
响应字段:
id:上下文端点的库标识符(例如,/websites/react_dev_reference)title:易于理解的库名称description:库的简要说明totalSnippets:可用文档片段的数量
步骤 2:获取文档
要检索文档,请使用步骤 1 中的库 ID:
curl -s "https://context7.com/api/v2/context?libraryId=LIBRARY_ID&query=TOPIC&type=txt"
参数:
libraryId(必需):搜索结果中的库 IDquery(必需):要检索文档的具体主题type(可选):响应格式——json(默认)或txt(纯文本,更易阅读)
示例
React hooks 文档
# Find React library ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=react&query=hooks" | jq '.results[0].id'
# Returns: "/websites/react_dev_reference"
# Fetch useState documentation
curl -s "https://context7.com/api/v2/context?libraryId=/websites/react_dev_reference&query=useState&type=txt"
Next.js 路由文档
# Find Next.js library ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=nextjs&query=routing" | jq '.results[0].id'
# Fetch app router documentation
curl -s "https://context7.com/api/v2/context?libraryId=/vercel/next.js&query=app+router&type=txt"
FastAPI 依赖注入
# Find FastAPI library ID
curl -s "https://context7.com/api/v2/libs/search?libraryName=fastapi&query=dependencies" | jq '.results[0].id'
# Fetch dependency injection documentation
curl -s "https://context7.com/api/v2/context?libraryId=/fastapi/fastapi&query=dependency+injection&type=txt"
提示
- 使用
type=txt可获得更易阅读的输出 - 使用
jq筛选并格式化 JSON 响应 - 在
query参数中提供具体内容,以提升相关性排序效果 - 如果第一个搜索结果不正确,请检查数组中的其他结果
- 对包含空格的查询参数进行 URL 编码(使用
+或%20) - 基本用法无需 API 密钥(但有速率限制)
评论
支持 Markdown