MCP Swagger Server

🚀 MCP Swagger サーバー

このサーバーは、Swagger/OpenAPI ドキュメントへのアクセスを提供し、規格に基づいた API リクエストを行う MCP サーバーです。

✨ 主な機能

• URL から Swagger ドキュメントを読み込む
• Swagger 規格に基づいて API リクエストを行う
• API キーによる認証をサポートする
• Swagger 規格をキャッシュしてパフォーマンスを向上させる
• リクエストが Swagger 規格に準拠しているか検証する

📦 インストール

依存関係のインストール

npm install

TypeScript コードのビルド

npm run build

🚀 クイックスタート

開発モードでの実行

npm run dev

本番モードでの実行

npm run start

📚 ドキュメント

サーバーの構成

サーバーは以下の環境変数が必要です。

利用可能なリソースとツール

リソース：swagger-doc

• URI：swagger://documentation
• 説明：完全な Swagger ドキュメントを取得する

ツール：makeRequest

Swagger 規格に基づいて API リクエストを行います。

コード例

const result = await mcp.tools.makeRequest({
  path: "/api/users",
  method: "GET",
  parameters: { userId: "123" }
});

Smithery.ai へのデプロイ

このサーバーは Smithery.ai でのデプロイ用に構成されています。デプロイには以下が必要です。

1. サーバーのビルドと実行を行う Dockerfile
2. smithery.yaml 構成ファイル
3. 正しい TypeScript ビルド設定

構成設定

Smithery.ai でサーバーを構成する際は、以下の内容を使用してください。

{
  "swaggerUrl": "https://api.example.com/swagger.json",
  "authKey": "your-api-key"  // オプション
}

ローカルでのテストと Smithery

1. Docker イメージをビルドする

docker build -t mcp-swagger .

2. コンテナを実行する

docker run -e SWAGGER_URL=your-swagger-url -e AUTH_KEY=your-auth-key mcp-swagger

開発用スクリプト

• npm run build：TypeScript コードをビルドする
• npm run start：本番モードでサーバーを実行する
• npm run dev：開発モードでサーバーを実行し、ホットリロードをサポートする