Swagger Viewer

Name: Swagger Viewer
Author: xiezhuo0513

本地服务

github.com/xiezhuo0513开发工具079 周前更新

代码仓库

关于 Swagger Viewer

Swagger Viewer 是面向 Cursor 的 MCP 工具，可读取并监控 Swagger API 文档配置。它支持搜索接口、查看接口列表并生成调用代码。

主要功能

01读取 swagger.json 配置
02监控配置变化并重载文档
03模糊搜索 API 接口
04生成接口调用代码
05列出全部可用接口

适用场景

01查找与关键词匹配的 API 接口
02查看项目可用接口清单
03为选定接口生成调用代码

MCP 相关

它向 Cursor 等 MCP 客户端提供初始化、搜索接口、生成代码和获取接口列表的工具。

配置

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

mcp.json · 通用配置

{
  "mcpServers": {
    "swagger-viewer": {
      "command": "npx",
      "args": [
        "-y",
        "@xc_angelwatch/swagger-viewer"
      ]
    }
  }
}

启动命令npx -y @xc_angelwatch/swagger-viewer

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

安装包

npm@xc_angelwatch/swagger-viewerstdio

工具

收录的工具列表 · 更新于 3 周前

参数	类型	必填	说明
swaggerUrl	string	是	Swagger 文档的 URL

详细介绍

来自项目 README

Swagger Viewer MCP 工具

这是一个用于 Cursor 编辑器的 MCP 工具，可以帮助你快速查看和使用 Swagger API 文档。

功能特点

自动读取用户根目录下的 swagger.json 配置文件
实时监控配置文件变化，自动更新 API 文档
支持模糊搜索 API 接口
自动生成接口调用代码
支持查看所有可用接口

安装

npm install

配置

在用户根目录下创建 swagger.json 文件，格式如下：

{
    "swaggerUrl": "https://your-swagger-api-url/swagger.json"
}

npx：

"swagger-viewer": {
      "command": "cmd",
      "swagger-viewer": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@xc_angelwatch/swagger-viewer"]
    }
}

使用方法

该工具提供以下 MCP 接口：

mcp_swagger_initialize(): 初始化工具，加载配置
mcp_swagger_search(query): 搜索接口
mcp_swagger_generate_code(path, method, language): 生成接口调用代码
mcp_swagger_get_all_endpoints(): 获取所有可用接口

示例用法

// 初始化
await mcp_swagger_initialize();

// 搜索包含 "user" 的接口
const results = await mcp_swagger_search("user");

// 生成特定接口的代码
const code = await mcp_swagger_generate_code("/api/users", "GET", "javascript");

// 获取所有接口
const endpoints = await mcp_swagger_get_all_endpoints();