MCP Server Template (python)

🚀 MCP 服务器模板（Python）

这是一个现成的模板，可用于快速构建模型上下文协议（MCP）服务器。借助该模板，您能够迅速创建可注册和暴露工具与提示的服务器，供 AI 模型使用。

📚 目录

• 快速开始
• 命令行选项
• 创建自己的工具和提示
• 项目结构
• 部署选项
• 开发指南
• 需要帮助？

🚀 快速开始

先决条件

• Python 3.10 或更高版本

三步快速设置

1️⃣ 安装包

# 克隆仓库
git clone https://github.com/nisarg38/mcp-server-template-python.git my-mcp-server
cd my-mcp-server

# 以开发模式安装
pip install -e ".[dev]"

2️⃣ 运行您的服务器

# 使用 Python 运行
python -m src.main

# 或使用方便的 CLI
mcp-server-template

3️⃣ 您的服务器现已启动！

访问您的 MCP 服务器：

• 🌐 HTTP：http://localhost:8080
• 💻 或使用 stdio 运输：mcp-server-template --transport stdio

您会看到日志输出，确认服务器成功运行。

🎮 命令行选项

通过这些命令行选项自定义您的服务器行为：

# 更改端口（默认：8080）
mcp-server-template --port 9000

# 启用调试模式以获得更详细的日志
mcp-server-template --debug

# 使用 stdio 运输而不是 HTTP
mcp-server-template --transport stdio

# 设置日志级别（选项：debug, info, warning, error）
mcp-server-template --log-level debug

🛠️ 创建自己的工具和提示

添加一个工具

工具是 AI 模型可以调用的函数。要添加新的工具：

1. 编辑 src/main.py
2. 使用 @mcp.tool() 装饰器添加新函数：

@mcp.tool()
def your_tool_name(param1: str, param2: int) -> Dict[str, Any]:
    """
    示例：在此处添加工具的描述。

    Args:
        param1: 描述参数 1。
        param2: 描述参数 2。

    Returns:
        返回值的描述。
    """

添加一个提示

提示是模型可以用来生成响应的字符串。要添加新的提示：

1. 编辑 src/main.py
2. 使用 @mcp.prompt() 装饰器添加新函数：

@mcp.prompt()
def your_prompt_name() -> str:
    """
    示例：在此处添加提示描述。
    """

💻 使用示例

基础用法

# 示例工具
@mcp.tool()
def add_numbers(param1: float, param2: float) -> float:
    """
    Args:
        param1: 第一个数字。
        param2: 第二个数字。

    Returns:
        两个数字的和。
    """
    return param1 + param2

# 示例提示
@mcp.prompt()
def math_prompt() -> str:
    """
    Returns:
        "请计算这两个数字的和。"
    """

📦 项目结构

your_project/
├── src/
│   ├── main.py         # MCP 服务器主文件
│   └── prompts.py      # 定义提示的地方
└── requirements.txt   # 必要的依赖项列表

💻 部署选项

基于 Web 的界面

您可以使用 FastAPI 或 Flask 创建一个简单的基于 Web 的界面来与 MCP 服务器交互。

打包和部署

使用 setuptools 将您的 MCP 服务器打包为一个独立的可执行文件，然后部署到生产环境中。

🛠️ 开发指南

安装依赖项

在 requirements.txt 中列出所有必要的库，并运行：

pip install -r requirements.txt

测试和调试

编写单元测试来验证您的工具和提示是否按预期工作，然后使用日志记录和调试信息进行故障排除。

🤝 需要帮助？

• 提问：在 GitHub 上提出问题。
• 交流：加入我们的 Discord 社区（即将推出）。

由 ❤️ 制作，献给 AI 开发者社区