Docnav MCP

🚀 DocNav MCP Server

DocNavは、Model Context Protocol (MCP) サーバーです。このサーバーは、LLMエージェントに、人間のような理解とナビゲーション能力を模倣して、長いドキュメントを読み、分析し、管理する機能を提供します。

✨ 主な機能

• ドキュメントナビゲーション：ドキュメントのセクション、見出し、コンテンツ構造をナビゲートします。
• コンテンツ抽出：特定のドキュメントセクションを抽出し、要約します。
• 検索とクエリ：インテリジェントな検索を使用して、ドキュメント内の特定のコンテンツを見つけます。
• 複数フォーマットのサポート：現在はMarkdown (.md) ファイルをサポートしており、PDFやその他のフォーマットのサポートも予定されています。
• MCP統合：MCP互換のLLMやアプリケーションとシームレスに統合します。

🔧 技術詳細

DocNavは、モジュール式で拡張可能なアーキテクチャに従っています。

• Core MCP Server：MCPプロトコルを使用したメインサーバーの実装。
• Document Processors：異なるファイルタイプ用のプラガブルなプロセッサー。
• Navigation Engine：ドキュメントの構造分析とナビゲーションを処理します。
• Content Extractors：ドキュメントからコンテンツを抽出し、フォーマットします。
• Search Engine：ドキュメント全体にわたる検索とクエリ機能を提供します。

📦 インストール

前提条件

• Python 3.10+
• uv パッケージマネージャー

セットアップ

1. リポジトリをクローンします：

git clone https://github.com/shenyimings/DocNav-MCP.git
cd DocNav-MCP

2. 依存関係をインストールします：

uv sync

💻 使用例

MCPサーバーの起動

uv run server.py

MCPサーバーに接続する

{
  "mcpServers": {
    "docnav": {
      "command": "{{PATH_TO_UV}}", // Run `which uv` and place the output here
      "args": [
        "--directory",
        "{{PATH_TO_SRC}}",
        "run",
        "server.py"
      ]
    }
  }
}

利用可能なツール

• load_document：ナビゲーションと分析のためにドキュメントを読み込みます。

  • 引数：file_path (ドキュメントファイルのパス)
  • 戻り値：自動生成されたドキュメントIDを含む成功メッセージ

• get_outline：ドキュメントのアウトライン/目次を取得します。

  • 引数：doc_id (ドキュメント識別子), max_depth (最大見出し深度、デフォルトは3)
  • 戻り値：フォーマットされたドキュメントアウトライン
  • ヒント：ドキュメントを読み込んだ後、最初に使用して構造を理解します。

• read_section：特定のドキュメントセクションのコンテンツを読み取ります。

  • 引数：doc_id (ドキュメント識別子), section_id (例: 'h1_0', 'h2_1')
  • 戻り値：サブセクションを含むセクションコンテンツ

• search_document：ドキュメント内で特定のコンテンツを検索します。

  • 引数：doc_id (ドキュメント識別子), query (検索用語またはフレーズ)
  • 戻り値：コンテキスト付きのフォーマットされた検索結果

• navigate_section：セクションのナビゲーションコンテキストを取得します。

  • 引数：doc_id (ドキュメント識別子), section_id (ナビゲートするセクション)
  • 戻り値：親、兄弟、子を含むナビゲーションコンテキスト

• list_documents：現在読み込まれているすべてのドキュメントをリストします。

  • 戻り値：メタデータ付きの読み込まれたドキュメントのリスト

• get_document_stats：読み込まれたドキュメントの統計情報を取得します。

  • 引数：doc_id (ドキュメント識別子)
  • 戻り値：ドキュメントの統計情報と構造情報

• remove_document：ドキュメントをナビゲーターから削除します。

  • 引数：doc_id (ドキュメント識別子)
  • 戻り値：成功またはエラーメッセージ

基本的な使用法

# Load a document
result = await tools.load_document("path/to/document.md")

# Get document outline
outline = await tools.get_outline(doc_id)

# Get specific section content
section = await tools.read_section(doc_id, section_id)

# Search within document
results = await tools.search_document(doc_id, "search query")

📚 ドキュメント

プロジェクト構造

docnav-mcp/
--- server.py             # Main MCP server
--- docnav/
------- __init__.py           # Package initialization
------- models.py             # Data models
------- navigator.py          # Document navigation engine
------- processors/
------- __init__.py       # Processor package
------- base.py           # Base processor interface
------- markdown.py       # Markdown processor
--- tests/
------- ...                   # Test files

開発ガイドライン

詳細な開発ガイドラインは、CLAUDE.md を参照してください。以下の内容が含まれています。

• コード品質基準
• テスト要件
• uvによるパッケージ管理
• フォーマットとリントルール

新しいドキュメントプロセッサーの追加

1. BaseProcessor を継承した新しいプロセッサークラスを作成します。
2. 必要なメソッドを実装します：can_process, process, extract_section, search
3. DocumentNavigator にプロセッサーを登録します。
4. 包括的なテストを追加します。

テストの実行

# Run all tests
uv run tests/run_tests.py

コード品質

# Format code
uv run --frozen ruff format .

# Check linting
uv run --frozen ruff check .

# Type checking
uv run --frozen pyright

🚧 ロードマップ

• [x] Markdownプロセッサーの実装を完了する
• [x] PDFドキュメントのサポートを追加する (PyMuPDF)
• [x] テストカバレッジと品質を向上させる
• [ ] 高度な検索機能を実装する
• [ ] ドキュメント要約機能を追加する
• [ ] 追加のドキュメントフォーマット (DOCX, TXTなど) をサポートする
• [ ] 大きなドキュメントのパフォーマンスを最適化する
• [ ] 頻繁にアクセスされるドキュメントのキャッシュメカニズムを追加する
• [ ] 読み込まれたドキュメントの永続的なストレージを追加する

🤝 コントリビュート

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. CLAUDE.mdの開発ガイドラインに従います。
4. 新機能に対するテストを追加します。
5. プルリクエストを送信します。

📄 ライセンス

このプロジェクトは、Apache 2.0ライセンスの下でライセンスされています。詳細については、LICENSEファイルを参照してください。

🆘 サポート

問題や質問については、以下の方法で対応します。

• GitHubでイシューを開く
• CLAUDE.mdのドキュメントを確認する
• 既存のイシューとディスカッションを確認する