MCP Server Template (Python)

MCP Server Template（Python）

用于在 Python 中构建 Model Context Protocol（MCP）服务的即用型模板。借助此模板，你可以快速创建能够注册并公开供 AI 模型使用的工具和提示词的服务。

📚 目录

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

🚀 快速开始

前置条件

• Python 3.10 或更高版本

轻松三步完成设置

1️⃣ 安装软件包

# Clone the repository
git clone https://github.com/nisarg38/mcp-server-template-python.git my-mcp-server
cd my-mcp-server

# Install in development mode
pip install -e ".[dev]"

2️⃣ 运行服务

# Run with Python
python -m src.main

# Or use the convenient CLI
mcp-server-template

3️⃣ 服务现已上线！

访问你的 MCP 服务：

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

你将看到日志输出，确认服务已成功运行。

🎮 命令行选项

使用以下命令行选项自定义服务行为：

# Change port (default: 8080)
mcp-server-template --port 9000

# Enable debug mode for more detailed logs
mcp-server-template --debug

# Use stdio transport instead of HTTP
mcp-server-template --transport stdio

# Set logging level (options: 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]:
    """
    Your tool description - this will be shown to the AI.
    
    Args:
        param1: Description of first parameter
        param2: Description of second parameter
        
    Returns:
        Dictionary with your results
    """
    # Your tool logic here
    return {"result": "your result"}

添加提示词

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

@mcp.prompt()
def your_prompt_name(param: str) -> str:
    """Your prompt description."""
    return f"""
    Your formatted prompt with {param} inserted.
    Use this for structured prompt templates.
    """

📁 项目结构

src/                      # Source code directory
├── main.py               # Server entry point with tools & prompts
├── config.py             # Configuration settings
├── utils/                # Utility functions
├── tools/                # Tools implementation
└── resources/            # Resource definitions
test/                     # Tests directory
pyproject.toml            # Package configuration
Dockerfile                # Docker support

🚢 部署选项

Docker 部署

# Build the Docker image
docker build -t my-mcp-server .

# Run the container
docker run -p 8080:8080 my-mcp-server

云端部署

此模板旨在与各种云平台良好配合：

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

🧪 开发指南

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Format code
black src test
isort src test

# Run linting
flake8 src test

❓ 需要帮助？

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

---

为 AI 开发者社区倾心打造 ❤️