MCP Framework

🚀 MCP 框架開發指南

MCP（Model Context Protocol）是一個用於開發和部署智能應用的開源框架。它提供了統一的協議、工具和服務，能助力開發者快速構建高效的應用程序。

✨ 主要特性

• 統一協議：提供標準化接口，便於不同組件之間的通信。
• 模塊化設計：支持插件擴展，可根據需求靈活定製。
• 高性能：基於異步框架，處理大規模請求遊刃有餘。
• 內置工具：集成了文檔處理、數據分析等常用功能。

📦 項目結構

MCP 框架目錄結構
├── mcp/types.py          # 定義內容類型和接口
├── tools/                # 工具實現
│   ├── base_tool.py      # 工具基類定義
│   └── specific_tool.py  # 具體工具實現
└── server.py             # MCP 服務器實現

🚀 快速開始

安裝依賴

pip install mcp[all]  # 安裝所有依賴項
# 或者按需安裝：
pip install pyMuPDF python-docx pandas openpyxl httpx anyio click

啟動服務

uv run mcp.server --transport sse --port 8000

訪問 SSE 端點：http://localhost:8000/sse

📚 詳細文檔

MCP 協議

MCP 定義了一套標準化協議，用於不同組件之間的交互。核心內容包括：

• 內容類型：

  • 文本內容 (types.TextContent)
  • 圖像內容 (types.ImageContent)
  • 嵌入式資源 (types.EmbeddedResource)

• 通信協議：

  • 使用 Server-Sent Events (SSE) 進行即時通信
  • 支持 HTTP/HTTPS 協議棧

工具開發指南

開發新工具

1. 在 tools 目錄下創建新的 Python 文件，例如 your_tool.py
2. 導入必要的依賴和基類：

   import mcp.types as types
   from . import BaseTool, ToolRegistry
   

3. 創建繼承自 BaseTool 的工具類：

   @ToolRegistry.register
   class YourTool(BaseTool):
       """您的工具描述"""
       name = "your_tool_name"  # 工具的唯一標識符
       description = "您的工具描述"  # 工具的描述信息，將顯示給用戶
       input_schema = {
           "type": "object",
           "required": ["param1"],  # 必需的參數
           "properties": {
               "param1": {
                   "type": "string",
                   "description": "參數1的描述",
               },
               "param2": {
                   "type": "integer",
                   "description": "參數2的描述（可選）",
               }
           },
       }
   
   async def execute(self, arguments: dict) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
       """執行工具邏輯"""
       # 參數驗證
       if "param1" not in arguments:
           return [types.TextContent(
               type="text",
               text="Error: Missing required parameter"
           )]
       
       # 處理邏輯
       result = self._process_arguments(arguments)
       
       return [types.TextContent(
           type="text",
           text=str(result)
       )]
   

部署指南

環境要求

• 操作系統：Linux, macOS, Windows (推薦使用 Linux)
• Python 版本：3.8+

安裝依賴

pip install mcp[all]  # 安裝所有依賴項
# 或者按需安裝：
pip install pyMuPDF python-docx pandas openpyxl httpx anyio click

啟動服務

uv run mcp.server --transport sse --port 8000

訪問 SSE 端點：http://localhost:8000/sse

配置指南

基本配置

編輯 config.py 文件：

from mcp.config import Config

Config.load_defaults()
# 或者自定義配置：
Config.set('debug_mode', True)

進階配置

通過命令行參數進行配置：

uv run mcp.server --config your_config.yaml --port 8000

依賴管理

MCP 框架依賴以下庫：

• PyMuPDF：用於 PDF 文檔處理
• python-docx：用於 Word 文檔處理
• pandas：用於數據分析
• openpyxl：用於 Excel 文件操作
• httpx：用於 HTTP 請求
• anyio：用於異步編程
• click：用於命令行工具

貢獻指南

提交代碼

1. Fork 項目倉庫
2. 創建新分支 (git checkout -b feature/your-feature)
3. 提交更改 (git add .; git commit -m "your commit message")
4. Push 到遠程倉庫
5. 創建 Pull Request

開發規範

• 遵循 PEP8 代碼風格指南
• 提供詳細的文檔說明
• 包括單元測試用例
• 確保代碼通過 CI/CD 測試

聯繫方式

• GitHub：mcp-framework
• 郵件列表：dev@mcpframework.org
• 中文社區：mcp-discuss-cn

📄 許可證

MCP 框架遵循 MIT License，具體條款見 LICENSE 文件。