MCP Server Template (Python)

一个用于构建模型上下文协议（MCP）服务器的Python模板。此模板帮助您快速创建可以注册并暴露工具和提示供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
m
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]:
    """
    您的工具描述 - 这将显示给AI。
    
    参数：
        param1: 第一个参数的描述
        param2: 第二个参数的描述
        
    返回值：
        包含结果的字典
    """
    # 您的工具逻辑在这里
    return {"result": "your result"}

添加一个提示

提示是AI模型可以访问的模板：

@mcp.prompt()
def your_prompt_name(param: str) -> str:
    """您的提示描述。"""
    return f"""
    您的格式化提示，插入了{param}。
    使用此结构化提示模板。
    """

📁 项目结构

src/                      # 源代码目录
├── main.py               # 包含工具和提示的服务器入口点
├── config.py             # 配置设置
├── utils/                # 工具函数
├── tools/                # 工具实现
└── resources/            # 资源定义
test/                     # 测试目录
pyproject.toml            # 包配置
Dockerfile                # Docker支持

🚢 部署选项

Docker部署

# 构建Docker镜像
docker build -t my-mcp-server .

# 运行容器
docker run -p 8080:8080 my-mcp-server

云部署

此模板设计用于与各种云平台良好配合：

• 在AWS、GCP或Azure上作为容器部署
• 在支持容器化应用的无服务器平台上运行
• 使用Kubernetes进行编排

🧪 开发指南

# 安装开发依赖
pip install -e ".[dev]"

# 运行测试
pytest

# 格式化代码
black src test
isort src test

# 运行代码检查
flake8 src test

❓ 需要帮助？

• 📚 MCP文档：modelcontextprotocol.io
• 🐛 提交问题：GitHub Issues
• 💬 社区：加入我们的Discord社区（链接即将发布）

---

为AI开发者社区制作 ❤️