使用说明

项目简介

MonkeyMCP Server 是一个使用 .NET 9.0 开发的 Model Context Protocol (MCP) 服务器示例。它旨在演示如何使用 ModelContextProtocol 库构建符合 MCP 协议的服务器,并提供了一些基础功能,例如通过工具获取猴子数据和简单的消息回声。这个项目可以帮助开发者理解 MCP 服务器的架构和开发流程。

主要功能点

  • MCP 服务器核心实现: 使用 ModelContextProtocol 库构建,实现了 MCP 协议的基本服务器框架,能够接收和响应 MCP 客户端的请求。
  • 标准输入/输出 (Stdio) 传输: 采用 Stdio 作为默认的通信协议,方便与客户端进行交互。
  • 工具 (Tools) 注册与执行: 实现了 "GetMonkeys" (获取所有猴子列表)、 "GetMonkey" (根据名称获取指定猴子信息) 和 "Echo" (消息回声) 等工具,展示了如何在 MCP 服务器中注册和使用工具扩展功能。
  • 资源 (Resources) 管理示例 (猴子数据): 通过 MonkeyService 服务,演示了如何从外部数据源(示例中为 JSON 文件)获取和管理资源数据,并通过工具向客户端提供数据访问能力。
  • 配置灵活: 基于 Microsoft.Extensions.Hosting 构建,支持通过 JSON、环境变量或命令行参数进行配置。

安装步骤

  1. 安装 .NET 9.0 SDK: 确保您的开发环境已安装 .NET 9.0 SDK 或更高版本。您可以从 .NET 官网 下载并安装。
  2. 克隆仓库: 使用 Git 克隆 MonkeyMCP 仓库到本地:
    git clone https://github.com/jamesmontemagno/MonkeyMCP.git
  3. 进入项目目录: 导航到克隆下来的 MonkeyMCP 目录:
    cd MonkeyMCP
  4. 构建项目: 使用 .NET CLI 构建项目:
    dotnet build

服务器配置

MCP 客户端需要配置服务器的启动命令和参数才能连接到 MonkeyMCP Server。以下是客户端配置示例 (JSON 格式):

{
  "serverName": "MonkeyMCP",
  "command": "dotnet",
  "args": [ "run", "--project", "MonkeyMCP" ]
  // "serverName": 服务器的名称,客户端用于标识连接。
  // "command": 启动服务器的命令,这里使用 "dotnet" 运行 .NET 程序。
  // "args":  传递给 "dotnet" 命令的参数,"run --project MonkeyMCP" 表示运行 MonkeyMCP 项目。
}

基本使用方法

  1. 启动服务器: 在 MonkeyMCP 项目目录下,运行以下命令启动服务器:
    dotnet run
    服务器成功启动后,将通过标准输出等待客户端连接。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中,根据 服务器配置 部分的说明,配置连接到 MonkeyMCP Server。
  3. 客户端与服务器交互: 客户端连接成功后,即可通过 MCP 协议向服务器发送请求,例如调用 "GetMonkeys" 工具获取猴子列表,或调用 "Echo" 工具发送消息。具体的工具调用方法请参考 MCP 客户端的文档。

信息

分类

开发者工具