Swagger MCP Tools

MCP开发工具

提供方 dyq086 · 包名 swagger-mcp-tools

开发工具 stdio · 本地进程 Token 社区 / 第三方 Claude DesktopClaudeCursor
查看接入方式

一个用于Cursor等MCP客户端的Swagger/OpenAPI文档查询工具,支持浏览、搜索API文档及获取接口类型信息,提高开发效率。

一句话选型结论

按资料字段整理

Swagger MCP Tools 属于开发工具类 MCP 服务器,stdio · 本地进程,Token,可直接接入 Claude Desktop、Claude、Cursor,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式stdio · 本地进程 鉴权Token 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 3 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量3暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

API文档TypeScript本地部署开发工具SwaggerOpenAPIMCP协议

安装与配置

stdio · 本地进程 Token
客户端在本机拉起子进程,数据不出本机
npx swagger-mcp-tools

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 3 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 3 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Swagger MCP Tools当前 3 stdio · 本地进程 本地部署 有 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方dyq086上游标注的维护方 dyq086
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时swagger-mcp-tools · Node.js本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

7.5 KB
来自项目仓库与上游目录的原文,未做删改

swagger-mcp-tools

一个用于 Cursor 等 MCP (Model Context Protocol) 客户端的 Swagger/OpenAPI 文档查询工具。通过 MCP 协议,AI 助手可以轻松查询和分析 Swagger API 文档,获取接口类型信息。

简介

swagger-mcp-tools 是一个 MCP 服务器,它可以将 Swagger/OpenAPI 文档转换为 MCP 工具,让 AI 助手(如 Cursor)能够:

  • 📚 浏览和搜索 API 文档
  • 🔍 查询接口的详细类型信息
  • 💡 在编写代码时获取准确的 API 类型定义
  • 🚀 提高开发效率,减少查阅文档的时间

功能特性

  • 🔍 模块查询 - 获取 Swagger API 的所有模块列表
  • 📋 接口列表 - 获取指定模块下的所有接口
  • 📝 类型信息 - 获取接口的详细类型信息(参数、请求体、响应类型)
  • 🔄 多格式支持 - 支持 Swagger 2.0 和 OpenAPI 3.0 格式
  • ⚙️ 灵活配置 - 支持配置文件、环境变量等多种配置方式

安装

方式一:使用 npx(推荐,无需安装)

无需全局安装,直接使用 npx 运行:```bash

无需安装,直接使用 npx

npx swagger-mcp-tools


### 方式二:全局安装

如果需要全局安装:```bash
npm install -g swagger-mcp-tools
# 或
yarn global add swagger-mcp-tools

方式三:从源码构建```bash

git clone https://github.com/dyq086/swagger-mcp-tools.git
cd swagger-mcp-tools
npm install
npm run build


构建完成后,可以使用以下方式运行:```bash
# 直接运行构建后的文件
node dist/mcp-server.js

# 或使用 npm link 进行本地开发
npm link
swagger-mcp-tools

使用方法

1. 配置 Cursor MCP

在 Cursor 的 MCP 配置文件中(通常是 ~/.cursor/mcp.json 或项目根目录的 .cursor/mcp.json)添加:```json
{
"mcpServers": {
"swagger": {
"command": "npx",
"args": ["swagger-mcp-tools@latest"],
"env": {
"SWAGGER_URL": "http://your-api.com/v3/api-docs",
"SWAGGER_TOKEN": "your-token-here"
}
}
}
}


### 2. 使用配置文件(推荐)

在项目根目录创建 `.swagger-mcp.json`:```json
{
"swaggerUrl": "http://your-api.com/v3/api-docs",
"token": "your-token-here"
}

然后在 MCP 配置中使用:```json
{
"mcpServers": {
"swagger": {
"command": "npx",
"args": ["swagger-mcp-tools@latest"]
}
}
}


## 配置优先级

配置加载优先级从高到低:

1. **项目配置文件** - `.swagger-mcp.json` 或 `swagger-mcp.config.json`
- 项目根目录查找优先级:
1. 环境变量 `SWAGGER_MCP_PROJECT_ROOT` 指定的目录(如果设置)
2. Cursor/IDE 环境变量 `WORKSPACE_FOLDER_PATHS`(自动获取,无需配置)
3. 从 `process.cwd()`(当前工作目录)向上查找(**默认,动态获取**)
4. 从模块目录向上查找
2. **默认环境变量** - `SWAGGER_URL` 和 `SWAGGER_TOKEN`

**项目根目录环境变量说明:**
- `SWAGGER_MCP_PROJECT_ROOT`(可选):
- **未设置**:自动使用 `WORKSPACE_FOLDER_PATHS` 或 `process.cwd()`,动态获取,无需配置
- `$CWD` 或 `$PWD`:显式使用当前工作目录
- 绝对路径:`/path/to/project`
- 相对路径:相对于当前工作目录的路径
- `WORKSPACE_FOLDER_PATHS`(自动,无需配置):
- Cursor 等 IDE 会自动提供此环境变量,指向当前打开的工作区路径
- 如果存在,会自动使用第一个路径作为项目根目录

## 使用示例

### 在 Cursor 中使用

1. 在项目根目录创建 `.swagger-mcp.json`:```json
{
"swaggerUrl": "http://localhost:8080/v3/api-docs",
"token": "your-api-token"
}
  1. 配置 Cursor MCP(~/.cursor/mcp.json 或项目 .cursor/mcp.json):```json
    {
    "mcpServers": {
    "swagger": {
    "command": "npx",
    "args": ["swagger-mcp-tools@latest"]
    }
    }
    }

3. 重启 Cursor,现在你可以在 AI 对话中询问 API 相关信息了!

> 💡 **提示**:使用 `npx` 方式无需全局安装,npx 会自动下载并使用最新版本的包。

### 示例对话

- "获取用户管理模块的所有接口"
- "查询 `/api/user/list` 接口的参数类型"
- "获取订单创建接口的请求体结构"

## 可用工具

### getModules

获取 Swagger API 的所有模块列表。

**返回示例:**```json
[
{
"name": "用户管理",
"description": "用户相关的接口"
},
{
"name": "订单管理",
"description": "订单相关的接口"
}
]

getApis

获取指定模块下的所有接口列表。

参数:
- module (string) - 模块名称

返回示例:```json
[
{
"path": "/api/user/list",
"method": "GET",
"summary": "获取用户列表"
},
{
"path": "/api/user/create",
"method": "POST",
"summary": "创建用户"
}
]


### getApi

获取指定接口的参数和返回值类型信息。

**参数:**
- `path` (string) - 接口路径,如 `/api/user/list`
- `method` (string) - HTTP 方法,如 `GET`, `POST`, `PUT`, `DELETE`

**返回示例:**```json
{
"path": "/api/user/list",
"method": "GET",
"summary": "获取用户列表",
"description": "分页查询用户列表",
"parameters": [
{
"name": "page",
"in": "query",
"type": "integer",
"required": false
}
],
"requestBody": null,
"responseType": {
"type": "object",
"properties": {
"code": { "type": "integer" },
"data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }
}
}
}

开发

本地开发```bash

安装依赖

npm install

开发模式运行(使用 tsx 直接运行 TypeScript)

npm run dev

构建为 JavaScript

npm run build


### 测试

在开发模式下,MCP 服务器通过 stdio 通信,日志会输出到 stderr。你可以通过以下方式测试:```bash
# 设置环境变量
export SWAGGER_URL="http://your-api.com/v3/api-docs"
export SWAGGER_TOKEN="your-token"

# 运行服务器
npm run dev

发布```bash

构建项目

npm run build

发布到 npm(需要先登录)

npm login
npm publish


### 项目结构```
swagger-mcp-tools/
├── mcp-server.ts    # 主服务器文件
├── types.ts         # TypeScript 类型定义
├── package.json     # 项目配置
├── tsconfig.json    # TypeScript 配置(用于 IDE)
├── README.md        # 说明文档
├── CHANGELOG.md     # 变更日志
├── LICENSE          # MIT 许可证
├── .gitignore       # Git 忽略文件
└── dist/            # 构建输出目录
└── mcp-server.js # 构建后的 JavaScript 文件

常见问题

Q: 如何查看服务器是否正常运行?

A: MCP 服务器通过 stdio 通信,日志会输出到 stderr。如果配置正确,你应该能看到类似以下的日志:Swagger MCP Server running on stdio Swagger URL: http://your-api.com/v3/api-docs Token: *** (已设置)

Q: 支持哪些 Swagger/OpenAPI 版本?

A: 支持 Swagger 2.0 和 OpenAPI 3.0 格式。

Q: 如何处理认证?

A: 支持通过配置文件或环境变量设置 token。如果 API 需要认证,请在配置中设置 token 或 SWAGGER_TOKEN。

Q: 可以在其他 MCP 客户端中使用吗?

A: 可以。只要支持 MCP 协议的客户端都可以使用,包括 Cursor、Claude Desktop 等。

许可证

MIT License

贡献

欢迎提交 Issue 和 Pull Request!

贡献指南

  1. Fork 本项目
  2. 创建特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启 Pull Request

相关链接

  • GitHub 仓库
  • npm 包
  • Model Context Protocol 文档
  • Swagger 文档
  • OpenAPI 规范

Star History

如果这个项目对你有帮助,欢迎给个 ⭐️ Star!

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Swagger MCP Tools 怎么安装?

在客户端按下面的安装命令接入:npx swagger-mcp-tools。对应的包名是 swagger-mcp-tools。装完在客户端配置里引用同一个包或端点。

Swagger MCP Tools 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Swagger MCP Tools 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Swagger MCP Tools 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

Swagger MCP Tools 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Swagger MCP Tools 能提供哪些能力?

资料显示约 3 个工具;能力标签包括 API文档、开发工具、TypeScript、Claude、API集成。具体工具清单以官方文档为准。

Swagger MCP Tools 需要什么运行环境?

运行时为 Node.js;属于本地进程,需要在本机装好运行环境。

Swagger MCP Tools 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。