项目简介

'py-mcp-server-template' 是一个帮助开发者使用 Python 快速创建自己的 Model Context Protocol (MCP) 服务器的模板项目。它提供了一个基础框架，展示了如何定义和注册可供 LLM 调用的工具。

主要功能点

• 实现一个基础的 MCP 服务器。
• 注册并暴露自定义工具（例如获取笑话、查询天气）供 LLM 调用。
• 支持标准的 MCP 传输协议（默认使用 Stdio）。

安装步骤

本项目使用 'uv' 进行依赖管理。

1. 安装 'uv': 如果您尚未安装 'uv'，请参照 uv 官方文档 进行安装。
2. 克隆仓库: 将此模板仓库克隆到您的本地。
3. 创建并激活虚拟环境:
   • 在项目根目录下运行命令 'uv venv'。
   • 根据您的操作系统，运行 'source .venv/bin/activate' (macOS/Linux) 或 '.venv\Scripts\activate' (Windows) 激活虚拟环境。
4. 安装依赖: 激活虚拟环境后，运行 'uv pip install .' 安装项目所需的库。

服务器配置 (用于MCP客户端)

MCP 服务器通常由兼容的客户端应用程序（如 Claude Desktop, Cursor）启动和管理。您需要在客户端应用的设置中添加此服务器的配置。配置信息通常是一个 JSON 对象，包含服务器的启动命令和参数。

您需要提供以下关键信息给客户端配置：

• 服务器名称: 给您的服务器起一个独一无二的名字（例如: 'my-python-mcp-server'）。
• 启动命令 (command): 执行服务器脚本的命令。在此模板中，推荐使用 'uv' 来运行脚本，所以命令通常是 'uv'。
• 启动参数 (args): 传递给启动命令的参数列表。对于此模板，参数应指定 'uv' 运行哪个 Python 解释器和哪个脚本文件。这通常包括：
  • 'run': 'uv' 的一个子命令。
  • '--python <path_to_venv_python>': 指定使用您在项目虚拟环境 ('.venv') 中的 Python 解释器的绝对路径。
  • '<path_to_mcp_server.py>': 指定 'mcp_server.py' 文件的绝对路径。
• 工作目录 (workingDirectory): 服务器进程应该在其下运行的目录的绝对路径。通常是您的项目根目录。

请确保配置中的路径全部是绝对路径，并指向您的项目目录和虚拟环境。

基本使用方法

配置完成后，启动您的 MCP 客户端应用程序。应用程序将根据您提供的配置启动并连接到此 Python MCP 服务器。一旦连接建立，您就可以在与 LLM 的交互中通过客户端调用服务器暴露的工具（如 ping, get_joke, get_weather）。