Devdocs MCP

🚀 DevDocs MCP 實現文檔

本項目聚焦於 DevDocs MCP 的實現，通過合理的項目結構、核心組件的構建，為文檔資源管理提供了高效且安全的解決方案。同時，明確的開發流程和清晰的進展規劃，有助於項目的順利推進和持續優化。

🚀 快速開始

本項目的快速開始可參考以下步驟，先了解項目結構，再深入核心組件的使用：

src/
├── resources/
│   ├── templates/      # 資源模板系統
│   └── managers/       # 資源管理
├── documentation/
│   ├── processors/     # 文檔處理程序
│   └── integrators/    # 集成處理器
├── tasks/
│   ├── issues/         # 問題跟蹤
│   └── reviews/        # 審核管理
└── tests/
    ├── property/       # 屬性基測試
    └── integration/    # 整合測試

✨ 主要特性

資源模板系統

資源模板系統通過基於 URI 的訪問提供文檔資源管理，具備以下強大功能：

• 通過 Pydantic 實現參數類型安全處理，保障數據類型的準確性。
• 靈活的 URI 模板匹配，可適應不同的訪問需求。
• 全面錯誤處理，確保系統在異常情況下的穩定性。
• 資源生命週期狀態管理，有效監控資源的使用情況。

測試策略

項目使用 Hypothesis 進行屬性基測試，確保以下關鍵方面的正確性：

• URI 模板驗證正確，保證訪問路徑的有效性。
• 參數提取準確性，確保數據提取的精確性。
• 錯誤處理健壯性，增強系統的容錯能力。
• 類型安全執行，保障代碼運行的安全性。

📦 安裝指南

暫未提供相關安裝步驟，可後續關注項目更新。

💻 使用示例

基礎用法

from src.resources.templates.base import ResourceTemplate

# 創建帶有參數類型的模板
template = ResourceTemplate(
    uri_template='docs://api/{version}/endpoint',
    parameter_types={'version': str}
)

# 提取並驗證參數
params = template.extract_parameters('docs://api/v1/endpoint')
template.validate_parameters(params)

高級用法

暫未提供高級用法示例，可後續關注項目更新。

📚 詳細文檔

實現進展

已完成

• [x] 基本項目結構
• [x] 資源模板系統
• [x] 屬性基測試基礎設施
• [x] URI 驗證和參數提取
• [x] 錯誤處理基礎

進行中

• [ ] 文檔處理器集成
• [ ] 緩存層實現
• [ ] 任務管理系統
• [ ] 性能優化

計劃中

• [ ] 搜索實現
• [ ] 分支映射系統
• [ ] 狀態跟蹤
• [ ] 監控系統

開發指南

1. 採用 TDD 方法：

   • 首先編寫屬性基測試，確保功能的正確性。
   • 實現最小通過代碼，逐步推進開發。
   • 重構以提高清晰度和效率，優化代碼質量。

2. 錯誤處理：

   • 使用結構化錯誤類型，便於錯誤的定位和處理。
   • 實現恢復策略，增強系統的穩定性。
   • 維護系統穩定性，保障系統的正常運行。

3. 文檔管理：

   • 更新 README，及時記錄項目的最新信息。
   • 記錄新功能，方便團隊成員瞭解項目進展。
   • 包含使用示例，降低使用門檻。

分支管理

項目採用分支式開發方式用於：

• 功能跟蹤，清晰掌握功能的開發進度。
• 文檔集成，確保文檔的完整性和一致性。
• 任務管理，合理分配和管理開發任務。
• 進度監控，及時瞭解項目的整體進展。

貢獻指南

1. 創建功能分支，避免對主分支造成影響。
2. 添加屬性基測試，保證功能的正確性。
3. 實現功能，完成具體的開發任務。
4. 更新文檔，及時記錄功能的使用方法和注意事項。
5. 提交拉取請求，等待審核和合並。

下一步

1. 實現文檔處理器集成，提升文檔處理的效率。
2. 添加緩存層及生命週期管理，優化系統性能。
3. 開發任務管理系統，提高團隊協作效率。
4. 創建監控和性能指標，即時掌握系統的運行狀態。

支持資源

• MCP 概念文檔：mcp-docs/docs/concepts/
• Python SDK：python-sdk/src/mcp/
• 示例服務器：python-sdk/examples/servers/