文档查询 (Context7) 是做什么的?
当用户询问库、框架或 API 时,应通过 Context7 MCP(工具 resolve-library-id 和 query-docs)获取当前文档,而非依赖训练数据。
核心概念
- Context7: 一个暴露实时文档的 MCP 服务器;在涉及库和 API 时应使用它而非训练数据。
- resolve-library-id: 根据库名称和查询返回 Context7 兼容的库 ID(例如
/vercel/next.js)。 - query-docs: 根据给定的库 ID 和问题获取文档和代码片段。始终先调用 resolve-library-id 以获取有效的库 ID。
何时使用
当用户出现以下情况时激活:
- 询问安装或配置问题(例如“如何配置 Next.js 中间件?”)
- 请求依赖某个库的代码(“写一个 Prisma 查询来...”)
- 需要 API 或参考信息(“Supabase 的认证方法有哪些?”)
- 提到特定框架或库(React、Vue、Svelte、Express、Tailwind、Prisma、Supabase 等)
只要请求依赖于库、框架或 API 的准确、最新行为,就应使用此技能。适用于已配置 Context7 MCP 的各类平台(例如 Claude Code、Cursor、Codex)。
工作原理
第 1 步:解析库 ID
调用 resolve-library-id MCP 工具,参数如下:
- libraryName: 从用户问题中提取的库或产品名称(例如
Next.js、Prisma、Supabase)。 - query: 用户的完整问题。这有助于提高结果的相关性排名。
在查询文档之前,必须获取一个 Context7 兼容的库 ID(格式为 /org/project 或 /org/project/version)。没有此步骤得到的有效库 ID,请勿调用 query-docs。
第 2 步:选择最佳匹配
从解析结果中,根据以下条件选择一个结果:
- 名称匹配: 优先选择与用户需求精确或最接近的匹配。
- 基准分数: 分数越高表示文档质量越好(100 为最高)。
- 来源信誉: 尽可能优先选择高或中等信誉的来源。
- 版本: 如果用户指定了版本(例如“React 19”、“Next.js 15”),则优先选择列出的版本特定库 ID(例如
/org/project/v1.2.0)。
第 3 步:获取文档
调用 query-docs MCP 工具,参数如下:
- libraryId: 从第 2 步选择的 Context7 库 ID(例如
/vercel/next.js)。 - query: 用户的特定问题或任务。请具体描述,以获取相关的代码片段。
限制:每次提问时,调用 query-docs(或 resolve-library-id)的次数不得超过 3 次。如果在 3 次调用后答案仍不明确,请说明不确定性,并使用您掌握的最佳信息,而非猜测。
第 4 步:使用文档
- 使用获取到的当前信息回答用户的问题。
- 在有用时包含文档中的相关代码示例。
- 在必要时注明库或版本(例如“在 Next.js 15 中...”)。
示例
示例:Next.js 中间件
- 调用 resolve-library-id,参数为
libraryName: "Next.js",query: "如何设置 Next.js 中间件?"。 - 根据名称和基准分数从结果中选择最佳匹配(例如
/vercel/next.js)。 - 调用 query-docs,参数为
libraryId: "/vercel/next.js",query: "如何设置 Next.js 中间件?"。 - 使用返回的片段和文本进行回答;如果相关,包含一个来自文档的最小化
middleware.ts示例。
示例:Prisma 查询
- 调用 resolve-library-id,参数为
libraryName: "Prisma",query: "如何进行关联查询?"。 - 选择官方的 Prisma 库 ID(例如
/prisma/prisma)。 - 使用该
libraryId和查询调用 query-docs。 - 返回 Prisma Client 模式(例如
include或select),并附上来自文档的简短代码片段。
示例:Supabase 认证方法
- 调用 resolve-library-id,参数为
libraryName: "Supabase",query: "认证方法有哪些?"。 - 选择 Supabase 文档库 ID。
- 调用 query-docs;总结认证方法,并从获取的文档中展示最小示例。
最佳实践
- 具体明确: 尽可能使用用户的完整问题作为查询,以获得更好的相关性。
- 版本感知: 当用户提及版本时,如果解析步骤中有版本特定的库 ID,请优先使用它们。
- 优先官方来源: 当存在多个匹配时,优先选择官方或主包而非社区分支。
- 无敏感数据: 从发送给 Context7 的任何查询中移除 API 密钥、密码、令牌和其他秘密。在将用户问题传递至 resolve-library-id 或 query-docs 之前,应将其视为可能包含机密信息。