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、擴展，併為改進貢獻您的力量！