关键词

JSON-RPC协议实现Rust上下文服务基础框架

使用说明

项目简介

本项目 'mcp_rs_test' 是一个使用 Rust 语言编写的 Model Context Protocol (MCP) 服务器的简单实现。该项目旨在学习 Rust 语言和 MCP 协议，并提供一个基础的 MCP 服务器框架。

主要功能点

  • JSON-RPC 通信: 实现了基于 JSON-RPC 2.0 协议的客户端-服务器通信，能够接收和解析 MCP 客户端发送的 JSON-RPC 请求，并返回符合协议的响应。
  • 初始化 (initialize) 方法: 支持 MCP 协议的 'initialize' 方法，用于服务器初始化和能力声明，返回服务器协议版本、服务器信息和基础能力。
  • 心跳检测 (ping) 方法: 支持 'ping' 方法，用于客户端检测服务器的可用性。
  • 通知 (notifications/initialized) 处理: 能够处理客户端发送的 'notifications/initialized' 通知消息。
  • 错误处理: 实现了基本的 JSON-RPC 错误处理机制，能够对无效请求或解析错误返回相应的错误响应。

请注意： 这是一个非常基础的 MCP 服务器实现，主要用于学习和演示 MCP 协议的基本框架。它不包含资源管理、工具注册、Prompt模板等 MCP 协议的完整功能，仅实现了协议的基础通信和初始化部分。

安装步骤

  1. 安装 Rust 环境: 确保您的系统已安装 Rust 编程环境 (Rust 1.83 或更高版本)。您可以访问 Rust官网 按照指引进行安装。

  2. 下载仓库代码: 从 GitHub 仓库 mcp_rs_test 下载源代码。您可以克隆仓库或直接下载 ZIP 文件。

  3. 编译服务器: 打开命令行终端，进入项目根目录 'mcp_rs_test'，根据需要执行以下命令进行编译：

    • Debug 模式编译 (用于开发和调试):

      cargo build

    • Release 模式编译 (用于生产环境):

      cargo build --release

    编译成功后，可执行文件将位于 'target/debug/mcp_rs_test.exe' (Debug 模式) 或 'target/release/mcp_rs_test.exe' (Release 模式)。

服务器配置

要将 'mcp_rs_test' 服务器与 MCP 客户端（例如 Claude 桌面客户端）配合使用，您需要在客户端的配置文件中添加服务器配置信息。以 'claude_desktop_config.json' 为例，您需要添加类似以下的配置：

{
  "mcp_rs_test": {
    "command": "<path to your mcp_rs_test.exe>",
    "args": []
  }
}

配置参数说明:

  • '"mcp_rs_test"': 服务器名称，可以自定义，用于在客户端配置文件中标识该服务器。
  • '"command"': [必填] MCP服务器可执行文件的路径。请将 '<path to your mcp_rs_test.exe>' 替换为您实际编译生成的 'mcp_rs_test.exe' 文件的完整路径。例如：'"C:\path\to\mcp_rs_test\target\release\mcp_rs_test.exe"' 或 '"./target/release/mcp_rs_test.exe"' (相对路径，如果从项目根目录启动客户端)。
  • '"args"': [可选] 启动服务器时需要传递的命令行参数。本项目 'mcp_rs_test' 服务器不需要任何命令行参数，因此这里配置为空数组 '[]' 即可。

配置示例 (假设 'mcp_rs_test.exe' 位于 'C:\mcp_server\target\release' 目录下):

{
  "mcp_rs_test": {
    "command": "C:\\mcp_server\\target\\release\\mcp_rs_test.exe",
    "args": []
  }
}

基本使用方法

  1. 启动 MCP 服务器: MCP 服务器不需要手动启动。当 MCP 客户端（例如 Claude 桌面客户端）需要与该服务器通信时，客户端会根据配置文件中的 '"command"' 和 '"args"' 信息自动启动服务器进程。

  2. 客户端交互: 配置完成后，启动 MCP 客户端。客户端会通过标准输入 (stdin) 向 'mcp_rs_test' 服务器发送 JSON-RPC 请求，服务器接收请求并处理后，通过标准输出 (stdout) 返回 JSON-RPC 响应。

  3. 查看日志: 服务器运行日志会输出到 'C:\tmp\my_rust_bin.log' 文件中，您可以通过查看日志文件了解服务器的运行状态和请求处理情况。

注意: 由于 'mcp_rs_test' 只是一个基础的 MCP 服务器实现，它只能响应 'initialize' 和 'ping' 等基本方法。要测试更复杂的功能，您需要使用功能更完善的 MCP 服务器实现。

信息

分类

开发者工具

访问项目