用途:npm-package-docs-mcp 是一个 Model Context Protocol(MCP)工具,旨在让 IDE(例如 Cursor)直接获取 npm 包的最新文档。它解决的是 IDE 中包文档可能过时或不完整的问题,帮助开发者依据最新 README 理解包的 API 与用法。
主要能力:
- GitHub 仓库优先:如果包有 GitHub 仓库,工具会直接从仓库主分支获取 README,会尝试 master、main 或 develop 分支。
- npm 包回退:如果包没有可用的 GitHub 仓库,工具会下载该包的 tarball 并从中提取 README 文件。
- 实时更新:始终获取最新文档,确保信息为当前版本。
- 提供工具函数 get_docs_for_npm_package:接收 packageName(字符串,如 "react"、"lodash"、"express"),返回 README 内容文本。
- 工作流程:查询 npm registry 获取包元数据 → 检测是否存在 GitHub 仓库 URL → 若有则从主分支获取 README.md → 若无则下载并解压 tarball 查找 README → 将文档内容返回给 IDE。
使用方式:
- 环境要求:Node.js(v16 或更高版本),以及 Cursor IDE 或其他支持 MCP 的 IDE。
- 配置:编辑 Cursor MCP 配置文件(通常位于 ~/.cursor/mcp.json),然后重启 Cursor IDE 以加载新的 MCP 服务器。
- 调用:在 Cursor 中打开命令面板(Cmd/Ctrl + Shift + P),输入请求,例如 "Get docs for express"、"Show me the latest react documentation"、"What's new in lodash v4?",工具会获取并展示对应包的当前文档。
适用场景:
- 开发者在 IDE 内查询 npm 包的最新 README 文档,避免依赖过时或不完整的 IDE 提示。
- 需要准确了解包 API 与使用模式、减少因过时 API 引用或废弃方法导致的错误。
- 希望在不离开 IDE 的情况下通过 MCP 协议无缝集成文档查询。
限制:
- 需要 Node.js v16 或更高版本,以及 Cursor IDE 或任何兼容 MCP 的 IDE。
- 文档来源依赖于包的 GitHub 仓库主分支或 npm 包内自带的 README,若两者均不可用则无法获取。
- 官方资料未提供定价、许可证以外的收费信息;许可证为 MIT,详见 LICENSE 文件。
- 官方资料未提供其他平台支持、性能数据或使用效果的具体说明。
项目还包含开发模式运行、生产构建、项目结构等说明,并欢迎通过 Pull Request 贡献。如遇问题,可在 GitHub 仓库提交 issue。