MCP Server Boilerplate

🚀 MCP 基础

MCP 基础是一个用于构建 Model Context Protocol (MCP) 服务器的生产就绪、可扩展模板。借助 Python，你可以快速创建、扩展和部署 MCP 服务器，将工具、提示和资源暴露给大语言模型（LLM）和代理客户端。

🚀 快速开始

克隆仓库

git clone [仓库地址]
cd mcp-base

安装依赖

pip install -r requirements.txt

配置环境

复制 .env.example 到 .env 并填写所需的值。

启动服务器

python src/server.py

✨ 主要特性

• 多传输支持：支持 STDIO、SSE、HTTP 等（见 /src/transports/）
• 模块化工具/提示/资源：添加新功能只需创建一个类并注册即可
• 类型安全的输入验证：使用 Pydantic 进行模式匹配
• 最佳安全性实践：文件和进程沙盒化，防止未授权访问
• 快速部署：支持 Docker 容器化，简化生产环境部署

📦 安装指南

克隆仓库

git clone [仓库地址]
cd mcp-base

安装依赖

pip install -r requirements.txt

配置环境

复制 .env.example 到 .env 并填写所需的值。

启动服务器

python src/server.py

💻 使用示例

基础用法

创建新工具

在 src/tools/ 目录下创建一个新工具类：

class NewTool:
    def __init__(self):
        self.name = "NewTool"

    def execute(self, command):
        # 实现具体逻辑
        pass

注册工具到 config.py：

TOOLS = [
    NewTool()
]

高级用法

通过继承基础类并实现自定义行为，轻松扩展服务器功能。

📚 详细文档

基础使用

了解如何启动和配置 MCP 基础服务器。

高级主题

探索自定义传输层、扩展功能模块等高级用法。

🔧 技术细节

架构概述

.
├── src/
│   ├── base/                # 基础类，用于工具、提示和资源
│   ├── tools/               # 示例工具（文件系统、API、提示等）
│   ├── resources/           # 示例资源（静态/动态）
│   ├── prompts/             # 示例提示（文本生成、摘要等）
│   ├── transports/          # 传输层实现及文档
│   │   ├── stdio/
│   │   │   └── README.md
│   │   ├── sse/
│   │   │   └── README.md
│   │   └── ...
│   ├── config.py            # 配置和环境管理
│   ├── server.py            # 服务器实例化与注册
│   └── main.py              # 入口点：选择传输层，启动服务器
├── tests/                   # 工具/资源示例测试
├── Dockerfile               # 容器化部署文件
├── requirements.txt / pyproject.toml
├── README.md                # 本文件
├── CONTRIBUTING.md
└── ...

安全与最佳实践

• 进程隔离：使用沙盒化技术保护主进程。
• 日志记录：集成结构化日志记录，便于排查问题。
• 依赖管理：使用 requirements.txt 管理所有第三方库。

🚀 贡献与支持

欢迎 fork 本项目！我们鼓励您提交 pull request 或 issue 来改进 MCP Base。

💬 社区与支持

加入我们的社区，获取更多帮助和支持：

• Discord：链接
• Reddit：链接
• GitHub 讨论：链接

MCP Base 是所有新 Python MCP 服务器项目的推荐起点。欢迎 fork、扩展，并为改进贡献您的力量！