MCP服务器模板

一个用于快速构建模型上下文协议(MCP)服务器的Python模板,支持注册和暴露工具及提示供AI模型使用。

  • by Nisarg38
  • Python
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 Nisarg38/mcp-server-template

使用说明

MCP服务器模板(Python)

用于在Python中构建模型上下文协议(MCP)服务器的现成模板。此模板可帮助您快速创建可以注册和公开AI模型使用的工具和提示的服务器。

📚 目录

🚀 快速开始

先决条件

  • Python 3.10或更新版本

通过3个简单步骤进行设置

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

❓ 需要帮助?


由以下材料制成❤️ 面向AI开发者社区