Basemcpserver

🚀 基礎服務器 Docker 鏡像

本基礎鏡像專為運行 MCP 服務器量身打造，支持通過 HTTP 以及標準輸入輸出（stdin/stdout）進行通信。它基於 Python 實現，依託 Starlette 框架和 Uvicorn 服務器構建，為 MCP 服務器的運行提供了高效且穩定的基礎環境。

🚀 快速開始

運行示例

使用 Docker

1. 下載鏡像：

docker pull yourusername/base-mcp-server:latest

2. 運行容器（HTTP 模式）：

docker run -p 7501:7501 yourusername/base-mcp-server:latest

3. 或運行標準輸入輸出模式：

docker run --rm -it yourusername/base-mcp-server:latest stdio

使用構建腳本

./build.sh build

示例項目結構

your-project/
├── requirements.txt                 # 項目依賴
├── Dockerfile                       # Docker 文件
├── config.py                        # 配置文件
└── your_server.py                   # 服務器實現

✨ 主要特性

• 雙通信模式支持：
  • HTTP/SSE：藉助 HTTP 協議實現 Server-Sent Events (SSE) 通信，為服務器與客戶端之間的數據傳輸提供了高效且即時的解決方案。
  • 標準輸入輸出（_stdio）：允許直接通過 stdin 和 stdout 進行通信，為特定場景下的交互提供了便利。
• 自動化 API 文檔與測試界面：提供自動化的 API 文檔生成功能，同時配備交互式測試界面，方便開發者進行 API 的調試和測試。

📦 安裝指南

安裝

1. 下載鏡像：

docker pull yourusername/base-mcp-server:latest

2. 運行容器（HTTP 模式）：

docker run -p 7501:7501 yourusername/base-mcp-server:latest

3. 或運行標準輸入輸出模式：

docker run --rm -it yourusername/base-mcp-server:latest stdio

配置

環境變量

• HOST：綁定的接口，默認值為 0.0.0.0。
• PORT：監聽的端口，默認值為 7501。
• API_KEY：必填項，用於身份驗證。
• SERVER_NAME：服務器的唯一標識符。

配置方法

1. 使用命令行環境變量：

docker run -p 7501:7501 \
  -e API_KEY=your_api_key \
  -e SERVER_NAME=your-mcp-server \
  yourusername/your-mcp-server:latest

2. 使用環境文件：

創建 .env 文件：

API_KEY=your_api_key
SERVER_NAME=your-mcp-server
HOST=0.0.0.0
PORT=7501

運行時指定環境文件：

docker run -p 7501:7501 --env-file .env yourusername/your-mcp-server:latest

3. 使用 Docker Secrets：

配置秘密：

docker secret create api_key your_api_key

運行時引用秘密：

docker run -p 7501:7501 -e API_KEY=$(docker secret inspect --format='{{.Data}}' api_key) yourusername/your-mcp-server:latest

💻 使用示例

基礎用法

通過 Docker 運行容器的基礎命令示例：

docker run -p 7501:7501 yourusername/base-mcp-server:latest

高級用法

擴展服務器功能

通過繼承 BaseMCPServer 類，可輕鬆擴展服務器功能：

from base_mcp_server import BaseMCPServer

class MyMCPServer(BaseMCPServer):
    def __init__(self, config):
        super().__init__(config)
        # 添加自定義初始化代碼

自動化文檔生成

啟動服務器後，訪問 http://localhost:7501/docs 即可查看自動化的 API 文檔。

交互式測試界面

啟動服務器後，訪問 http://localhost:7501/test 可進行交互式測試。

🔧 技術細節

核心組件

• Starlette：作為輕量級 ASGI 框架，負責處理 HTTP 請求，為服務器的高效運行提供了有力支持。
• Uvicorn：作為 ASGI 服務器，用於運行 Starlette 應用，確保服務器的高性能和穩定性。
• Python 原生 I/O：在標準輸入輸出模式下發揮作用，實現與外部的交互。

⚠️ 安全注意事項

• 環境變量：敏感信息（如 API 密鑰）不應直接通過環境變量傳遞，建議使用 Docker Secrets 來保障信息安全。
• 網絡訪問：默認情況下，容器會綁定到所有接口 (HOST=0.0.0.0)，在生產環境中，請務必設置適當的網絡安全策略，以防止潛在的安全風險。

📄 許可證

本項目遵循 MIT 許可證。
版權所有 (c) 2024, Your Name.