使用说明

项目简介

mcp-hello-world 是一个简单的 Model Context Protocol (MCP) 服务器示例,旨在帮助开发者理解和实践 MCP 服务器的打包和配置。它实现了一个基础的工具 'hello-world',可以根据用户提供的问候语返回定制的问候消息。

主要功能点

  • 提供工具 (Tools): 实现了 'hello-world' 工具,允许客户端调用并返回简单的问候语。
  • 基于标准IO (Stdio) 运行: 使用标准输入输出流作为通信协议,方便集成和部署。
  • 易于配置: 提供了 Docker 和直接运行的配置示例,方便用户快速启动和测试。

安装步骤

由于该项目是一个简单的 Python 应用,推荐使用 'uvx' 直接运行,无需显式安装步骤。确保你的环境中已安装 Python 和 'uvx'。

服务器配置

对于 MCP 客户端(例如 Claude.app),你需要配置 MCP 服务器的启动命令。以下是基于仓库 'README.md' 提供的配置信息,你可以根据你的实际使用场景选择合适的配置方式。

配置示例 (针对 Claude.app)

以下配置信息可以直接添加到 Claude.app 的 MCP 服务器设置中。

"mcpServers": {
  "hello-world": {  // 服务器名称,可以自定义,例如 "hello-world" 或 "greeting-server"
    "command": "uvx",  // 运行命令,这里使用 uvx 直接运行 Python 脚本
    "args": ["src/mcp_hello_world/__main__.py"] // 命令参数,指向服务器入口脚本
  }
}

配置参数说明:

  • server name: 服务器名称 ('hello-world'),用于在 MCP 客户端中标识和引用该服务器。可以自定义。
  • command: 启动服务器的命令 ('uvx')。 确保你的系统环境中 'uvx' 命令可用。如果使用 Docker,请参考 'README.md' 中的 Docker 配置。
  • args: 命令参数 ('["src/mcp_hello_world/main.py"]')。指定要执行的 Python 脚本路径,指向 'mcp_hello_world' 项目的入口点。

注意: 如果你选择使用 Docker 部署,请参考 'README.md' 中提供的 Docker 配置,并相应修改 'command' 和 'args' 字段。

基本使用方法

  1. 启动 MCP 服务器: 根据上述配置,在 MCP 客户端 (如 Claude.app) 中添加并启用 'hello-world' 服务器配置。客户端会根据配置的命令和参数启动 MCP 服务器。
  2. 调用工具: 在 MCP 客户端中,你可以指示 LLM 调用 'hello-world' 工具。例如,在 Claude.app 中,你可以指示 Claude 使用 'hello-world' 工具并传递 'greeting' 参数。
  3. 传递参数: 'hello-world' 工具接受一个必需的参数 'greeting' (字符串类型),用于指定问候语。例如,你可以传递参数 '{"greeting": "你好"}'。
  4. 获取结果: MCP 服务器会执行 'hello-world' 工具,并返回包含问候消息的 JSON-RPC 响应。客户端会接收并处理响应,将结果提供给 LLM 或用户。

示例对话 (在支持 MCP 工具调用的 LLM 应用中):

用户输入: "请用 hello-world 工具问候一下,说'早上好'"

LLM (客户端) 会调用 'hello-world' 工具,并传递参数 '{"greeting": "早上好"}'。

MCP 服务器 (mcp-hello-world) 收到请求后,执行工具并返回:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "type": "text",
      "text": "早上好 World!"
    }
  ],
  "id": 1
}

客户端将 "早上好 World!" 作为工具执行结果展示或提供给 LLM 进行后续处理。

信息

分类

开发者工具