API機能

Understandは、Understandデータベース(*.und)へのアクセスを提供するAPI(Application Programming Interface)を公開しています。
このUnderstand APIを使用したスクリプトを用いて、Understandデータベースから必要なデータを取得することができ、任意のレポートなどの作成が可能になります。
※ご利用には、Understand APIが利用可能なライセンスが必要です。

• 活用方法： API活用Blog

ドキュメント生成

APIを用いてUnderstandの解析結果をもとにしたレポートを作成することができます。
要素（ファイル/クラス/関数など）の参照情報（呼び出し関係/使用している変数/メトリクスなど）を、関数仕様書形式に出力にするサンプルスクリプトを提供します。出力形式はMarkdownやMermaid、Wordなどにカスタマイズが可能です。
ソースコードに、別途コメントなどを埋め込むことなく、関数仕様書形式に出力が可能なほか、変更差分に着目をした差分レポートの生成など幅広いカスタマイズが可能です。

• 詳細：Understandユースケース [ドキュメント作成編]
• Blog：Understand APIを使用したドキュメント生成

レビューツール（GitHub/GitLab）と連携したコードレビュー支援

APIを用いてUnderstandからメトリクスや依存関係の変更差分を出力することが可能です。
例えば、差分のメトリクス情報や差分グラフィカルビューを出力し、レビューツール（例：GitHubやGitLabなど）に表示するサンプルスクリプトを提供します。

• 詳細：Understandユースケース [コードレビュー編]
• Blog：GitHub ActionsのPRコメントで差分を可視化する

生成AIとのMCPサーバーを介した連携

MCPサーバーをサポートする生成AI対応の開発環境から、AIエージェントがUnderstand APIを直接呼び出し、Understandの正確かつ信頼性の高い決定論的な解析データを取得できます。
これにより、開発者がAIを介して自然言語でツールの解析結果などに問い合わせることが可能になります。

• 詳細：AI＆MCP連携
• Blog：MCPサーバーを構築してみた