🚀 NPM包文档MCP
这是一个模型上下文协议（MCP）工具，可直接在你的集成开发环境（IDE）中为npm包提供最新的文档。该工具会从包的GitHub仓库或npm包自带的README文件中获取最新的文档内容。
🚀 快速开始
安装
前提条件
- 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 IDE以加载新的MCP服务器。
使用
安装完成后，你可以在Cursor中按以下步骤使用该工具：
- 打开命令面板（Cmd/Ctrl + Shift + P）
- 输入你的请求，例如：
- "获取express的文档"
- "显示最新的react文档"
- "lodash v4有什么新特性？"
该工具将获取并显示所请求包的最新文档。
✨ 主要特性
功能概述
这个MCP工具可帮助你的IDE（如Cursor）获取任何npm包的最新文档，避免依赖过时或不完整的信息。它的工作方式如下：
- 优先从GitHub仓库获取：如果包有GitHub仓库，它会直接从仓库的主分支（尝试
master、main或develop分支）获取README文件。 - 从npm包中提取：如果没有可用的GitHub仓库，它会下载包的tarball并从打包的包中提取README文件。
- 实时更新：始终获取最新的文档，确保你拥有最及时的信息。
重要意义
- 无需猜测：获取准确、最新的文档，而不是依赖可能过时的IDE建议。
- 提升开发体验：通过最新的文档了解包的API和使用模式。
- 减少错误：避免因使用过时的API引用或已弃用的方法而导致的问题。
- 无缝集成：通过MCP协议直接在你的IDE中工作。
💻 使用示例
基础用法
// 在你的IDE中，你现在可以像这样请求文档：
// "显示express的文档"
// "react-router-dom的最新API是什么？"
// "获取axios的文档"
📚 详细文档
提供的工具
get_docs_for_npm_package
- 描述：检索任何npm包的最新文档。
- 参数：
packageName（字符串）：npm包的名称（例如，"react"、"lodash"、"express"）。
- 返回值：以文本形式返回README内容，内容来自GitHub仓库或包的tarball。
工作原理
- 包查找：查询npm注册表以获取包的元数据。
- 仓库检测：检查包是否有GitHub仓库URL。
- 从GitHub获取：如果可用，从仓库的主分支获取README.md文件。
- 提取tarball：如果没有GitHub仓库，下载并提取包的tarball以找到README文件。
- 返回内容：将文档内容返回给你的IDE。
🔧 技术细节
开发模式运行
npm run dev
生产环境构建
npm run build
项目结构
npm-docs-mcp/
├── src/
│ ├── server.ts # 主要的MCP服务器实现
│ └── types/
│ └── index.ts # TypeScript类型定义
├── package.json
├── tsconfig.json
└── README.md
🤝 贡献
欢迎贡献代码！请随时提交拉取请求。
📄 许可证
本项目采用MIT许可证 - 详情请参阅LICENSE文件。
🛠️ 支持
如果你遇到任何问题或有疑问，请在GitHub仓库上提交问题。