使用说明

项目简介

mcp-server 是一个简单的 Model Context Protocol (MCP) 服务器实现,它基于 JSON-RPC 2.0 协议构建,旨在为 LLM 客户端提供可扩展的工具服务。该服务器通过插件机制加载和管理工具,并提供标准的初始化接口来声明自身的服务能力。

主要功能点

  • JSON-RPC 2.0 协议支持: 严格遵循 JSON-RPC 2.0 规范进行通信,确保与 MCP 客户端的兼容性。
  • 工具服务: 通过插件化的方式提供可扩展的工具功能,例如示例中提供的 'echo' 和 'helloworld' 工具。
  • 能力声明: 实现 'initialize' 方法,用于向客户端声明服务器支持的工具及其参数信息,方便客户端动态发现和调用服务。
  • CORS 支持: 默认启用 CORS,允许跨域请求,方便不同来源的客户端访问。
  • 简单易用: 提供便捷的安装和启动方式,易于部署和集成到 LLM 应用环境中。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 打开终端,执行以下命令安装 mcp-server:
    npm install mcp-server

服务器配置

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

{
  "serverName": "mcp-server",
  "command": "npx",
  "args": ["mcp-server"],
  "description": "一个简单的 MCP 服务器,提供 echo 和 helloworld 工具示例。"
}

配置参数说明:

  • 'serverName': 服务器名称,可以自定义,用于在客户端标识该服务器。例如: '"mcp-server"'。
  • 'command': 启动服务器的命令。由于 mcp-server 通过 'npx' 运行,因此配置为 '"npx"'。
  • 'args': 启动服务器命令的参数。这里使用 '["mcp-server"]' 来执行已安装的 'mcp-server' 包。
  • 'description': (可选) 服务器的描述信息,方便用户理解服务器的功能。

基本使用方法

  1. 启动服务器: 安装完成后,在终端中运行以下命令启动 mcp-server:

    npx mcp-server

    服务器默认监听 '4333' 端口。您将在终端看到 "Server listening on port 4333" 的提示信息。

  2. 客户端发送请求: MCP 客户端需要根据 MCP 协议规范,向服务器的根路径 '/' 发送 JSON-RPC 请求。

    示例请求 (调用 'echo' 工具):

    {
      "jsonrpc": "2.0",
      "method": "echo",
      "params": { "message": "Hello MCP Client!" },
      "id": 1
    }

    示例请求 (获取服务器能力):

    {
      "jsonrpc": "2.0",
      "method": "initialize",
      "id": 1
    }

    客户端需要监听服务器返回的 JSON-RPC 响应,并根据响应内容进行处理。

信息

分类

开发者工具