Npm Package Docs

NPM Package Docs MCP

一个模型上下文协议（MCP）工具，可在 IDE 中直接提供 npm 包的最新文档。此工具会从包的 GitHub 仓库，或 npm 包本身附带的 README 中获取最新文档。

功能

此 MCP 工具可帮助你的 IDE（如 Cursor）获取任意 npm 包的最新文档，而非依赖过时或不完整的信息。它通过以下方式实现：

1. 优先使用 GitHub 仓库：如果包有 GitHub 仓库，它会直接从仓库的主分支获取 README（尝试 master、main 或 develop 分支）
2. 回退到 npm 包：如果没有可用的 GitHub 仓库，它会下载包压缩文件，并从包内提取 README 文件
3. 实时更新：始终获取最新文档，确保你掌握最新信息

为什么这很重要

• 不再靠猜测：获取准确、最新的文档，而非依赖可能过时的 IDE 建议
• 提升开发体验：借助最新文档了解包 API 和使用模式
• 减少错误：避免因使用过时的 API 参考或已弃用的方法而引发问题
• 无缝集成：通过 MCP 协议直接在 IDE 中使用

提供的工具

get_docs_for_npm_package

描述：获取任意 npm 包的最新文档

参数：

• packageName（字符串）：npm 包的名称（例如，“react”、“lodash”、“express”）

返回：README 内容文本，来源为 GitHub 仓库或包压缩文件

使用示例：

// In your IDE, you can now ask for documentation like:
// "Show me the docs for express"
// "What's the latest API for react-router-dom?"
// "Get documentation for axios"

工作原理

1. 查找包：查询 npm 注册表以获取包元数据
2. 检测仓库：检查包是否有 GitHub 仓库 URL
3. 获取 GitHub 内容：如果可用，从仓库的主分支获取 README.md
4. 提取压缩包：如果没有 GitHub 仓库，则下载并提取包压缩文件以查找 README
5. 返回内容：将文档内容返回到你的 IDE

安装

先决条件

• Node.js（v16 或更高版本）
• Cursor IDE（或任何兼容 MCP 的 IDE）

安装

添加到 Cursor

手动添加到 Cursor

编辑你的 Cursor MCP 配置文件（通常位于 ~/.cursor/mcp.json）：

{
  "mcpServers": {
    "npm-package-docs-mcp": {
      "command": "npx",
      "args": [
        "meanands/npm-package-docs-mcp"
      ]
    }
  }
}

5. 重启 Cursor：重启 Cursor IDE 以加载新的 MCP 服务

使用方法

安装后，你可以在 Cursor 中通过以下方式使用此工具：

1. 打开命令面板（Cmd/Ctrl + Shift + P）
2. 输入请求，例如：
   • “获取 express 的文档”
   • “显示最新的 react 文档”
   • “lodash v4 有什么新内容？”

此工具会获取并显示所请求包的当前文档。

开发

在开发模式下运行

npm run dev

为生产环境构建

npm run build

项目结构

npm-docs-mcp/
├── src/
│   ├── server.ts          # Main MCP server implementation
│   └── types/
│       └── index.ts       # TypeScript type definitions
├── package.json
├── tsconfig.json
└── README.md

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

MIT 许可证——详情请参阅 LICENSE 文件。

支持

如果你遇到任何问题或有疑问，请在 GitHub 仓库中提交 issue。