Agent Skills
返回列表
💻

Context7 代码文档更新

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @org-rn88lg3j/code-doc-update。

技能介绍

解决的是文档漂移

大模型写代码时,常见问题不是语法错误,而是它仍按训练记忆调用某个库的 API;等到项目实际升级依赖后,生成的示例可能已经过期,甚至使用了被移除的函数。这个技能通过 Context7 MCP 获取与当前版本更接近的代码文档和示例,让 LLM 在回答库用法、API 参数、配置方式时优先依据检索到的文档,而不是仅凭训练语料猜测。

核心能力与工作方式

  • LLM 是路由层:负责理解用户意图、选择工具、提取参数;真正调用 API 的工作由脚本完成。
  • 先做库 ID 解析:用 scripts.tools.resolve_library_id 把包名或产品名映射为 Context7 兼容 ID,例如 /org/project 或 /org/project/version 这类格式。
  • 再取最新文档:用 scripts.tools.get_library_docs 按 ID 拉取文档。
  • 结果可追溯:工具返回 result['raw']、result['success']、result['message'],整理后把原始数据展示给用户。

关键步骤

  1. 检查 API 密钥;若 scripts.config.settings.api_key 为空,通过 AskUserQuestion 询问用户,然后用 scripts.config.set_api_key(api_key) 保存。
  2. 根据用户意图选择工具;如果用户没有显式给出 Context7 兼容 ID,先调用 resolve_library_id。
  3. 提取参数,参数不完整时继续向用户询问。
  4. 调用 get_library_docs,必要时指定 mode、topic、page 等参数。
  5. 将返回的 raw 数据整理展示,而不是用模型自行补全缺失字段。

适用边界与注意点

  • API 密钥是硬性前置条件。缺少密钥时禁止自行搜索或编造文档数据。
  • 如果用户已经明确提供了 /org/project 或 /org/project/version 形式的 ID,可以跳过 resolve_library_id;否则必须先解析。
  • mode='code' 适合 API 参考和代码示例;mode='info' 更适合概念解释、架构问题和指南类内容。
  • topic 可以用来聚焦 hooks、routing 等主题;上下文不足时可用 page=2、page=3 继续翻页。
  • 库匹配会参考名称相似度、文档覆盖、来源声誉和 Benchmark Score,但最终仍需要开发者确认命中的库确实是目标库。

使用场景

  • 前端升级依赖后,需要确认某个组件库当前版本的表单 API 用法和代码示例。
  • 后端准备接入新的数据库客户端,需要先解析库名并获取连接配置的官方说明。
  • 维护开源项目时,需要按主题拉取路由或 hooks 的最新文档,避免沿用旧写法。
  • 模型回答库用法时出现不确定参数,需要分页读取文档中的 API 参考进行核对。

适合人员

  • 升级依赖后需要核对 API 变化的后端工程师,希望用当前文档纠正模型生成的调用代码。
  • 维护组件库或SDK的开发者,需要在回答用法问题前先获取最新官方文档和示例。
  • 负责排查模型幻觉的技术作者,希望查看工具返回的原始文档数据并确认来源。
  • 正在接入 Context7 的开发者,需要理解库 ID 解析、文档获取和参数补全流程。