Happy slice of mcp pizzaMCP.pizza

mcp-outline

MCP.Pizza Chef: Vortiago

The MCP Outline server is a Model Context Protocol server that integrates AI assistants with Outline documentation services. It enables natural language interactions for document search, reading, editing, comment management, and backlink viewing within Outline, streamlining document management workflows through AI-driven commands and queries.

Use This MCP server To

Search Outline documents by keywords via AI queries List and navigate document collections and structures Read and export document content as markdown View and add comments on Outline documents Create new documents within specified collections Edit and move existing documents in Outline View backlinks to documents for context and reference

README

MCP Outline Server

A Model Context Protocol (MCP) server enabling AI assistants to interact with Outline (https://www.getoutline.com)

Overview

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

Features

Currently implemented:

  • Document Search: Search for documents by keywords
  • Collection Management: List collections and view document structure
  • Document Reading: Read document content, export as markdown
  • Comment Management: View and add comments on documents
  • Document Creation: Create new documents in collections
  • Document Editing: Update document content and move documents
  • Backlink Management: View documents that link to a specific document

Getting Started

Prerequisites

  • Python 3.10+
  • Outline account with API access
  • Outline API key (get this 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 with the following variables:

# 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

Running the Server

# 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"

Usage Examples

Search for Documents

Search for documents containing "project planning"

List Collections

Show me all available collections

Read a Document

Get the content of document with ID "docId123"

Create a New Document

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

Add a Comment

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

Move a Document

Move document "docId123" to collection "colId789"

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development

# Run tests
uv run pytest tests/

# Format code
uv run ruff format .

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

mcp-outline FAQ

How do I authenticate the MCP Outline server with my Outline account?
You need an Outline account with API access and provide your API token during server setup to authenticate.
Can the MCP Outline server create new documents?
Yes, it supports creating new documents within specified collections in Outline.
Does the server support editing existing documents?
Yes, you can update document content and move documents between collections.
How does the server handle document search?
It allows keyword-based search to find relevant documents within your Outline workspace.
Can I manage comments on documents through this server?
Yes, you can view existing comments and add new comments to documents.
Is it possible to view backlinks to a document?
Yes, the server provides backlink management to see which documents link to a specific document.
What are the prerequisites for running the MCP Outline server?
You need Python 3.10+ and an Outline account with API access.
How does this server improve AI assistant interactions with Outline?
It bridges natural language commands with Outline's API, enabling seamless document management via AI.