- 構造化データ
- ロジック
- スキーマ
- 人間による確認
すぐに答え
AIにAPIドキュメントを理解させるには?
DocBreachは、OpenAPI、Swagger、Postmanファイルから技術的な詳細を抽出し、構造化データに変換します。AIはこのデータを用いて、利用可能なエンドポイント、必須パラメータ、サービスのロジックを特定します。これにより、サービスの機能が明確なマップとして可視化されます。
データの出力先
抽出によって得られる成果
AIはドキュメントを解析し、以下の形式で出力します。
構造化データ
整理されたエンドポイントマップ
AIは docs_extract を使用して、パスやメソッドを推論可能な形式で抽出します。利用可能な機能の一覧を確実に取得できます。
ロジック
サービス機能マップ
エージェントが異なるエンドポイント間の関係性を理解します。これにより、複雑なAPI呼び出しのシーケンスを計画できるようになります。
スキーマ
パラメータ定義
必要なヘッダー、クエリパラメータ、ボディオブジェクトを正確に特定します。エージェントによるAPI呼び出し時のエラーを防ぎます。
人間による確認
手動レビューの活用
AIがエンドポイントを特定しますが、エージェントが実行してよいかどうかはユーザーが判断します。実際のAPI呼び出しに対する制御権を維持できます。
ワークフロー
コレクションが届いた際、AIが行うこと
AIが煩雑なドキュメントファイルの解析という重労働を担います。
ドキュメントの取り込み
エージェントが提供された生のOpenAPI、Swagger、またはPostmanファイルを読み取ります。
docs_extractエンドポイントの解析
AIがすべての固有のURLパスと、それに関連付けられたHTTPメソッドを特定します。
docs_extractパラメータのマッピング
各リクエストにおける特定のデータ型や必須フィールドを抽出します。
docs_extract機能モデルの構築
抽出したデータを整理し、サービスが実際に実行可能な機能の論理的なマップを作成します。
docs_extract
試してみる
以下のプロンプトをコピーして開始
DocBreachを接続した後、これらのプロンプトを利用できます。
出発点
これらは会話のきっかけとなる文章です。括弧内のテキストを、実際のファイル名やサービス名に書き換えて使用してください。
DocBreach Connector
準備完了です。MCPクライアントを選択し、セットアップ手順に従ってください。
https://edge.vinkius.com/vk_preview_irgtI6t1CMNMo7SoPiRQBNgk7Rz1GQFQBkyR1OUW/mcpClaude Desktop
以下の手順で数秒で接続できます。
- 1In Claude Desktop, open Settings → Connectors.
- 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
- 3Click Add and start a new chat — DocBreach capabilities are ready to use.
{
"mcpServers": {
"docbreach-mcp": {
"url": "https://edge.vinkius.com/vk_preview_irgtI6t1CMNMo7SoPiRQBNgk7Rz1GQFQBkyR1OUW/mcp"
}
}
}[filename.json] ファイルから、利用可能なすべてのエンドポイントを抽出して。
このSwaggerドキュメントに基づくと、[endpoint name] の呼び出しに必要なパラメータは何ですか?
このPostmanコレクションに記載されているサービス機能をマップ化して。
[filename.yaml] に含まれるAPIの認証要件を要約して。
Claude
ChatGPT
Cursor
VS Code
Windsurf
Claude Code
JetBrains
Cline
ここから始める
DocBreachを接続して、すぐに質問を。
リンクをクリックしてMCPをクライアントに接続するだけです。認証情報は暗号化されて保持されるため、すぐにAPIドキュメントに関する質問を開始できます。
DocBreachをAIに接続するFAQ
動作に関する詳細
- 01
AIが自動的にAPIを呼び出してくれますか?
いいえ。DocBreachはドキュメントを抽出してAIがエンドポイントを理解できるようにしますが、AI自身がAPIを実行することはありません。
- 02
Postmanコレクションでも動作しますか?
はい、Postmanコレクションを解析して構造化データに変換できます。
- 03
AIが元のSwaggerファイルを書き換えることはありますか?
いいえ。AIは情報を抽出するためにファイルを読み取るだけです。元のドキュメントを修正または上書きすることはありません。
- 04
大規模なOpenAPIファイルでも対応できますか?
はい。抽出プロセスは、複雑で大規模なサービス定義にも対応できるように設計されています。
- 05
どのエンドポイントが安全に使えるかはAIが決めるのですか?
いいえ。AIは「何が可能か」というマップを提供しますが、エージェントがどのエンドポイントとやり取りすることを許可するかは、ユーザーが決める必要があります。
DocBreachについて他に質問がありますか? Connectorのページで詳細を確認できます。 DocBreach Connectorの全機能を見る
『DocBreach』を Claude、Cursor、ChatGPT などに接続
