关键词

RESTful APIJSON-RPCHTTP服务器传输模型上下文协议

使用说明

项目简介

本项目是 ChatMCP Typescript SDK 的一部分，提供了基于 RESTful API 的 MCP 服务器传输层实现。它允许 MCP 客户端通过标准的 HTTP POST 请求与 MCP 服务器进行通信，实现基于 JSON-RPC 协议的消息交换。

主要功能点

  • RESTful API 接口: 提供标准的 HTTP POST 接口，用于接收 MCP 客户端发送的 JSON-RPC 请求。
  • JSON-RPC 协议支持: 完全支持 MCP 协议定义的 JSON-RPC 通信规范，包括请求、响应和通知的处理。
  • 同步 HTTP 传输: 采用同步 HTTP 传输模式，每个请求都获得即时响应，适用于无状态和简单的 MCP 服务器部署场景。
  • 易于集成: 基于 Express.js 框架构建，可以方便地集成到现有的 Node.js 服务器应用中。
  • 可配置: 允许配置服务器监听端口和 API 端点，以适应不同的部署环境。

安装步骤

  1. 安装 SDK: 确保你的项目中已经安装了 Node.js 和 npm。在项目目录下，运行以下命令安装 '@chatmcp/sdk'： 
    npm install @chatmcp/sdk

服务器配置

MCP 客户端需要配置以下信息以连接到基于 REST Server Transport 的 MCP 服务器。配置信息为 JSON 格式，示例如下：

{
  "server name": "mcp-rest-server",
  "command": "node",
  "args": [
    "path/to/your/server.js" // 请替换为您的服务器启动脚本的实际路径。例如，如果您的服务器代码保存在 server.js 文件中，则此处应填写 "server.js"。
  ],
  "transport": {
    "type": "rest",
    "options": {
      "endpoint": "/rest", // REST API 的端点路径，默认为 "/rest"。如果服务器配置了不同的端点，请修改此处。
      "port": 9593      // 服务器监听的端口号，默认为 9593。如果服务器运行在不同的端口，请修改此处。
    }
  }
}

配置参数说明:

  • 'server name': MCP 服务器的名称，可以自定义，用于在客户端标识服务器。
  • 'command': 启动 MCP 服务器的命令。对于 Node.js 服务器，通常为 '"node"'。
  • 'args': 启动命令的参数列表。
    • 通常第一个参数是服务器启动脚本的路径。请根据您的实际情况修改 'path/to/your/server.js'。
  • 'transport': 指定 MCP 服务器使用的传输协议。
    • 'type': 传输协议类型，此处为 '"rest"'，表示使用 REST Server Transport。
    • 'options': 传输协议的配置选项。
      • 'endpoint': REST API 的端点路径。客户端将向此路径发送 HTTP POST 请求。
      • 'port': 服务器监听的端口号。客户端需要知道服务器运行的端口才能建立连接。

基本使用方法

  1. 启动 MCP 服务器: 根据 'server.js' 示例代码，创建一个服务器启动脚本，并使用 'node server.js' 命令启动服务器。确保服务器成功运行并监听在配置的端口上。
  2. 配置 MCP 客户端: 在 MCP 客户端的配置中，填入上述提供的 JSON 配置信息。客户端将根据配置信息，通过 HTTP POST 请求与 MCP 服务器建立连接并进行通信。
  3. 发送 MCP 请求: MCP 客户端可以使用 SDK 提供的接口，构造符合 MCP 协议的 JSON-RPC 请求，并发送到配置的 REST API 端点。服务器将处理请求，并返回 JSON-RPC 响应。

通过以上步骤，您可以使用基于 REST Server Transport 的 MCP 服务器，为您的 LLM 应用提供上下文服务。

信息

分类

网页与API

访问项目