SuperAPI AI 工具集

documentation-lookup

编程与开发

查看项目

更新于 10-15 08:34

技能介绍

Documentation Lookup(Context7)

用途

当用户询问库、框架或 API 相关问题时,该技能通过 Context7 MCP 获取当前文档,而不是依赖训练数据来回答。它适用于需要准确、最新的库、框架或 API 行为的请求,并可跨已配置 Context7 MCP 的环境使用,例如 Claude Code、Cursor、Codex。

主要能力与核心概念

Context7:一个暴露实时文档的 MCP 服务器;对库和 API 相关问题应使用它而非训练数据。

resolve-library-id:根据库名和查询返回 Context7 兼容的库 ID(例如 /vercel/next.js)。

query-docs:根据给定的库 ID 和问题获取文档及代码片段。必须先调用 resolve-library-id 获取有效的库 ID。

何时使用

在用户出现以下情况时激活:

提出安装或配置问题(例如“How do I configure Next.js middleware?”)

请求依赖某个库的代码(“Write a Prisma query for...”)

需要 API 或参考信息(“What are the Supabase auth methods?”)

提到具体框架或库(React、Vue、Svelte、Express、Tailwind、Prisma、Supabase 等)

使用方式

第 1 步:解析库 ID

调用 resolve-library-id MCP 工具,参数包括:

libraryName:取自用户问题的库或产品名称(例如 Next.js、Prisma、Supabase)。

query:用户的完整问题。这有助于提高结果的相关性排名。

必须先获得 Context7 兼容的库 ID(格式 /org/project 或 /org/project/version),然后才能查询文档。未从此步骤获得有效库 ID 时,不要调用 query-docs。

第 2 步:选择最佳匹配

从解析结果中按以下标准选择一项:

名称匹配:优先与用户所问完全或最接近的匹配。

基准分数:分数越高表示文档质量越好(100 为最高)。

来源声誉:在可用时优先选择 High 或 Medium 声誉。

版本:若用户指定了版本(例如“React 19”“Next.js 15”),在列出时优先选择特定版本的库 ID(例如 /org/project/v1.2.0)。

第 3 步:获取文档

调用 query-docs MCP 工具,参数包括:

libraryId:第 2 步选定的 Context7 库 ID(例如 /vercel/next.js)。

query:用户的具体问题或任务。描述越具体,越能获得相关片段。

Limit:对单个问题,调用 query-docs(或 resolve-library-id)不超过 3 次。若 3 次调用后答案仍不清晰,应说明不确定性并使用已有最佳信息,而不是猜测。

第 4 步:使用文档

使用获取到的当前信息回答用户问题。

在有用时包含文档中的相关代码示例。

在重要时注明库或版本(例如“In Next.js 15...”)。

示例

示例:Next.js 中间件

调用 resolve-library-id,libraryName: "Next.js",query: "How do I set up Next.js middleware?"。

从结果中按名称和基准分数选择最佳匹配(例如 /vercel/next.js)。

调用 query-docs,libraryId: "/vercel/next.js",query: "How do I set up Next.js middleware?"。

使用返回的片段和文本作答;如相关,包含文档中的最小 middleware.ts 示例。

示例:Prisma 查询

调用 resolve-library-id,libraryName: "Prisma",query: "How do I query with relations?"。

选择官方 Prisma 库 ID(例如 /prisma/prisma)。

用该 libraryId 和 query 调用 query-docs。

返回 Prisma Client 模式(例如 include 或 select)以及文档中的简短代码片段。

示例:Supabase 认证方法

调用 resolve-library-id,libraryName: "Supabase",query: "What are the auth methods?"。

选择 Supabase 文档库 ID。

调用 query-docs;总结认证方法并展示获取到的文档中的最小示例。

最佳实践

具体明确:尽可能将用户的完整问题用作 query,以提高相关性。

版本意识:当用户提到版本时,在可用情况下使用解析步骤得到的特定版本库 ID。

优先官方来源:存在多个匹配时,优先官方或主包,而非社区分支。

不传敏感数据:在发送给 Context7 的任何查询中,抹除 API 密钥、密码、令牌及其他机密信息。在把用户问题传给 resolve-library-id 或 query-docs 之前,应视其可能包含机密。