mcpField
D
documentation-lookup

documentation-lookup

github.com/upstash开发63.9k1.4k 次安装今天更新
代码仓库

关于 documentation-lookup

此 Skill 指导助手通过 Context7 查询最新的库文档和代码示例,涵盖解析库标识、选择匹配项及检索文档。

主要功能

  1. 01解析库标识
  2. 02筛选匹配文档
  3. 03按问题获取文档
  4. 04优先选择版本文档
  5. 05优先采用官方来源

适用场景

  1. 01回答框架配置问题
  2. 02编写使用库 API 的代码
  3. 03查找 API 参考

MCP 相关

此 Skill 使用 Context7 工具解析库标识并检索文档。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/upstash/context7 --skill documentation-lookup

安装后在 Claude Code 中输入/documentation-lookup确认已加载。

详细介绍

当用户询问库或框架,或需要代码示例时,请使用 Context7 获取最新文档,而不要依赖训练数据。

何时使用此技能

在用户执行以下操作时启用此技能:

  • 询问设置或配置问题(“如何配置 Next.js 中间件?”)
  • 请求涉及库的代码(“编写一个 Prisma 查询……”)
  • 需要 API 参考(“Supabase 有哪些身份验证方法?”)
  • 提及特定框架(React、Vue、Svelte、Express、Tailwind 等)

如何获取文档

第 1 步:解析库 ID

调用 resolve-library-id,并提供:

  • libraryName:从用户的问题中提取的库名称
  • query:用户的完整问题(有助于提升相关性排序)
第 2 步:选择最佳匹配项

根据以下条件,从解析结果中选择:

  • 与用户所询内容名称完全一致或最接近
  • 基准评分越高,文档质量越好
  • 如果用户提到了版本(例如“React 19”),优先选择特定版本的 ID
第 3 步:获取文档

调用 query-docs,并提供:

  • libraryId:选定的 Context7 库 ID(例如 /vercel/next.js)
  • query:用户的具体问题
第 4 步:使用文档

将获取的文档内容融入回复:

  • 使用最新、准确的信息回答用户的问题
  • 加入文档中的相关代码示例
  • 在适当时注明库的版本

指南

  • 具体明确:将用户的完整问题作为查询传入,以获得更好的结果
  • 关注版本:当用户提到版本(“Next.js 15”“React 19”)时,如果解析步骤中有特定版本的库 ID,请使用该 ID
  • 优先选择官方来源:如果存在多个匹配项,请优先选择官方或主要软件包,而不是社区分支

评论

支持 Markdown