暂无图片
暂无图片
暂无图片
暂无图片
暂无图片

可以将任何符合OpenAPI规范的接口转 MCP Server吗?

alitrack 2025-05-21
443

 

前言

前面介绍了借助MCP,在聊天框里轻松实现增删改查, 核心就是把FastAPI封装的API直接转为MCP Server。
现实中有很多使用各种语言(框架)实现的API,我们有没有办法直接转为MCP Server,但不入侵代码?

开源BI Apache Superset 秒变MCP Server 就是提供了这样一个思路, 对我们感兴趣的功能进行二次封装。

另外我们注意到Superset 的公共 REST API 遵循 OpenAPI 规范[1],其文档使用 Swagger React UI[2] 生成。


Superset API
那么有没有办法把任何符合OpenAPI 规范的API 直接转为MCP Server呢? 带着这个问题,网上搜索了下,已经有多个项目在做这方面的研究了。

Swagger to MCP @GitHub

下面我会选择一个我熟悉的Python语言开发的把Swagger 转MCP Server的项目做简单介绍。

Swagger

Swagger Logo

在前后端分离开发的过程中,前端和后端需要进行api对接进行交互,就需要一个api规范文档,方便前后端的交互,但api文档不能根据代码的变化发生实时动态的改变,这样后端修改了接口,前端不能及时获取最新的接口,导致调用出错,需要手动维护api文档,加大了开发的工作量和困难,而swagger的出现就是为了解决这一系列的问题。

什么是Swagger

Swagger 是一种用于 设计、构建、文档化和使用 RESTful API 的开源工具集。它提供了一套标准化的规范(OpenAPI 规范,原称 Swagger 规范),帮助开发者更高效地开发、测试和集成 API。

Swagger 的核心组件

  1. 1. OpenAPI 规范(OAS)
    • • 一种与语言无关的标准化格式(YAML/JSON),用于描述 RESTful API 的结构,包括:
      • • 端点(URL 路径)
      • • 请求/响应格式(如 JSON、XML)
      • • 认证方式(如 OAuth2、API Key)
      • • 参数、数据类型、示例等。
  2. 2. Swagger 工具生态
    • • Swagger UI:自动生成交互式 API 文档,支持直接在浏览器中测试 API。
    • • Swagger Editor:基于浏览器的编辑器,用于编写 OpenAPI 定义文件。
    • • Swagger Codegen:根据 API 定义自动生成客户端代码(如 Java、Python)、服务端存根或文档。
    • • Swagger Hub(商业化平台):集成设计、文档化和协作工具。

Swagger 的主要用途

  1. 1. API 文档自动化
    • • 通过代码注释或定义文件自动生成可视化文档,避免手动维护。
    • • 示例:Spring Boot 集成 Swagger 后,可通过 http://localhost:8080/swagger-ui.html
       查看所有 API。
  2. 2. 前后端协作
    • • 前端开发者无需等待后端完成,直接通过 Swagger 文档模拟请求。
  3. 3. API 测试
    • • 通过 Swagger UI 直接发送请求并查看响应,无需 Postman 等工具。
  4. 4. 代码生成
    • • 根据 API 定义快速生成客户端 SDK,减少重复编码。

Swagger-MCP-Server

简介

Swagger-MCP-Server[3] 基于 Swagger 文档作为接口约束标准,允许用户通过自然语言方式与大模型(如 ChatGPT)对话,触发网站接口调用,完成数据的查询、分析和处理,具备即席分析、实时反馈等特点,为用户提供了全新的体验。

Swagger MCP Server 代码架构
  • • call_api
     就是调外部API
  • • get_all_interfaces
     从 OpenAPI 文档中获取所有 API 接口
  • • get_detail_interface
     根据描述匹配API

测试

if __name__ == "__main__":
    # Initialize and run the server
    # mcp.run(transport="stdio")
    mcp.run("sse")

  1. 2. 运行服务
export OPEN_API_URL=https://petstore.swagger.io/v2/swagger.json
python swagger_mcp.server.py

为了方便演示,就用swagger.io官方提供的例子,经典的宠物商店API

  1. 3. 前端演示


功能列表


获取宠物库存统计

使用起来是不是很方便?

引用链接

[1]
 OpenAPI 规范: https://swagger.io/specification/
[2]
 Swagger React UI: https://www.npmjs.com/package/swagger-ui-react

[3]
 Swagger-MCP-Server: https://github.com/maohuihua123/swagger-mcp-server

 


文章转载自alitrack,如果涉嫌侵权,请发送邮件至:contact@modb.pro进行举报,并提供相关证据,一经查实,墨天轮将立刻删除相关内容。

评论