Devdocs MCP

🚀 DevDocs MCP 実装ドキュメント

このプロジェクトは、DevDocs MCP の実装に関するドキュメントです。主にプロジェクト構造、核心コンポーネント、実装進捗、開発ガイド、ブランチ管理、貢献ガイド、次のステップ、サポートリソースなどの内容を含んでいます。

🚀 クイックスタート

このセクションでは、DevDocs MCP の基本的な情報と始め方を説明します。

📚 ドキュメント

🔍 プロジェクト構造

src/
├── resources/
│   ├── templates/      # リソーステンプレートシステム
│   └── managers/       # リソース管理
├── documentation/
│   ├── processors/     # ドキュメント処理プログラム
│   └── integrators/    # 統合プロセッサ
├── tasks/
│   ├── issues/         # 問題追跡
│   └── reviews/        # 審査管理
└── tests/
    ├── property/       # 属性ベースのテスト
    └── integration/    # 統合テスト

✨ 主な機能

🔧 リソーステンプレートシステム

リソーステンプレートシステムは、URI ベースのアクセスによりドキュメントリソースを管理します。以下の機能を備えています。

• Pydantic を使用したパラメータ型の安全な処理
• 柔軟な 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)

🔧 テスト戦略

プロジェクトは Hypothesis を使用して属性ベースのテストを行い、以下のことを保証します。

• URI テンプレートの正しい検証
• パラメータ抽出の正確性
• エラー処理の堅牢性
• 型安全な実行

💻 使用例

pytest tests/property/test_templates.py

📈 実装進捗

完了済み

• [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/