npm包文档mcp

Name: npm包文档mcp
Author: meanands

作者：meanands8 星标更新：2025-08-16

安装使用来源：spider==github.com

项目介绍

NPM 包文档 MCP

这是一个提供最新npm包文档的Model Context Protocol (MCP)工具，可以直接在您的IDE中获取。此工具从包的GitHub仓库或npm包自带的README中获取最新的文档。

功能概述

这个MCP工具帮助您的IDE（如Cursor）获取任何npm包的最新文档，而不是依赖过时或不完整的资料。其工作方式如下：

优先从GitHub仓库获取：如果包有GitHub仓库，它会从仓库的主要分支（尝试master、main或develop分支）直接获取README。
从npm包中获取作为备选：如果没有GitHub仓库，它会下载包的tarball并从中提取README文件。
实时更新：始终获取最新的文档，确保您拥有最及时的信息。

为什么这很重要

不再猜测：获得准确、最新的文档，而不是依赖可能过时的IDE建议。
更好的开发体验：通过当前文档理解包的API和使用模式。
减少错误：避免因使用过时的API参考或已弃用的方法而产生的问题。
无缝集成：通过MCP协议直接在您的IDE中工作。

提供的工具

`get_docs_for_npm_package`

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

参数：

packageName (字符串)：npm包的名称（例如："react"，"lodash"，"express"）

返回值：从GitHub仓库或包tarball中获取的README内容

示例用法：

// 在您的IDE中，现在可以请求文档，例如：
// "显示express的文档"
// "react-router-dom的最新API是什么？"
// "获取axios的文档"

工作原理

包查询：查询npm注册表以获取包元数据。
仓库检测：检查包是否有GitHub仓库URL。
GitHub获取：如果有可用的GitHub仓库，从主要分支获取README.md。
tarball提取：如果没有GitHub仓库，则下载并解压包的tarball以找到README。
内容返回：将文档内容返回给您的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"
      ]
    }
  }
}

重启Cursor：重启Cursor IDE以加载新的MCP服务器。

使用方法

一旦安装完成，您可以在Cursor中通过以下步骤使用该工具：

打开命令面板（Cmd/Ctrl + Shift + P）
输入您的请求，例如：
- "获取express的文档"
- "展示最新的react文档"
- "lodash v4有什么新特性？"

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

开发

在开发模式下运行

npm run dev

构建用于生产

npm run build

项目结构

npm-docs-mcp/
├── src/
│   ├── server.ts          # 主要的MCP服务器实现
│   └── types/
│       └── index.ts       # TypeScript类型定义
├── package.json
├── tsconfig.json
└── README.md

贡献

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

许可证

MIT许可证 - 查看LICENSE文件了解详情。

支持

如果您遇到任何问题或有任何疑问，请在GitHub仓库上打开一个issue。 </中文翻译>