MCP Npm Docs Server

🚀 NPM 文檔 MCP 服務器文檔

本項目是一個 MCP 服務器，提供了用於獲取 NPM 包元數據和文檔（包含 README 內容）的工具。它藉助本地緩存機制，有效提升了性能。

🚀 快速開始

本服務器可幫助你高效獲取 NPM 包的元數據與文檔，以下是快速上手的步驟：

1. 克隆倉庫（若適用）。
2. 安裝依賴：

npm install

3. 構建服務器：

npm run build

4. 運行服務器：
   • 直接運行編譯後的服務器：

node dist/server.js

- 使用 dev 腳本進行開發：

npm run dev

✨ 主要特性

• 藉助 npms.io API 獲取包元數據和 README 內容。
• 採用 SQLite (better-sqlite3) 實現本地緩存。
• 提供 getNpmPackageDocs MCP 工具。
• 遵循標準 MCP 服務器結構。

📦 安裝指南

克隆倉庫

若需要，請克隆本項目倉庫。

安裝依賴

在項目根目錄下，執行以下命令安裝所需依賴：

npm install

構建服務器

運行以下命令構建服務器：

npm run build

📚 詳細文檔

項目結構

• /src：包含所有源代碼。
  • /config：配置管理（ConfigurationManager）。
  • /services：核心邏輯（NpmDocService，CacheService）。
  • /tools：MCP 工具定義（npmDocsTool.ts，npmDocsToolParams.ts）。
  • /types：TypeScript 接口和自定義錯誤（npmDocsTypes.ts）。
  • /utils：共享實用函數（logger.ts，errors.ts）。
  • createServer.ts：服務器實例創建和工具註冊。
  • server.ts：應用程序入口點。
• /dist：編譯後的 JavaScript 輸出（由npm run build生成）。包含默認緩存 DB 文件（npm-docs-cache.db）。
• package.json：項目元數據和依賴。
• tsconfig.json：TypeScript 編譯器選項。
• .eslintrc.json：ESLint 配置。
• .prettierrc.json：Prettier 配置。
• .gitignore：Git 忽略規則。

配置

• NPM_CACHE_TTL：設置緩存過期時間（默認為 86400 秒，即 24 小時）。
• NPM_CACHE_DB_PATH：設置緩存數據庫文件路徑（默認為./npm-cache.db）。
• LOG_LEVEL：設置日誌級別（從低到高：debug, info, warn, error, fatal，默認為 info）。

MCP 集成

將服務器配置到 MCP 客戶端中，示例配置如下：

{
  "server_name": "npm-docs-server",
  "tool_name": "getNpmPackageDocs",
  "arguments": {
    "packageName": "lodash",
    "forceFresh": false
  }
}

提供的工具：getNpmPackageDocs

參數

• packageName：需要獲取文檔的包名稱。
• forceFresh：是否強制重新獲取數據（默認為 false）。

返回值

包元數據和 README 內容（如果可用）。

代碼檢查

• Linting：npm run lint
• 格式化：npm run format

通過 Husky 和 lint-staged 進行自動代碼檢查和格式化。