• 致命的
  • 警告
  • 成功
  • 要対応

AIを活用してOpenAPI仕様書を正確に検証する方法

このMCPをAIクライアントに接続すれば、コード生成前にAPI定義の構造的なエラーを確実に特定できます。

このページについてAIに聞く

すぐに答え

AIを使ってOpenAPI仕様書を検証するには?

AIがvalidate_openapiツールを使用して、仕様書の構造的な欠陥やスキーマ違反をチェックします。これにより、クライアントSDKの構築に使用する前に、定義が正しいことを確認できます。エラーの内容は詳細にレポートされます。

検証結果

エラーの分類

AIが仕様書を分析し、修正すべき箇所を分かりやすく分類します。

致命的

スキーマの破損

仕様書が読み込めなくなるような重大なエラーをAIが検出します。エラーが発生している正確な場所を特定します。

警告

論理的な欠落

説明文の不足など、動作には影響しないものの改善が必要な箇所を指摘します。ドキュメントの品質向上に役立ちます。

成功

有効な仕様書

仕様書に問題がなければ、AIが構造的に正しいことを確認します。そのままSDK生成へ進めます。

要対応

手動での修正が必要

AIがエラーの発生した行を特定します。修正するには、エディタで直接ファイルを編集する必要があります。

ワークフロー

仕様書が届いた際、AIが行うこと

AIが仕様書の解析とOpenAPI標準への適合性チェックを自動で行います。

  1. 仕様書の読み込み

    提供されたYAMLまたはJSONの内容をAIが読み取り、APIの構造を把握します。

    validate_openapi
  2. 構造のチェック

    入力内容をOpenAPIの公式ルールと比較し、必須フィールドの欠落を確認します。

    validate_openapi
  3. 不整合の検出

    SDKの動作を妨げるような、型定義の不一致やパラメータ定義の誤りを探します。

    validate_openapi
  4. エラー報告

    分析結果をまとめ、修正が必要な箇所を明確なレポートとして提示します。

    validate_openapi

試してみる

以下のプロンプトをコピーして開始

これらのプロンプトを使って検証を開始できます。

出発点

これらは入力の例です。実際のファイル名やURLに書き換えて使用してください。

@seriousme/openapi-schema-validator Connector

準備完了です。MCPクライアントを選択し、セットアップ手順に従ってください。

コネクタリンクhttps://edge.vinkius.com/vk_preview_G95x3PwWbp62LMB6m5PHyPKsw6CprV2yBUtgMX7s/mcp

Claude Desktop

以下の手順で数秒で接続できます。

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — @seriousme/openapi-schema-validator capabilities are ready to use.
設定 · claude_desktop_config.jsonコピー
{
  "mcpServers": {
    "openapi-validator-engine-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_G95x3PwWbp62LMB6m5PHyPKsw6CprV2yBUtgMX7s/mcp"
    }
  }
}
チャットにコピー04
  • このOpenAPI仕様書を検証してください: [仕様書の内容を貼り付け]

  • https://api.example.com/openapi.json の仕様書に構造的なエラーがないか確認してください。

  • このYAMLファイルはOpenAPI 3.0標準に準拠していますか? [仕様書の内容を貼り付け]

  • ローカルにある仕様書をスキャンして、必須パラメータの欠落がないか確認し、エラーを報告してください。

  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

ここから始める

OpenAPI Validator Engineを一度接続すれば、あとは指示するだけです。

MCPをクライアントに接続するのは一度だけで済みます。接続後は、どのような仕様書に対してもAIが検証を行えます。

OpenAPI Validator EngineをAIに接続する

FAQ

動作について

  • 01

    AIは仕様書のエラーを自動で修正できますか?

    いいえ。AIはエラーを特定して報告しますが、修正するには手動でファイルを編集する必要があります。

  • 02

    AIは元のファイルを書き換えますか?

    いいえ。AIは提供された内容を読み取るだけで、ローカルファイルやリポジトリに直接書き込むことはありません。

  • 03

    JSONとYAMLの両方を検証できますか?

    はい、両方のフォーマットに対応しています。

  • 04

    SDK生成時のエラーも検知できますか?

    いいえ。検知するのは仕様書自体のエラーです。SDKジェネレーターによって生成されたコードの妥当性は検証しません。

  • 05

    OpenAPI 3.1をサポートしていますか?

    はい、ツールがサポートしている標準バージョンに対して検証を行います。

  • OpenAPI Validator Engineについて他に質問がありますか? OpenAPI Validator Engine Connectorの全機能を見る

『@seriousme/openapi-schema-validator』を Claude、Cursor、ChatGPT などに接続