Npm Package Docs MCP

🚀 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中按以下步驟使用該工具：

1. 打開命令面板（Cmd/Ctrl + Shift + P）
2. 輸入你的請求，例如：
   • "獲取express的文檔"
   • "顯示最新的react文檔"
   • "lodash v4有什麼新特性？"

該工具將獲取並顯示所請求包的最新文檔。

✨ 主要特性

功能概述

這個MCP工具可幫助你的IDE（如Cursor）獲取任何npm包的最新文檔，避免依賴過時或不完整的信息。它的工作方式如下：

1. 優先從GitHub倉庫獲取：如果包有GitHub倉庫，它會直接從倉庫的主分支（嘗試 master、main 或 develop 分支）獲取README文件。
2. 從npm包中提取：如果沒有可用的GitHub倉庫，它會下載包的tarball並從打包的包中提取README文件。
3. 即時更新：始終獲取最新的文檔，確保你擁有最及時的信息。

重要意義

• 無需猜測：獲取準確、最新的文檔，而不是依賴可能過時的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。

工作原理

1. 包查找：查詢npm註冊表以獲取包的元數據。
2. 倉庫檢測：檢查包是否有GitHub倉庫URL。
3. 從GitHub獲取：如果可用，從倉庫的主分支獲取README.md文件。
4. 提取tarball：如果沒有GitHub倉庫，下載並提取包的tarball以找到README文件。
5. 返回內容：將文檔內容返回給你的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倉庫上提交問題。