OpenAPI MCP Server

OpenAPI MCP Server

site icon
2025.04.03 1
Python多协议通信服务器框架其它
OpenAPI MCP Server 是一个基础项目,可作为构建自定义 MCP 服务器的起点。它支持多种通信协议,包括标准 I/O (stdio)、服务器发送事件 (SSE) 和 OpenAPI/REST 端点。该项目提供了一个功能实现示例,展示了如何跨所有三种协议实现处理程序。
View on GitHub

Overview

基本能力

产品定位

OpenAPI MCP Server 是一个多协议通信服务器框架,旨在为开发者提供一个快速构建和部署 MCP 服务器的起点。

核心功能

  • 支持三种运行模式:
  • 标准 I/O (stdio)
  • 服务器发送事件 (SSE)
  • OpenAPI/REST 端点
  • 提供示例功能实现,展示跨协议处理程序的设计。

适用场景

  • 需要快速搭建 MCP 服务器的开发项目。
  • 需要支持多种通信协议的应用场景。
  • 作为学习 MCP 服务器开发的示例项目。

工具列表

  • Docker Compose:用于构建和运行服务。
  • Docker:直接运行服务器。
  • mcp.json 配置文件:用于服务器配置。

常见问题解答

  • 如何切换运行模式?通过设置 MODE 环境变量为 stdiosseopenapi
  • 如何配置服务器?使用 mcp.json 文件进行配置。

使用教程

使用依赖

确保已安装 Docker 和 Docker Compose。

安装教程

  1. 使用 Docker Compose 构建容器:
docker compose build
  1. 运行特定服务:
# 运行所有服务
docker compose up

# 仅运行 SSE 服务器
docker compose up sse-mcp-server

# 仅运行 OpenAPI 服务器
docker compose up openapi-mcp-server

使用 Docker 直接运行

# 运行在 stdio 模式
docker run -i --rm -e MODE=stdio 3loc/openapi-mcp-server

# 运行在 SSE 模式
docker run -p 8001:8000 --rm -e MODE=sse 3loc/openapi-mcp-server

# 运行在 OpenAPI 模式
docker run -p 8002:8000 --rm -e MODE=openapi 3loc/openapi-mcp-server

调试方式

  1. 检查服务日志:
docker compose logs
  1. 验证服务运行状态:
docker ps
  1. 测试 API 端点(如 OpenAPI 模式):
curl http://localhost:8002/

许可证

None