Outline

🚀 MCP Outline サーバー

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

🚀 クイックスタート

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

✨ 主な機能

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

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

📦 インストール

前提条件

• Python 3.10 以上のバージョン
• Outline アカウントと API アクセス権限
• Outline API キー（Outline アカウント設定から取得）

インストール手順

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

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

設定

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

# Outline API 設定
OUTLINE_API_KEY=あなたのOutline_API_キー

# クラウドデプロイ用の 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 デスクトップ版にインストールする（ある場合）
mcp install src/mcp_outline/server.py --name "ドキュメントアウトラインアシスタント"

💻 使用例

基本的な使用法

ドキュメントを検索する

「プロジェクト計画」を含むドキュメントを検索する

コレクションをリストする

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

ドキュメントを読む

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

新しいドキュメントを作成する

コレクション「colId456」に「研究報告」という名前の新しいドキュメントを作成する

高度な使用法

コメントを追加する

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

ドキュメントを移動する

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

📄 ライセンス

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

謝辞

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