项目简介

NPM Helper MCP 是一个实现了 Model Context Protocol (MCP) 的服务器，专门用于帮助 AI 助手或大型语言模型（LLMs）管理和搜索 Node.js 项目的 NPM 依赖包。它提供了一系列工具，可以直接从 LLM 客户端调用，执行如检查更新、升级包、搜索包等操作。

主要功能点

• 依赖更新管理: 利用 'npm-check-updates' 工具，可以检查项目中的过时依赖，安全地升级依赖到最新兼容版本，或根据策略（如 minor, patch）进行升级，并支持解决冲突和运行测试检查破坏性更改。
• NPM 包搜索与信息获取: 允许搜索 npmjs.org 上的包，获取包的详细信息、版本列表，甚至抓取包页面的内容。
• 标准化接口: 通过 MCP 标准协议（基于 JSON-RPC）提供服务，确保与兼容 MCP 的 LLM 客户端无缝集成。

安装步骤

有几种方式可以安装并运行 NPM Helper MCP 服务器：

1. 方法 1: 使用 npx (无需本地安装): 这是最简单的方法。您的 MCP 客户端可以直接配置命令来按需运行服务器。

   • 所需的启动命令是 'npx'。
   • 所需的命令参数是 '-y' 和 '@pinkpixel/npm-helper-mcp'。

2. 方法 2: 本地全局安装: 如果您希望在本地系统上安装服务器。

   • 在终端运行命令 'npm install -g npm-helper-mcp'。
   • 安装后，所需的启动命令是 'npm-helper-mcp'。
   • 通常不需要额外的命令参数。

3. 方法 3: 从源代码安装: 如果您想从 GitHub 仓库构建和运行。

   • 克隆仓库: 'git clone https://github.com/pinkpixel-dev/npm-helper-mcp.git'
   • 进入目录: 'cd npm-helper-mcp'
   • 安装依赖: 'npm install'
   • 构建项目: 'npm run build'
   • 构建后，所需的启动命令是 'node'。
   • 所需的命令参数是您本地仓库构建后的主文件路径，例如 '/path/to/your/cloned/repo/dist/index.js'。请将路径替换为您的实际路径。

服务器配置

MCP 服务器的配置需要在您的 MCP 客户端应用程序中完成。您需要告诉客户端如何启动这个服务器。根据您的安装方式，主要需要提供服务器的启动命令和对应的参数：

• 服务器名称 (Server Name): 您可以在 MCP 客户端中为这个服务器指定一个易于识别的名称，例如 'npm-helper'。
• 启动命令 (Command): 这是客户端用来执行服务器程序的命令。根据您选择的安装步骤，填写对应的命令 ('npx', 'npm-helper-mcp', 或 'node')。
• 命令参数 (Args): 这是传递给启动命令的参数列表。根据您选择的安装步骤，填写对应的参数列表（例如对于 npx 是 '-y, @pinkpixel/npm-helper-mcp'；对于从源代码是 '您的实际路径/dist/index.js'；本地全局安装通常无额外参数）。

您的 MCP 客户端配置界面或文件应该有相应的字段来填写这些信息，以便客户端能够正确启动并连接到这个 NPM 助手服务器。

基本使用方法

服务器启动并由 MCP 客户端连接后，AI 助手就可以通过调用服务器提供的工具来执行 NPM 操作了。例如，AI 助手可能会调用 'check_updates' 工具来检查 package.json 中的过时依赖，或者调用 'search_npm' 工具来查找新的包。具体的工具调用方式由 AI 助手或 MCP 客户端决定，通常涉及发送一个包含工具名称和参数的 JSON-RPC 请求。您可以参考仓库 README 中“Available Tools”部分了解每个工具的名称和参数。