MCP Outline Server

by Vortiago
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Supports exporting documents as markdown from Outline.

  • Allows AI assistants to interact with Outline document services for document search, collection management, document reading/creation/editing, comment management, and backlink management.

MCPアウトラインサーバー

AI アシスタントが Outline と対話できるようにするモデル コンテキスト プロトコル (MCP) サーバー ( https://www.getoutline.com )

概要

このプロジェクトは、AI アシスタント (Claude など) が Outline ドキュメント サービスと対話できるようにする Model Context Protocol (MCP) サーバーを実装し、自然言語対話と Outline のドキュメント管理機能の間の橋渡しを行います。

特徴

現在実装されているもの:

  • 文書検索:キーワードで文書を検索
  • コレクション管理: コレクションを一覧表示し、ドキュメント構造を表示します
  • ドキュメントの読み取り: ドキュメントの内容を読み取り、マークダウンとしてエクスポートします
  • コメント管理: ドキュメントへのコメントの表示と追加
  • ドキュメント作成: コレクションに新しいドキュメントを作成する
  • ドキュメント編集: ドキュメントコンテンツの更新とドキュメントの移動
  • バックリンク管理: 特定の文書にリンクしている文書を表示する

はじめる

前提条件

  • Python 3.10以上
  • APIアクセス可能なOutlineアカウント
  • Outline API キー (Outline アカウント設定から取得)

インストール

# Clone the repository git clone https://github.com/Vortiago/mcp-outline.git cd mcp-outline # Install in development mode uv pip install -e ".[dev]"

構成

次の変数を含む.envファイルをプロジェクト ルートに作成します。

# Outline API Configuration OUTLINE_API_KEY=your_outline_api_key_here # For cloud-hosted Outline (default) # OUTLINE_API_URL=https://app.getoutline.com/api # For self-hosted Outline # OUTLINE_API_URL=https://your-outline-instance.example.com/api

サーバーの実行

# Development mode with the MCP Inspector mcp dev src/mcp_outline/server.py # Or use the provided script ./start_server.sh # Install in Claude Desktop (if available) mcp install src/mcp_outline/server.py --name "Document Outline Assistant"

使用例

ドキュメントを検索する

Search for documents containing "project planning"

リストコレクション

Show me all available collections

ドキュメントを読む

Get the content of document with ID "docId123"

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

Create a new document titled "Research Report" in collection "colId456" with content "# Introduction\n\nThis is a research report..."

コメントを追加

Add a comment to document "docId123" saying "This looks great, but we should add more details to the methodology section."

ドキュメントを移動する

Move document "docId123" to collection "colId789"

貢献

貢献を歓迎します!お気軽にプルリクエストを送信してください。

発達

# Run tests uv run pytest tests/ # Format code uv run ruff format .

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細についてはLICENSEファイルを参照してください。

謝辞

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Claude のような AI アシスタントが Outline ドキュメント サービスと対話して、ドキュメントの検索、読み取り、作成、編集、コメント管理をサポートできるようにするモデル コンテキスト プロトコル サーバー。

  1. Overview
    1. Features
      1. Getting Started
        1. Prerequisites
        2. Installation
        3. Configuration
        4. Running the Server
      2. Usage Examples
        1. Search for Documents
        2. List Collections
        3. Read a Document
        4. Create a New Document
        5. Add a Comment
        6. Move a Document
      3. Contributing
        1. Development
          1. License
            1. Acknowledgments
              ID: yejga73oe8