Outline

🚀 MCP Outline Server

A Model Context Protocol (MCP) server that enables AI assistants to interact with Outline's (https://www.getoutline.com) document service, serving as a bridge between natural language interactions and Outline's document management capabilities.

🚀 Quick Start

Prerequisites

• Python version 3.10 or higher.
• An Outline account with API access.
• An Outline API key (obtained from your Outline account settings).

Installation

# Clone the repository
git clone https://github.com/Vortiago/mcp-outline.git
cd mcp-outline

# Install in development mode
uv pip install -e ".[dev]"

Configuration

Create a .env file in the project root directory and add the following variables:

# Outline API configuration
OUTLINE_API_KEY=Your_Outline_API_Key

# For cloud-deployed Outline (default)
# OUTLINE_API_URL=https://app.getoutline.com/api

# For self-hosted Outline
# OUTLINE_API_URL=https://your-outline-instance.example.com/api

Running the Server

# Run in development mode with the MCP monitor
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"

✨ Features

The following features have been implemented:

• Document Search: Search for documents by keywords.
• Collection Management: List all available collections and view the document structure.
• Document Reading: Read document content and export it in Markdown format.
• Comment Management: View and add comments on documents.
• Document Creation: Create new documents in a specified collection.
• Document Editing: Update document content and move documents.
• Backlink Management: View other documents related to a specific document.

💻 Usage Examples

Basic Usage

Search for Documents

Search for documents containing "Project Planning".

List Collections

Show all available collections.

Read a Document

Get the content of the document with ID "docId123".

Create a New Document

Create a new document named "Research Report" in the collection "colId456" with the following content:
# Introduction

This is the beginning of the research report...

Add a Comment

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

Move a Document

Move the document "docId123" to the collection "colId789".

📚 Documentation

Overview

This project implements a Model Context Protocol (MCP) server that allows AI assistants (such as Claude) to interact with the Outline document service, providing a bridge between natural language interactions and Outline's document management capabilities.

🔧 Technical Details

Development

# Run tests
uv run pytest tests/

# Format the code
uv run ruff format .

📄 License

This project is open-source under the MIT License. For more details, please refer to the LICENSE file.

Acknowledgments

• Built using the MCP Python SDK.
• Used in conjunction with the Outline API for document management.