Context7 文档查询技能用于直接从来源检索任意编程库的当前文档和代码示例。
用途
当需要查找库 API、文档、特定库版本,或想了解“如何使用……”某功能时,可使用本技能获取最新的库文档与代码示例。
主要能力
- 获取指定库的文档与代码示例。
- 支持指定具体版本,例如 /vercel/next.js/v15.1.8。
- 支持搜索库 ID,用于不确定库 ID 的情况。
- 支持文本(默认)与 JSON 两种输出格式。
使用方式
使用位于 scripts/context7.py 的 Python 脚本。
获取文档:
文本格式(默认)
python scripts/context7.py docs
--library-id /facebook/react --query "useEffect cleanup function"
指定版本
python scripts/context7.py docs
--library-id /vercel/next.js/v15.1.8 --query "app router middleware"
搜索库:
仅在库 ID 未知时使用搜索:
python scripts/context7.py search
--library react --query "hooks"
查询建议
使用详细、自然语言的查询可获得更好结果。
推荐示例:"How to implement authentication with middleware"
不推荐示例:"auth"
常见库 ID
- React:/facebook/react
- Next.js:/vercel/next.js
- TailwindCSS:/tailwindlabs/tailwindcss
- Expo:/expo/expo
- ORPC:middleapi/orpc
规则
- 已知库 ID 时直接查询文档。
- 仅在不确定库 ID 时使用搜索。
- 使用具体版本 ID 以获得一致结果(例如 /vercel/next.js/v15.1.8)。
- 使用 --format json 获取结构化输出。
适用场景
适用于开发过程中查询库 API 用法、查阅特定版本文档、获取代码示例,以及需要结构化文档输出供后续处理的场景。
限制
资料未提供关于收费、价格、平台支持范围、性能效果或额外使用步骤的说明,这些内容暂未提供。