关键词

MCP服务器示例PythonFastMCP功能演示

使用说明

项目简介

OpenMCP 示例服务器是一个使用 Python FastMCP 库构建的示例 MCP 服务器。它演示了如何定义和托管资源（Resources）、注册工具（Tools）以及定义 Prompt 模板（Prompts），旨在配合 OpenMCP 客户端调试工具进行功能测试和开发学习。

主要功能点

  • 资源管理: 托管了多种示例资源，包括问候语、天气信息、用户资料和书籍信息，支持客户端通过 URI 访问获取。
  • 工具调用: 注册了多个实用工具，如加法、乘法、判断偶数、首字母大写等，允许客户端调用执行，扩展 LLM 的能力。
  • Prompt模板: 定义了翻译、摘要生成、代码解释和邮件生成等 Prompt 模板，支持客户端获取并定制 LLM 交互模式。
  • 标准MCP协议: 基于 FastMCP 框架，遵循 Model Context Protocol 标准，易于与任何 MCP 客户端进行交互。

安装步骤

  1. 环境准备: 确保您的计算机上已安装 Python 3.7 或更高版本。
  2. 安装依赖: 安装 FastMCP 库，在命令行终端中执行： 
    pip install fastmcp
  3. 获取代码: 下载或克隆此 GitHub 仓库到本地。
  4. 进入服务器目录: 通过命令行终端，导航到仓库中的 'servers' 目录： 
    cd servers

服务器配置

MCP 客户端需要配置服务器的启动命令才能建立连接。对于 OpenMCP 示例服务器，您需要为客户端提供以下配置信息：

{
  "server name": "OpenMCP Example Server",
  "command": "python",
  "args": ["main.py"]
}

配置参数说明:

  • 'server name': 服务器的名称，可以自定义，用于在客户端标识连接。
  • 'command': 启动服务器的命令，这里使用 'python' 命令来执行 Python 脚本。
  • 'args': 命令参数列表，这里指定要执行的脚本为 'main.py'。

注意: 请确保客户端配置中的 'command' 和 'args' 指向 'servers/main.py' 脚本的正确路径。如果您直接在 'servers' 目录下启动客户端，则以上配置可以直接使用。

基本使用方法

  1. 启动服务器: 在命令行终端中，于 'servers' 目录下执行以下命令启动 OpenMCP 示例服务器： 
    python main.py
    服务器成功启动后，通常会在终端显示相关信息。
  2. 启动 MCP 客户端: 启动 OpenMCP 客户端调试工具 (通常是一个 VS Code 插件)。
  3. 配置客户端连接: 在 OpenMCP 客户端中，配置新的服务器连接。选择 STDIO 连接方式，并将上面提供的服务器配置信息填入客户端的相应配置项中。
  4. 连接到服务器: 在客户端中发起连接，如果配置正确且服务器已启动，客户端应能成功连接到 OpenMCP 示例服务器。
  5. 使用客户端功能: 连接成功后，您可以使用 OpenMCP 客户端提供的各项功能，如：
    • 浏览资源: 查看服务器托管的资源列表和资源模板。
    • 读取资源: 通过资源 URI 读取特定资源的内容。
    • 调用工具: 查看服务器注册的工具列表，并调用工具执行。
    • 测试 Prompt: 获取服务器定义的 Prompt 模板，并根据需要传入参数进行测试。

通过以上步骤，您可以成功运行 OpenMCP 示例服务器，并使用 OpenMCP 客户端调试工具与其进行交互，体验 MCP 服务器的基本功能。

信息

分类

开发者工具

访问项目