Readium Mcp Server - Git To Markdown

Readium MCP

Model Context Protocol（MCP） サーバーです。Readium の強力なドキュメント分析機能を、Claude などの LLM や、その他の MCP 対応クライアントに提供します。

🔍 これは何ですか？

Readium MCP は LLM とあらゆるドキュメントリポジトリをつなぐ役割を果たし、次のことを可能にします。

• ローカルディレクトリ、公開／非公開の Git リポジトリ、URL の分析
• 複数のファイル形式（コード、Markdown、テキスト）の処理
• 分析用に Web ページを Markdown に変換
• 要約、ファイルツリー、コンテンツを含む構造化された結果の提供

大量のドキュメント、コードリポジトリ、技術系 Web サイトを LLM に分析させたい場合に最適です。

🚀 インストール

pip を使用する（推奨）

pip install readium-mcp

ソースコードから

# Clone the repository
git clone https://github.com/tu-usuario/readium-mcp.git
cd readium-mcp

# Install dependencies with Poetry
poetry install

🛠️ 使用方法

直接実行

readium-mcp

Poetry を使用する（ソースコードから）

poetry run readium-mcp

🔌 MCP クライアントとの連携

VSCode

VSCode の設定（settings.json）に追加します。

{
  "mcp": {
    "servers": {
      "readium": {
        "command": "readium-mcp"
      }
    }
  }
}

または、プロジェクト内に .vscode/mcp.json ファイルを作成します。

{
  "servers": {
    "readium": {
      "command": "readium-mcp"
    }
  }
}

Claude Desktop

claude_desktop_config.json に追加します。

{
  "mcpServers": {
    "readium": {
      "command": "readium-mcp"
    }
  }
}

MCP CLI

# Install
mcp install -n readium -- readium-mcp

# Inspect
mcp inspect readium

# Test in console
mcp call-tool readium analyze_docs --path https://github.com/modelcontextprotocol/servers.git

📝 提供されるツール

analyze_docs

Readium を使用して、ローカルディレクトリ、Git リポジトリ、または URL のドキュメントを分析します。

パラメーター

パラメーター	型	説明	デフォルト
path	文字列	ローカルパス、GitHub URL、またはドキュメントの URL	（必須）
branch	文字列	リポジトリの場合に使用するブランチ	null
target_dir	文字列	分析する特定のサブディレクトリ	null
use_markitdown	ブール値	変換に Markitdown を使用するかどうか	false
url_mode	文字列	URL の処理モード（'clean'、'full'）	"clean"
max_file_size	整数	最大ファイルサイズ（バイト単位）	5242880（5MB）
exclude_dirs	配列	除外するディレクトリ	[]
exclude_ext	配列	除外する拡張子（例：['.png']）	[]
include_ext	配列	対象に含める拡張子（例：['.md']）	[]

レスポンス

{
  "content": [
    {"type": "text", "text": "Summary:\n..."},
    {"type": "text", "text": "Tree:\n..."},
    {"type": "text", "text": "Content:\n..."}
  ],
  "isError": false
}

🧪 テスト

ユニットテスト

poetry run pytest

Readium の直接テスト

python test.py

🧩 Python での使用例

import asyncio
from mcp import ClientSession, StdioServerParameters
from mcp.client.stdio import stdio_client

async def test_readium_mcp():
    server_params = StdioServerParameters(
        command="readium-mcp"
    )

    async with stdio_client(server_params) as (read, write):
        async with ClientSession(read, write) as session:
            await session.initialize()

            # List tools
            tools = await session.list_tools()
            print(f"Available tools: {tools}")

            # Analyze a repository
            result = await session.call_tool(
                "analyze_docs",
                {"path": "https://github.com/modelcontextprotocol/servers.git"}
            )

            print(f"Analysis result: {result}")

# Run
asyncio.run(test_readium_mcp())

📋 メリット

• 高速：大規模なリポジトリも効率的に分析できます
• 柔軟：ローカルディレクトリ、Git リポジトリ、URL に対応しています
• 設定可能：分析する拡張子、サイズ、ディレクトリをカスタマイズできます
• 互換性：あらゆる MCP クライアント（Claude、VSCode、CLI）で動作します
• シンプル：複雑な依存関係はなく、最大限の互換性を実現する stdio トランスポートを使用します

🤝 貢献

貢献を歓迎します。お気軽に以下を行ってください。

1. リポジトリをフォークする
2. 機能追加用のブランチを作成する（git checkout -b feature/amazing-feature）
3. 変更をコミットする（git commit -m 'Add some amazing feature'）
4. ブランチをプッシュする（git push origin feature/amazing-feature）
5. Pull Request を作成する

📄 ライセンス

このプロジェクトは MIT ライセンスのもとでライセンスされています。詳細は LICENSE ファイルをご覧ください。

👏 謝辞

• 強力なドキュメント分析機能を提供する Readium
• LLM 通信の標準プロトコルを提供する Model Context Protocol
• MCP 用 Python SDK を提供する FastMCP

---

Pablo Toledo が ❤️ を込めて開発しました