Swagger MCP服务

一个通过Model Context Protocol暴露Swagger/OpenAPI端点供AI代理访问的服务工具。

  • by marcin-sucharski
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 marcin-sucharski/swagger-mcp-server

使用说明

Swagger MCP服务器

Swagger/OpenAPI端点的模型上下文协议服务器。此工具允许您通过模型上下文协议公开Swagger定义的API,使其可供AI代理访问。

安装

您可以全局安装该软件包:

npm install -g swagger-mcp-server

或者直接与npx一起使用:

npx swagger-mcp-server <config-file>

用法

  1. 创建一个配置文件(JSON),定义要公开的Swagger端点:
{
  "endpoints": [
    {
      "name": "example-api",
      "url": "https://example.com/api/swagger.json"
    }
  ]
}
  1. 运行服务器:
swagger-mcp-server config.json

或者使用npx:

npx swagger-mcp-server config.json

配置选项

配置文件支持以下选项:

  • endpoints:要公开的Swagger端点数组
    • name:端点的唯一标识符
    • url:Swagger/OpenAPI JSON定义的URL

发展

要构建项目,请执行以下操作:

npm run build

要在本地运行:

npm run run

许可证

国际协调委员会