Context7 是一个文档检索技能,用于获取软件库、框架和组件的当前文档。当训练数据可能已过时,需要查询最新资料时较为适用。
用途
该技能面向“查找编程相关文档”的场景,通过查询 Context7 API 来获取软件库与组件的最新文档。资料指出,在训练数据可能过时的情况下,应优先使用它。
主要能力
- 搜索库:给定库名称与主题,返回候选库及其标识信息。
- 获取文档:给定库 ID 与具体主题,返回该主题的文档内容。
- 输出格式:context 接口的 type 参数可选 json(默认)或 txt(纯文本,更易读),资料建议优先使用 type=txt。
使用方式
技能通过 curl 调用 Context7 API,需要在请求头中携带授权令牌。命令使用 $CONTEXT7_API_KEY 环境变量:
第一步,搜索库,获取 Context7 库 ID: curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/libs/search?libraryName=LIBRARY_NAME&query=TOPIC" | jq '.results[0]'
参数说明:
- libraryName(必填):要搜索的库名称,例如 "react"、"nextjs"、"fastapi"、"axios"。
- query(必填):用于相关度排序的主题描述。
搜索响应字段:
- id:context 接口使用的库标识,例如 /websites/react_dev_reference。
- title:人类可读的库名称。
- description:库的简要描述。
- totalSnippets:可用的文档片段数量。
第二步,获取文档,使用第一步得到的库 ID: curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/context?libraryId=LIBRARY_ID&query=TOPIC&type=txt"
参数说明:
- libraryId(必填):来自搜索结果的库 ID。
- query(必填):要检索文档的具体主题。
- type(可选):响应格式,json(默认)或 txt(纯文本,更易读)。
示例
React hooks 文档:
查找 React 库 ID
curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/libs/search?libraryName=react&query=hooks" | jq '.results[0].id'
返回:"/websites/react_dev_reference"
获取 useState 文档
curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/context?libraryId=/websites/react_dev_reference&query=useState&type=txt"
Next.js 路由文档:
查找 Next.js 库 ID
curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/libs/search?libraryName=nextjs&query=routing" | jq '.results[0].id'
获取 app router 文档
curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/context?libraryId=/vercel/next.js&query=app+router&type=txt"
FastAPI 依赖注入:
查找 FastAPI 库 ID
curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/libs/search?libraryName=fastapi&query=dependencies" | jq '.results[0].id'
获取依赖注入文档
curl -s -H "Authorization: Bearer $CONTEXT7_API_KEY" "https://context7.com/api/v2/context?libraryId=/fastapi/fastapi&query=dependency+injection&type=txt"
技巧
- 优先使用 type=txt 以获得更易读的输出。
- 使用 jq 过滤和格式化 JSON 响应。
- query 参数尽量具体,以提高相关度排序。
- 如果第一条搜索结果不正确,检查结果数组中的其他条目。
- 对包含空格的查询参数进行 URL 编码(使用 + 或 %20)。
适用场景与限制
适用场景:需要查询软件库、框架或组件的最新编程文档,尤其在训练数据可能过时时。
限制:资料未提供关于收费、价格、配额、平台支持范围、认证方式细节或响应速率限制等信息。使用需要 CONTEXT7_API_KEY 环境变量;相关接口地址与参数以上文资料为准。