使用说明

项目简介

本项目 'mcp-python-demo' 是一个使用 Python 和 FastMCP SDK 构建的 MCP 服务器示例。它展示了如何通过简单的 Python 代码,创建一个能够向支持 MCP 协议的 LLM 客户端(如 Claude、GitHub Copilot)提供资源、工具和 Prompt 模板的后端服务。

主要功能点

  • 资源 (Resources) 管理: 示例中定义了一个名为 'config://app' 的静态配置资源,可以被 LLM 客户端读取以获取应用配置信息。
  • 工具 (Tools) 注册与执行: 提供了多个工具示例,包括:
    • 'add_list_of_numbers': 计算列表中数字的总和。
    • 'count_letter_in_text': 统计文本中特定字母出现的次数。
    • 'run_azure_cli_command': 运行 Azure CLI 命令(需要环境中已安装 Azure CLI)。
  • Prompt 模板 (Prompts) 定义: 包含一个 'review_code' Prompt 模板,用于请求 LLM 审阅代码。
  • 开发与安装: 提供了便捷的开发 inspector 运行方式,以及在 Claude 和 GitHub Copilot 中安装和使用 MCP 服务器的详细步骤。

安装步骤

  1. 环境准备: 确保已安装 Python 环境。建议使用 'uv' 包管理器,根据仓库 'README.md',可能需要安装 'uv'。
  2. 安装 MCP 服务器: 在仓库根目录下,使用 'mcp install server.py' 命令即可完成安装。(根据 'README.md',这步可能需要在 Claude 中安装插件时使用,对于本地开发或在 Copilot 中使用,可能不需要显式安装,而是通过配置告知客户端服务器位置)
  3. 运行开发服务器: 在仓库根目录下,使用 'mcp dev server.py' 命令可以启动开发 inspector,方便调试和测试 MCP 服务器功能。

服务器配置

MCP 服务器需要配置到 MCP 客户端中才能使用。以 GitHub Copilot 为例,需要配置服务器的启动命令和参数。以下是两种配置方式,选择其一即可:

方式一:针对特定代码仓库配置 (在当前仓库的 '.vscode/mcp.json' 文件中配置)

在你的 'mcp-python-demo' 仓库的 '.vscode' 目录下创建 'mcp.json' 文件,并填入以下内容:

{
  "inputs": [],
  "servers": {
    "pamelas-mcp": {  // 服务器名称,可以自定义
      "command": "<uv executable path>",  //  uv 包管理器的可执行文件路径,例如 /Users/yourname/.local/bin/uv,你需要替换成你实际的 uv 路径
      "args": [
        "--directory",
        "<mcp-python-demo project path>",  // mcp-python-demo 项目的绝对路径,例如 /Users/yourname/Documents/mcp-python-demo,你需要替换成你实际的项目路径
        "run",
        "server.py"
      ]
    }
  }
}

方式二:全局配置 (添加到 VS Code 用户设置 JSON 文件中)

打开 VS Code 设置 (File -> Preferences -> Settings 或 Code -> Settings -> Settings),搜索 "mcp",找到 "mcp" 设置项,点击 "Edit in settings.json" 打开 'settings.json' 文件,添加或修改 'mcp' 配置如下:

{
  "mcp": {
    "inputs": [],
    "servers": {
      "pamelas-mcp": {  // 服务器名称,可以自定义
        "command": "<uv executable path>",  //  uv 包管理器的可执行文件路径,例如 /Users/yourname/.local/bin/uv,你需要替换成你实际的 uv 路径
        "args": [
          "--directory",
          "<mcp-python-demo project path>",  // mcp-python-demo 项目的绝对路径,例如 /Users/yourname/Documents/mcp-python-demo,你需要替换成你实际的项目路径
          "run",
          "server.py"
        ]
      }
    }
  }
}

注意:

  • '<uv executable path>' 和 '<mcp-python-demo project path>' 必须替换 为你电脑上 'uv' 可执行文件的实际路径和 'mcp-python-demo' 项目的实际路径。可以使用 'which uv' 命令查找 'uv' 的路径。
  • '"pamelas-mcp"' 是服务器的名称,你可以自定义,在 Copilot 中会显示这个名称。
  • 'command' 和 'args' 描述了如何启动 MCP 服务器。'uv run server.py' 会在项目目录下使用 'uv' 运行 'server.py' 文件,从而启动 MCP 服务器。

基本使用方法 (在 GitHub Copilot 中)

  1. 启动 Copilot Agent 模式: 在 VS Code 中打开 GitHub Copilot,确保选择的是 'Agent' 模式(而不是 'Chat' 或 'Edits' 模式)。
  2. 刷新服务器列表: 点击 Copilot 聊天输入框右上角的 "刷新" 按钮,Copilot 会重新检测可用的 MCP 服务器。
  3. 查看可用工具: 点击 "🛠️" 工具按钮,即可看到所有可用的工具,包括来自 'mcp-python-demo' 服务器的工具。
  4. 使用工具: 在 Copilot 聊天框中输入自然语言问题,Copilot 会根据你的问题和可用的工具,自动调用相应的工具来辅助完成任务。例如,可以提问 "What is the current weather in Seattle?" (如果你的 MCP 服务器实现了获取天气的工具)。对于本示例提供的工具,你可以尝试类似 "Add numbers 1, 2, 3" 或 "Count 'e' in 'example text'" 的问题,Copilot 可能会识别并调用相应的工具。

信息

分类

开发者工具