mcpField
S
Swagger Viewer

Swagger Viewer

ローカル
github.com/xiezhuo0513開発ツール079 週間前に更新

Swagger Viewer について

Swagger Viewerは、Cursor向けのMCPツールです。Swagger APIドキュメントを読み込み、変更を監視しながら、エンドポイント検索や呼び出しコード生成を行えます。

主な機能

  1. 01swagger.json設定の読み込み
  2. 02設定変更の監視と再読み込み
  3. 03APIエンドポイントのあいまい検索
  4. 04API呼び出しコードの生成
  5. 05利用可能なエンドポイント一覧

活用シーン

  1. 01条件に合うAPIエンドポイントの検索
  2. 02プロジェクト内の全エンドポイントの確認
  3. 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-viewer

ツール

4

掲載時のツール一覧 · 3 週間前に更新

パラメーター型必須説明
swaggerUrlstringはい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 接口:

  1. mcp_swagger_initialize(): 初始化工具,加载配置
  2. mcp_swagger_search(query): 搜索接口
  3. mcp_swagger_generate_code(path, method, language): 生成接口调用代码
  4. 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();

配置文件监控

工具会自动监控用户根目录下的 swagger.json 文件变化。当文件发生变化时,会自动重新加载最新的 API 文档。

支持的编程语言

目前支持生成以下语言的代码:

コメント

MCP は初めてですか?

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。