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.