使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的 “Hello World” 服务器模板,旨在帮助开发者快速理解和上手 MCP 服务器的开发。它展示了如何创建一个基础但功能完备的 MCP 服务器,该服务器可以向支持 MCP 协议的 LLM 客户端(如 Cursor 编辑器)提供工具服务。

主要功能点

  • 提供工具服务: 实现了 'say_hello' 工具,可以根据用户请求返回问候语。
  • 易于扩展: 作为一个模板,结构清晰,方便开发者在其基础上添加更多工具和功能。
  • 调试支持: 提供详细的调试日志,方便开发和问题排查。
  • 跨平台兼容: 基于 Python 开发,支持跨平台运行。
  • Cursor 集成: 特别考虑了与 Cursor 编辑器的集成,提供了详细的配置说明。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/ericaxelrod-1/model-context-protocol
    cd model-context-protocol/sample-server
  2. 创建并激活虚拟环境:

    python -m venv venv
    # Windows
    .\venv\Scripts\activate
    # macOS/Linux
    source venv/bin/activate
  3. 安装依赖:

    pip install -r requirements.txt

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以 Cursor 编辑器为例,需要在 Cursor 的 'mcp.json' 配置文件中添加以下配置信息。这个配置告诉 Cursor 如何启动你的 MCP 服务器。

"hello_mcp": {
    "command": "C:\\path\\to\\your\\venv\\Scripts\\python.exe",
    "args": [
        "C:\\path\\to\\your\\src\\hello.py",
        "--debug"
    ]
}

配置参数说明:

  • server name ('hello_mcp'): 服务器名称,可以自定义,用于在 Cursor 中标识和选择该服务器。
  • command: Python 解释器的路径。需要指向你创建的虚拟环境中的 Python 解释器。请根据你的实际虚拟环境路径修改 'C:\path\to\your\venv\Scripts\python.exe'。
  • args: 启动服务器的参数列表。
    • 'C:\path\to\your\src\hello.py': 服务器主程序的路径。请根据你的实际项目路径修改 'C:\path\to\your\src\hello.py'。
    • '--debug': 可选参数,启用调试日志。

注意: 请根据你的实际环境修改 'command' 和 'args' 中的路径。

基本使用方法

  1. 启动服务器: 在终端中,激活虚拟环境后,运行以下命令启动 MCP 服务器:

    python -m src.hello --debug

    或者直接执行脚本:

    python src/hello.py --debug

    添加 '--debug' 参数可以启用更详细的日志输出,方便调试。

  2. 客户端调用: 配置完成后,在 MCP 客户端(如 Cursor 编辑器)中,客户端会通过 MCP 协议与服务器建立连接,并可以调用服务器提供的工具。例如,Cursor 可以调用 'say_hello' 工具来获取问候语。具体的调用方式取决于 MCP 客户端的功能和界面。

  3. 测试客户端: 仓库中提供了一个简单的测试客户端 'tests/test_client.py',可以用来测试服务器是否正常工作:

    python -m tests.test_client --debug

信息

分类

AI与计算