使用说明

项目简介

本项目是一个简单的MCP服务器实现,它使用HTTP传输协议和Server-Sent Events (SSE) 进行通信。该项目旨在演示MCP协议在HTTP传输下的基本工作原理,包括资源管理、工具调用和Prompt处理等核心功能。请注意,这是一个演示项目,返回的数据均为虚拟数据,仅供学习和测试MCP协议使用。 目前主要兼容 Inspector Tool 工具。

主要功能点

  • 资源管理: 支持列出和读取虚拟资源,包括文件、API数据、屏幕截图和数据库模式等多种类型的资源。
  • 工具调用: 支持注册和调用虚拟工具,例如一个简单的加法工具。
  • Prompt模板: 支持定义和获取虚拟Prompt模板,用于模拟LLM的Prompt交互。
  • HTTP传输: 使用HTTP协议和SSE进行客户端-服务器通信。
  • SSE Endpoint: 通过 '/sse' 端点提供SSE连接,用于实时通信。
  • 虚拟数据: 所有资源、工具和Prompt的响应均为预设的虚拟数据,方便快速体验和理解协议流程。

安装步骤

  1. 安装依赖: 确保已安装Python环境,然后在项目根目录下运行以下命令安装所需的Python库:

    pip install -r requirements.txt
  2. 运行服务器: 在项目根目录下,运行以下命令启动MCP服务器:

    python run.py

    服务器默认监听 'http://localhost:8000' 地址。

服务器配置

对于MCP客户端,您需要配置连接到此MCP服务器。以下是连接此服务器的客户端配置示例 (JSON 格式):

{
  "serverName": "MCP-HTTP-Server-Demo",
  "command": "python",
  "args": ["run.py"]
}

配置参数说明:

  • 'serverName': MCP服务器的名称,可以自定义。
  • 'command': 启动MCP服务器的命令,这里使用 'python' 命令。
  • 'args': 启动命令的参数,这里指定运行 'run.py' 文件。

注意: 实际使用时,MCP客户端需要配置连接服务器的URL,本项目使用SSE协议,默认URL为 'http://localhost:8000/sse' (在 Inspector Tool 中配置)。

基本使用方法

  1. 启动服务器: 按照安装步骤启动MCP服务器。
  2. 连接客户端: 使用MCP客户端 (例如 Inspector Tool),配置服务器连接信息,并连接到 'http://localhost:8000/sse'。
  3. 测试功能: 在客户端界面上,您可以尝试以下操作:
    • 点击 "List Resources" (列出资源) 查看虚拟资源列表。
    • 点击 "Get Resource" (获取资源) 并输入资源 URI 测试资源读取功能。
    • 点击 "List Tools" (列出工具) 查看虚拟工具列表。
    • 点击 "Call Tool" (调用工具) 并输入工具名称和参数测试工具调用功能。
    • 点击 "List Prompts" (列出 Prompt) 查看虚拟 Prompt 列表。
    • 点击 "Get Prompt" (获取 Prompt) 并输入 Prompt 名称和参数测试 Prompt 获取功能。

通过以上步骤,您可以体验基于HTTP协议的MCP服务器的基本功能。

信息

分类

开发者工具