AI导哈

npm包文档工具

一款为IDE提供最新npm包文档的工具，通过从GitHub仓库或npm包中提取README文档，确保开发者获取到最新的API和用法信息。

  • by meanands
  • TypeScript
  • 本地部署
  • 11 星标
  • 更新于
在 GitHub 查看 meanands/npm-package-docs-mcp

使用说明

NPM包文件MCP

一个模型上下文协议（MCP）工具，直接在IDE中为npm包提供最新文档。此工具从包的GitHub存储库或与npm包本身捆绑在一起的README中获取最新的README文档。

它做什么

此MCP工具可帮助您的IDE（如Cursor）获取任何npm包的最新文档，而不是依赖过时或不完整的信息。其工作原理如下：

  1. GitHub仓库优先：如果包有GitHub存储库，它将直接从存储库的主分支获取README（尝试 master, main，或 develop 分支机构）
  2. NPM包回退：如果没有可用的GitHub存储库，它会下载包tarball并从捆绑包中提取README文件
  3. 实时更新：始终获取最新文档，确保您拥有最新信息

为什么这很重要

  • 不再猜测：获取准确、最新的文档，而不是依赖可能过时的IDE建议
  • 更好的开发体验：通过当前文档了解包API和使用模式
  • 减少错误：避免使用过时的API引用或不推荐使用的方法引起的问题
  • 无缝集成：通过MCP协议直接在IDE中工作

提供的工具

get_docs_for_npm_package

描述：检索任何npm包的最新文档

参数:

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

退货：README内容为文本，来自GitHub存储库或tarball包

示例用法:

// 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仓库，请下载并提取包tarball以查找README
  5. 内容返回：将文档内容返回到IDE

安装

先决条件

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

安装

添加到光标

手动添加到光标

编辑Cursor MCP配置文件（通常位于 ~/.cursor/mcp.json):

{
  "mcpServers": {
    "npm-package-docs-mcp": {
      "command": "npx",
      "args": [
        "meanands/npm-package-docs-mcp"
      ]
    }
  }
}
  1. 重新启动游标：重新启动Cursor IDE以加载新的MCP服务器

用法

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

  1. 打开命令面板（Cmd/Ctrl+Shift+P）
  2. 键入您的请求，例如：
    • “获取快递文档”
    • “显示最新的响应文档”
    • “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

贡献

欢迎投稿！请随时提交拉取请求。

许可证

MIT许可证-有关详细信息，请参阅许可证文件。

支持

如果您遇到任何问题或有疑问，请在GitHub存储库上打开问题。

相关 MCP