使用说明

项目简介

本项目是一个基于 Python 和 MCP Python SDK 的最小化 MCP 服务器模板。它旨在帮助开发者快速搭建符合 Model Context Protocol 标准的服务器,以便为 LLM 客户端提供上下文信息和工具能力。通过此模板,你可以轻松扩展和定制自己的 MCP 服务器,集成资源管理、工具执行和 Prompt 模板渲染等功能。

主要功能点

  • 基础MCP服务器框架: 提供可运行的 MCP 服务器代码结构。
  • 工具注册示例: 演示如何使用装饰器注册和暴露工具函数供 LLM 调用。
  • 易于扩展: 作为一个模板,方便开发者在其基础上添加自定义资源、工具和 Prompt 模板。
  • 开发和运行指南: 提供详细的安装和运行步骤,支持在 VSCode 和 MCP Inspector 等环境中运行。
  • 使用官方 SDK: 基于 MCP Python SDK 构建,确保与 MCP 协议的兼容性和易用性。

安装步骤

  1. 安装 uv 包管理器: 如果尚未安装,请根据 uv 文档 安装 uv。
  2. 安装 Python 3.13+: 使用 uv 安装 Python 3.13 或更高版本: 'uv python install 3.13'
  3. 克隆仓库: 将 GitHub 仓库 'https://github.com/Killian0812/python-mcp-server' 克隆到本地。
  4. 进入项目目录: 在终端中导航到克隆的仓库目录。
  5. 安装依赖并创建虚拟环境: 运行命令 'uv sync' 安装项目依赖并创建 Python 虚拟环境。
  6. 激活虚拟环境: 根据你的操作系统,运行 'source .venv/bin/activate' (Linux/macOS) 或 '.venv\Scripts\activate' (Windows) 激活虚拟环境。

服务器配置

MCP 客户端(例如 VS Code Copilot Edits)需要配置连接到此 MCP 服务器的信息。以下是客户端配置所需的 JSON 格式信息,用于指定服务器的启动命令和参数:

{
    "serverName": "Demo",
    "command": "python",
    "args": ["server/main.py"]
}
  • 'serverName': 服务器名称,与代码中 'FastMCP("Demo")' 定义的名称一致。
  • 'command': 启动服务器的命令,这里是 'python'。
  • 'args': 命令参数列表,指定服务器脚本的路径,即 '["server/main.py"]'。

将以上 JSON 配置信息填入 MCP 客户端的相关设置中,即可建立客户端与此 MCP 服务器的连接。

基本使用方法

  1. 启动服务器: 在激活虚拟环境后,你可以使用以下命令启动服务器:
    • 开发模式 (使用 MCP Inspector): 'mcp dev server/main.py' (推荐用于快速测试和调试)
    • 直接运行: 'python server/main.py'
  2. 配置 MCP 客户端: 根据上述 "服务器配置" 部分的说明,配置你的 MCP 客户端,指向正在运行的服务器。
  3. 测试工具: 一旦客户端连接成功,客户端即可向服务器发送 MCP 请求,例如调用服务器中定义的 'add' 和 'subtract' 工具进行测试。

信息

分类

开发者工具