Npm Sentinel MCP

🚀 NPM 服務器端工具

本工具提供了一系列 NPM 相關的功能，涵蓋安裝配置、資源接口調用、工具集使用等，能幫助開發者更高效地管理和分析 NPM 包。

🚀 快速開始

你可以通過以下步驟快速開始使用 NPM 服務器端工具。

使用 NPX 進行安裝和運行

# 安裝插件
npm install -g @nekzus/mcp-server

# 運行服務器
npx @nekzus/mcp-server

配置文件示例

使用 Claude Desktop

將以下內容添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "npmAnalyzer": {
      "transport": "stdio",
      "command": "npx",
      "args": ["-y", "@nekzus/mcp-server"]
    }
  }
}

配置文件位置：

• Windows：%APPDATA%/claude-desktop/claude_desktop_config.json
• macOS：~/Library/Application Support/claude-desktop/claude_desktop_config.json
• Linux：~/.config/claude-desktop/claude_desktop_config.json

使用 NPX

{
  "mcpServers": {
    "npm-sentinel-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@nekzus/mcp-server"
      ]
    }
  }
}

✨ 主要特性

資源接口

• npm://registry：NPM 註冊表接口
• npm://security：安全分析接口
• npm://metrics：軟件包度量接口

工具集

npmVersions

• 功能：獲取包的所有版本
• 輸入：packages（字符串數組）
• 輸出：版本歷史及其發佈日期

npmLatest

• 功能：獲取最新版本信息
• 輸入：packages（字符串數組）
• 輸出：最新版本詳細信息和變更日誌

npmDeps

• 功能：分析包依賴
• 輸入：packages（字符串數組）
• 輸出：完整的依賴樹分析

npmTypes

• 功能：檢查 TypeScript 支持
• 輸入：packages（字符串數組）
• 輸出：TypeScript 兼容狀態

npmSize

• 功能：分析包大小
• 輸入：packages（字符串數組）
• 輸出：捆綁包大小和導入成本分析

npmVulnerabilities

• 功能：掃描安全漏洞
• 輸入：packages（字符串數組）
• 輸出：安全公告及嚴重性評級

npmTrends

• 功能：獲取下載趨勢
• 輸入：
  • packages（字符串數組）
  • period（"last-week" | "last-month" | "last-year"）
• 輸出：時間段內的下載統計信息

npmCompare

• 功能：比較多個包
• 輸入：packages（字符串數組）
• 輸出：詳細比較指標

npmMaintainers

• 功能：獲取包維護者
• 輸入：packages（字符串數組）
• 輸出：維護者信息及活動情況

npmScore

• 功能：獲取包質量分數
• 輸入：packages（字符串數組）
• 輸出：全面的質量度量指標

npmPackageReadme

• 功能：獲取包 README 文件
• 輸入：packages（字符串數組）
• 輸出：格式化後的 README 內容

npmSearch

• 功能：搜索包
• 輸入：
  • query（字符串）
  • limit（數字，可選）
• 輸出：匹配的包及其元數據

npmLicenseCompatibility

• 功能：檢查許可證兼容性
• 輸入：packages（字符串數組）
• 輸出：許可證分析及兼容信息

npmRepoStats

• 功能：獲取倉庫統計
• 輸入：packages（字符串數組）
• 輸出：GitHub/倉庫指標

npm

• 功能：獲取包維護者
• 輸入：packages（字符串數組）
• 輸出：維護者信息及活動情況

📦 安裝指南

使用 NPX

# 安裝插件
npm install -g @nekzus/mcp-server

# 運行服務器
npx @nekzus/mcp-server

📚 詳細文檔

編譯構建

項目結構

your-project/
├── src/
│   ├── components/
│   └── pages/
├── public/
└── package.json

構建腳本示例

{
  "scripts": {
    "build": "webpack --mode production",
    "dev": "webpack --mode development"
  }
}

開發規範

代碼風格指南

• 遵循項目組的 JavaScript 代碼規範。
• 確保代碼格式統一，使用最新版本的 ESLint 和 Prettier。

文檔編寫

• 使用 JSDoc 格式為所有公共 API 編寫文檔。
• 保持文檔與代碼同步更新，確保準確性。

版本控制

• 遵循語義化版本控制規範（SEMVER）。
• 在發佈新版本時，記錄變更日誌並推送到遠程倉庫。

項目貢獻

貢獻指南

1. Fork 該項目到您的賬戶。
2. 創建新的功能分支：git checkout -b feature/your-feature-name
3. 提交您的更改：git add . && git commit -m '描述您所做的更改'
4. 推送到您的倉庫：git push origin feature/your-feature-name
5. 創建 Pull Request 到原項目。

代碼審查

• 每個提交都需要經過至少一位維護者的代碼審查。
• 確保代碼符合項目的質量標準和安全規範。

社區支持

提問與反饋

• 在 GitHub 倉庫中提出問題：[鏈接到 Issues 頁面]
• 加入項目 Discord 社區：[Discord 邀請鏈接]

感謝貢獻者

感謝所有為這個項目做出貢獻的志願者和維護者，你們的努力使該項目更加優秀。

📄 許可證

MIT License

版權所有 (c) 年份 作者姓名。
根據 MIT 許可證分發。

MIT 許可證的副本見隨附文件 LICENSE，或者您也可以訪問 URL 獲取詳細信息。

Apache License 2.0

版權所有 (c) 年份 作者姓名。
根據 Apache 許可證 2.0 分發。

Apache 許可證 2.0 的副本見隨附文件 LICENSE，或者您也可以訪問 URL 獲取詳細信息。