使用说明

项目简介

Haze Echo MCP Server 是一个基于 Model Context Protocol (MCP) 的简单服务器实现。它主要用于演示 MCP 服务器的基本结构和功能,特别是工具 (Tools) 的注册和调用。该服务器实现了一个非常基础的 回声 (Echo) 工具,可以接收客户端发送的消息并原样返回。

主要功能点

  • 实现 MCP 协议: 遵循 MCP 协议规范,能够接收和处理来自 MCP 客户端的请求。
  • 注册和执行工具: 内置一个名为 'Echo' 的工具,客户端可以调用此工具并传递消息。
  • Stdio 传输: 使用标准的输入/输出流 (Stdio) 作为 MCP 服务器的传输协议,方便在命令行环境下运行和测试。
  • 简单易用: 代码简洁明了,易于理解和上手,适合初学者学习 MCP 服务器的开发。

安装步骤

由于这是一个 .NET 项目,你需要先安装 .NET SDK。

  1. 安装 .NET SDK: 如果你的电脑上还没有安装 .NET SDK,请访问 https://dotnet.microsoft.com/download 下载并安装适合你操作系统的 SDK 版本。

  2. 下载代码: 从 GitHub 仓库 https://github.com/zaevi/Haze.McpServer.Echo 下载源代码,或者使用 Git 克隆到本地。

  3. 进入项目目录: 打开命令行终端,进入下载或克隆到本地的项目目录 'Haze.McpServer.Echo'。

  4. 运行服务器: 在项目目录下,执行以下命令运行服务器:

    dotnet run

    服务器成功启动后,会监听标准输入流,等待接收来自 MCP 客户端的请求。

服务器配置

MCP 客户端需要配置以下信息才能连接到 Haze Echo MCP Server。以下是 JSON 格式的配置信息示例,请根据你的实际情况进行配置:

{
  "serverName": "HazeEchoServer",
  "command": "dotnet",
  "args": [
    "run",
     "--project", "./"
  ],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器的名称,可以自定义,用于在客户端标识不同的 MCP 服务器。 例如: "HazeEchoServer"。
  • 'command': 启动服务器的命令。由于项目使用 'dotnet run' 运行,所以这里填写 "dotnet"。
  • 'args': 启动命令的参数列表。
    • '"run"': 'dotnet run' 命令用于运行 .NET 项目。
    • '"--project", "./"': 指定要运行的项目文件路径,'"./"' 表示当前目录下的项目文件。 (请注意,如果你的客户端工作目录与服务器项目目录不同,可能需要调整此路径为服务器项目文件相对于客户端工作目录的路径。)
  • 'transport': 指定 MCP 服务器使用的传输协议。 此服务器使用 Stdio,所以这里填写 "stdio"。

重要提示:

  • 确保 MCP 客户端能够找到并执行 'dotnet' 命令。如果 'dotnet' 没有添加到系统环境变量,你可能需要提供 'dotnet' 命令的完整路径。
  • 客户端的工作目录和服务器的项目目录可能需要根据实际情况进行调整,以确保客户端能够正确启动服务器。

基本使用方法

  1. 启动 MCP 服务器: 按照上面的 "安装步骤" 启动 Haze Echo MCP Server。

  2. 配置 MCP 客户端: 在你的 MCP 客户端中,配置上面提供的服务器配置信息,确保客户端能够连接到正在运行的 Haze Echo MCP Server。

  3. 调用 Echo 工具: 通过 MCP 客户端,向 Haze Echo MCP Server 发送调用 "Echo" 工具的请求,并附带你需要回显的消息内容。服务器会将消息加上 "hello " 前缀后返回给客户端。

例如,客户端可以发送如下 JSON-RPC 请求 (具体请求格式取决于你使用的 MCP 客户端库):

{
  "jsonrpc": "2.0",
  "method": "Tool.Echo",
  "params": {
    "message": "world"
  },
  "id": 1
}

服务器会返回类似以下的 JSON-RPC 响应:

{
  "jsonrpc": "2.0",
  "result": "hello world",
  "id": 1
}

通过这个简单的例子,你可以体验 MCP 服务器的基本工作流程和工具调用机制。

信息

分类

开发者工具