Swagger MCP Server

🚀 Swagger MCP サーバー

このサーバーは、Model Context Protocol (MCP) をベースに構築されており、Swagger/OpenAPI ドキュメントを解析し、TypeScript 型定義と API クライアントコードを生成します。

🚀 クイックスタート

サーバーの起動

node start-server.js

MCP Inspector の接続

デバッグサーバーを起動した後、以下のコマンドを使用して接続できます。

npx @modelcontextprotocol/inspector pipe -- node start-server.js

または、直接接続する方法もありますが、出力が混乱する可能性があります。

npx @modelcontextprotocol/inspector -- node start-server.js

✨ 主な機能

• Swagger および OpenAPI ドキュメントを解析し、TypeScript 型定義と API クライアントコードを生成します。
• Axios、Fetch、React Query などの複数のクライアントフレームワークをサポートしています。
• 大型 API ドキュメントを処理するための最適化機能を備えています。

📦 インストール

Smithery を通じたインストール

Smithery を通じて、Claude Desktop 用に swagger-mcp-server を自動インストールするには、以下のコマンドを実行します。

npx -y @smithery/cli install @tuskermanshu/swagger-mcp-server --client claude

💻 使用例

基本的な使用法

サーバー起動

node start-server.js

MCP Inspector 接続

npx @modelcontextprotocol/inspector pipe -- node start-server.js

高度な使用法

大型ドキュメントの処理

{
  "method": "parse-swagger-lite",
  "params": {
    "url": "https://your-large-api-doc-url.json",
    "useCache": true,
    "skipValidation": true,
    "lazyLoading": true,
    "filterTag": "your-specific-tag",
    "includeSchemas": false
  }
}

React Query クライアントの生成

{
  "method": "generate-api-client-optimized",
  "params": {
    "swaggerUrl": "https://petstore3.swagger.io/api/v3/openapi.json",
    "outputDir": "./generated/react-query",
    "clientType": "react-query",
    "generateTypeImports": true
  }
}

📚 ドキュメント

サポートされる MCP ツール

1. parse-swagger - Swagger/OpenAPI ドキュメントを解析し、API 操作情報を返します。
2. parse-swagger-optimized - Swagger/OpenAPI ドキュメントを解析します（最適化版）。
3. parse-swagger-lite - 軽量な Swagger/OpenAPI ドキュメント解析ツールで、大型ドキュメント向けに最適化されています。
4. generate-typescript-types - Swagger/OpenAPI ドキュメントから TypeScript 型定義を生成します。
5. generate-typescript-types-optimized - Swagger/OpenAPI ドキュメントから TypeScript 型定義を生成します（最適化版）。
6. generate-api-client - Swagger/OpenAPI ドキュメントから API クライアントコードを生成します。
7. generate-api-client-optimized - Swagger/OpenAPI ドキュメントから API クライアントコードを生成します（最適化版）。
8. file-writer - 内容をファイルシステムに書き込みます。

サポートされるクライアントフレームワーク

• Axios: 機能が豊富な Promise ベースの HTTP クライアントです。
• Fetch: ブラウザの標準 API で、追加の依存関係が不要です。
• React Query: React アプリケーション用のデータ取得とキャッシュライブラリで、hooks とキャッシュ機能を提供します。

キャッシュ管理

API ドキュメントのキャッシュは .api-cache ディレクトリに保存されます。キャッシュをクリアするには、このディレクトリを削除するか、useCache: false パラメータを設定します。

設定オプション

swagger-mcp-config.json でサーバーの設定をカスタマイズできます。

{
  "name": "Swagger MCP Server",
  "version": "1.0.0",
  "transport": "stdio"
}

プロジェクトの構築

# npm を使用して構築
npm run build

# または pnpm を使用
pnpm build

プロジェクトロードマップ

開発計画と進捗状況については、road.md ファイルを参照してください。