Mcpdoc

🚀 C4Diagrammer 項目文檔

C4Diagrammer 是一款用於自動生成軟件系統架構圖的工具。它能通過分析項目的代碼結構與文件組織方式，生成對應的 C4 模型（Context、Container 和 Component）圖表，助力開發人員更好地理解系統結構以及組件間的關係。

✨ 主要特性

• 自動生成 C4 Context、Container 和 Component 圖表。
• 為每個子目錄生成文檔 README 文件，概述該目錄的功能和組件。
• 支持多語言項目，目前主要支持 TypeScript 和 Python。

📦 安裝指南

1. 克隆項目倉庫：

   git clone https://github.com/yourusername/C4Diagrammer.git
   

2. 安裝依賴項： 克隆並安裝相關的 'PromptRepository' 倉庫。

   npm run install
   

3. 構建項目：

   npm run build
   

💻 使用示例

基礎用法

要在主機上使用 MCP 服務器，需要更新您的 AI 開發環境。常見的配置如下所示。第二個參數限制了文件系統的訪問權限範圍。

{
  "mcpServers": {
    "mcp-documenter": {
      "command": "node",
      "args": ["YourCodeRoot/C4Diagrammer/dist/src/index.js", "YourCodeRoot"]
    }
  }
}

高級用法

對於特定 IDE 的設置說明，請參考：

• Cursor：https://docs.cursor.com/context/model-context-protocol
• Claude：https://modelcontextprotocol.io/quickstart/user

📚 詳細文檔

文檔由“dogfooding”生成 - C4Diagrammer 在每個子目錄中生成 README.C4Diagrammer.md 和 C4Component.C4Diagrammer.md，以及根目錄中的 C4Context 和 C4Container。

• ./C4Context.C4Diagrammer.md - 總覽 C4Context 圖表
• ./C4Container.C4Diagrammer.md - 總覽 C4Container 圖表
• src/README.C4Diagrammer.md - 源代碼文檔
• src/C4Component.C4Diagrammer.md - 源代碼組件圖表
• test/README.C4Diagrammer.md - 測試套件文檔
• test/C4Component.C4Diagrammer.md - 測試套件組件圖表

🔧 技術細節

C4Diagrammer 包含以下幾個關鍵組件：

1. MCP 服務器：負責處理與 AI 開發環境的交互，接收請求並返回生成的圖表。
2. PromptRepository：包含用於生成圖表所需提示語句的倉庫。
3. FS Access：提供對文件系統的訪問權限管理功能。

項目包含使用 Mocha 編寫的單元測試：

npm run test

📄 許可證

本項目遵循 MIT License。

👥 貢獻指南

歡迎貢獻！請隨意提交 Pull Request。

1. 叉克隆倉庫
2. 創建功能分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 提交拉取請求

⚠️ 注意事項

主要需要改進的領域是解析和驗證圖表，以提供對模型的反饋，特別是在發生語法錯誤時。目前 Mermaid.js 在程序化地獲取錯誤消息方面有些棘手。我們當前使用 Selenium 啟動一個即時瀏覽器，並且這可以正確檢測到語法錯誤的存在，但無法提供任何診斷信息。模型只能在沒有目標的情況下嘗試修正生成代碼。

到目前為止，僅運行了針對 TypeScript 和 Python 的提示語句。

正如提示部分所述，這種方法只在使用 Claude Sonnet 3.5（Cursor）和 Claude Opus 3.7（Claude Desktop）的較大規模倉庫中得到驗證。所有模型都能可靠地生成有用的代碼摘要。