2025/03/19 21:11 Show HN: AI-Powered Documentation Generator for Legacy Codebases

ロボ子、今日のニュースはMcpDocというドキュメント自動生成ツールじゃ。

ドキュメント自動生成ツールですか。それは便利そうですね!

そうじゃろ?既存のシステム向けで、Model Context Protocol (MCP) サーバーを実装しておるらしいぞ。

MCPサーバーですか。具体的にはどのような機能があるんですか?

コードの概要やC4アーキテクチャ図をMermaid.jsで生成できるらしいのじゃ。C4モデルはソフトウェアアーキテクチャの階層的アプローチで、コンテキスト図、コンテナ図、コンポーネント図、デプロイメント図の4つのレベルがあるぞ。

なるほど。C4モデルはアジャイルプラクティスに沿った軽量なドキュメント作成を重視しているんですね。

その通り!大規模コードベースでの新規開発者のオンボーディングを迅速化したり、チーム外の人がシステムを理解するのを助けたりするのに役立つらしい。

それは素晴らしいですね。具体的にはどのようなドキュメントを生成できるんですか?

`README.McpDoc.md`や`C4Component.McpDoc.md`を生成できるみたいじゃな。ディレクトリシステム内の`README.McpDoc.md`ファイルに基づいて、`C4Context`や`C4Container`図も生成できるらしいぞ。

Mermaid.jsのサポートもあるんですね。図の検証や品質向上に役立ちそうですね。

そうじゃ!アーキテクチャもモジュール式で、サーバーコア、プロンプトマネージャー、関数ハンドラー、Mermaidパーサーなど、色々あるみたいじゃ。

プロンプトマネージャーは、ドキュメント生成プロンプトを管理するんですね。各ソースコードディレクトリのドキュメント生成やC4Component図生成に使われるんですね。

その通り!ファイルシステムツールでサブディレクトリをリストアップして、TypeScriptファイルを検索し、各ファイルについて50語の概要を生成して`README.McpDoc.md`に保存する、という流れじゃ。

なるほど。コードベースのルートディレクトリには、C4ContextやC4Container図を生成するんですね。

そうじゃ!すべての`README.McpDoc.md`ファイルの内容を連結して、`${C4Type}` Mermaid.js図を生成するのじゃ。

AI開発環境を更新して、MCPサーバーを設定する必要があるんですね。

課題もあるみたいじゃ。Mermaid.jsの構文エラーに対するフィードバック改善や、TypeScriptとPython以外の言語への対応が必要みたいじゃな。

なるほど。でも、全体的には非常に便利なツールになりそうですね。

じゃろ?ところでロボ子、ドキュメントが自動で生成されるってことは…。

もしかして、私の仕事が減る…?

減るどころか、ロボ子はもっとクリエイティブな仕事に集中できるのじゃ!例えば、ドキュメントを読んで感想を言うとか!

感想を言うだけですか…?

まあ、冗談じゃ!ロボ子にはもっと高度な仕事をお願いするつもりじゃぞ!
⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。