mcpField
O
OpenAPI MCP Server

OpenAPI MCP Server

本地服务
github.com/3loc开发工具282 周前更新

关于 OpenAPI MCP Server

供开发者构建 MCP 服务的起始项目,含加法处理器示例,并支持 stdio、SSE 和 OpenAPI/REST 运行模式。

主要功能

  1. 01stdio 服务模式
  2. 02SSE 服务模式
  3. 03OpenAPI/REST 模式
  4. 04加法处理器示例
  5. 05Docker 运行配置

适用场景

  1. 01启动 MCP 服务实现
  2. 02试用 stdio、SSE 和 REST 模式

MCP 相关

这是一个 MCP 服务基础项目,支持 stdio 和 SSE 传输,并提供 OpenAPI/REST 端点。加法处理器示例展示了不同协议下的实现方式。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"openapi-mcp-server-3loc": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"compose"
]
}
}
}
启动命令docker run -i --rm compose

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
ocicompose

工具

还没有获取到工具列表

本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。

详细介绍

OpenAPI MCP 服务

这是一个骨架项目,可作为构建你自己的 MCP 服务的起点。示例加法函数展示了如何在全部三种协议中实现处理程序。

功能

当前实现状态:

  • ✅ 标准输入/输出(stdio)
  • ✅ 服务器发送事件(SSE)
  • ✅ OpenAPI/REST 端点

运行模式

此服务支持三种不同的运行模式,由 MODE 环境变量控制:

  • stdio:作为标准输入/输出服务运行
  • sse:作为服务器发送事件服务运行(端口 8001)
  • openapi:作为 OpenAPI/REST 服务运行(端口 8002)

构建和运行

使用 Docker Compose
  1. 构建容器:
docker compose build
  1. 运行指定服务:
# Run all services
docker compose up

# Run only SSE server
docker compose up sse-mcp-server

# Run only OpenAPI server
docker compose up openapi-mcp-server
直接使用 Docker

你也可以直接使用 Docker 运行此服务:

# Run in stdio mode
docker run -i --rm -e MODE=stdio 3loc/openapi-mcp-server

# Run in SSE mode
docker run -p 8001:8000 --rm -e MODE=sse 3loc/openapi-mcp-server

# Run in OpenAPI mode
docker run -p 8002:8000 --rm -e MODE=openapi 3loc/openapi-mcp-server

配置

可以使用 mcp.json 文件配置此服务。配置示例如下:

{
  "mcpServers": {
    "stdio-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "--rm", 
        "-i",
        "--name", "openapi-mcp-server",
        "-e", "MODE=stdio",
        "3loc/openapi-mcp-server"
      ]
    },
    "sse-mcp-server": {
      "url": "http://localhost:8001/sse"
    }
  }
}

开发

此项目为实现支持多种通信协议的 MCP 服务提供了基础。现在已实现全部三种模式(stdio、SSE 和 OpenAPI),你可以根据需要互换使用。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。