MCP Outline

🚀 MCP ドキュメントサーバー

このプロジェクトは、AI アシスタントが Outline（https://www.getoutline.com）のドキュメントサービスと対話できるように、モデルコンテキストプロトコル（MCP）を実装したサーバーです。自然言語対話と Outline のドキュメント管理機能をつなぐ橋渡しをします。

🚀 クイックスタート

このプロジェクトは、モデルコンテキストプロトコル（MCP）サーバーを実装しており、AI アシスタント（Claude など）が Outline のドキュメント管理機能と対話できるようにします。自然言語対話と Outline のドキュメント管理機能の橋渡しを果たします。

✨ 主な機能

現在実装されている機能は以下の通りです：

• ドキュメント検索：キーワードでドキュメントを検索します。
• コレクション管理：利用可能なすべてのコレクションをリストし、ドキュメント構造を確認できます。
• ドキュメント閲覧：ドキュメントの内容を取得し、Markdown 形式でエクスポートします。
• コメント管理：ドキュメント上のコメントを表示および追加します。
• ドキュメント作成：指定されたコレクション内に新しいドキュメントを作成します。
• ドキュメント編集：ドキュメントの内容を更新し、ドキュメントを移動します。
• 逆リンク管理：特定のドキュメントを参照する他のドキュメントを表示します。

📦 インストール

依存関係

• Python 3.10+
• Outline アカウントと API アクセス権限
• Outline API Key（Outline アカウント設定から取得）

インストール手順

# リポジトリをクローン
git clone https://github.com/Vortiago/mcp-outline.git
cd mcp-outline

# 開発モードでインストール
uv pip install -e ".[dev]"

設定

プロジェクトのルートディレクトリに .env ファイルを作成し、以下の変数を追加します。

# Outline API 設定
OUTLINE_API_KEY=your_outline_api_key_here

# クラウドデプロイの Outline（デフォルト）
# OUTLINE_API_URL=https://app.getoutline.com/api

# 自前でホストする Outline
# OUTLINE_API_URL=https://your-outline-instance.example.com/api

サーバーの起動

# MCP 監視ツールを使用して開発モードで実行
mcp dev src/mcp_outline/server.py

# または提供されているスクリプトを使用
./start_server.sh

# Claude Desktop でインストール（利用可能な場合）
mcp install src/mcp_outline/server.py --name "ドキュメントアウトラインアシスタント"

💻 使用例

基本的な使用法

ドキュメント検索

「プロジェクト計画」というキーワードを含むドキュメントを検索

コレクションの一覧表示

利用可能なすべてのコレクションを表示

ドキュメントの閲覧

ID が「docId123」のドキュメントの内容を取得

新しいドキュメントの作成

コレクション「colId456」に「研究報告」という名前の新しいドキュメントを作成し、内容は以下の通り：
# はじめに

これは研究報告です...

コメントの追加

ID が「docId123」のドキュメントにコメントを追加：「このドキュメントは素晴らしいですが、方法論の部分にもっと詳細を追加する必要があります。」

ドキュメントの移動

ドキュメント「docId123」をコレクション「colId789」に移動

🔧 開発

# テストの実行
uv run pytest tests/

# コードのフォーマット
uv run ruff format .

📄 ライセンス

このプロジェクトは MIT ライセンスの下でオープンソースとして公開されています。詳細は LICENSE ファイルを参照してください。

謝辞

• MCP Python SDK を使用して構築されています。
• Outline API を使用してドキュメント管理を行っています。