使用说明

项目简介

本项目是一个实现了 Model Context Protocol (MCP) 的服务器,专注于提供 NPM 包信息的查询功能。它通过标准化的 MCP 协议与客户端通信,允许LLM应用通过调用工具获取最新的NPM包数据,从而增强LLM在软件开发领域的上下文理解和应用能力。

主要功能点

  • 提供 'getNpmPackageInfo' 工具: 允许客户端查询指定 NPM 包的详细信息。
  • 基于 STDIO 传输: 使用标准输入输出流进行通信,方便集成到各种支持 MCP 协议的客户端,特别是 IDE 环境。
  • 返回结构化数据: 工具返回 JSON 格式的 NPM 包信息,易于 LLM 应用解析和利用。

安装步骤

  1. 安装依赖: 在项目根目录下,运行以下命令安装项目依赖:
    npm install

服务器配置

对于 MCP 客户端,需要配置连接到此 MCP 服务器的信息。以下是一个 JSON 格式的配置示例,您需要将其添加到您的 MCP 客户端配置中。

{
  "serverName": "npm-package-info-mcp-server",  // MCP 服务器的名称,可以自定义
  "command": "npm",                      // 启动服务器的命令,这里使用 npm
  "args": ["start"]                       // 启动服务器命令的参数,这里使用 start 脚本
}

配置参数说明:

  • 'serverName': 服务器的名称,客户端可以使用此名称来标识和管理连接。您可以自定义此名称。
  • 'command': 启动 MCP 服务器的可执行命令。在本例中,我们使用 'npm' 命令来运行 'npm start' 脚本。
  • 'args': 传递给启动命令的参数列表。这里我们传递 'start' 参数,'npm start' 命令会在项目根目录下执行 'package.json' 中定义的 'start' 脚本来启动服务器。

注意: 请确保您的 MCP 客户端能够正确解析和使用以上 JSON 配置信息,以便与 NPM 包信息 MCP 服务器建立连接。您可能需要在 MCP 客户端的设置或配置文件中添加此配置。

基本使用方法

  1. 启动服务器: 在安装依赖后,于项目根目录下运行以下命令启动 MCP 服务器:

    npm start

    服务器将通过 STDIO 监听客户端请求。

  2. 客户端调用 'getNpmPackageInfo' 工具: 在您的 MCP 客户端中,配置好上述服务器信息后,即可调用 'getNpmPackageInfo' 工具。调用时需要提供 'packageName' 参数,即您要查询的 NPM 包的名称。

    例如,如果您想查询 'react' 包的信息,您需要在 MCP 客户端中发起如下的工具调用请求 (具体请求格式请参考 MCP 协议文档):

    {
      "jsonrpc": "2.0",
      "method": "call",
      "params": {
        "tool_name": "getNpmPackageInfo",
        "arguments": {
          "packageName": "react"
        }
      },
      "id": "任意请求ID"
    }

    服务器将执行 'npm view react' 命令,并将返回包含 'react' 包信息的 JSON 响应给客户端。客户端可以解析响应内容,提取所需的 NPM 包信息,并将其用于后续的 LLM 应用流程中。

信息

分类

开发者工具