What is docfy-mcp

概要

docfy-mcpはMCP(Model Context Protocol)サーバーです。OpenAPIカタログ(理想的にはすでにnestjs-docfyでドキュメント化されたものですが、有効なOpenAPI 3.0/3.1のスペックであれば何でも動作します)を、接続されたコーディングエージェントが直接呼び出せるツールとして公開します。

5つのツールがあります。エンドポイントを発見・検査するlist_endpointsとget_endpoint、スペックの品質をチェックするlint_spec、別バージョンと比較するdiff_specs、そして稼働中のサーバーをスペックに対して検証するcontract_testです。

存在理由

これがない場合、あなたのAPIに対するクライアントを実装するエージェントには2つの選択肢しかありません。文脈から形を推測するか、人間にブラウザを開かせてSwagger UIを見つけ、該当箇所をチャットに貼り付けてもらうかです。どちらも直接のツール呼び出しより遅く、信頼性も劣ります。

nestjs-docfyとの関係

docfy-mcpはdocfy-uiが使っているのと同じドキュメントモデルエンジン、共有パッケージdocfy-coreの上に構築されています。

get_endpointの出力は、docfy-uiのCopy for AIボタンがコピーするのとまったく同じテキストで、同じoperationToAiText()関数によって生成されます。この2つのプロジェクトは同じモデルに対する2種類の異なるフロントエンドです。一方はブラウザ上の人間向け、もう一方はstdio経由のエージェント向けです。