productivity

Outline

by vortiago

Outline: Connect AI to search, read, edit, and manage documents in a secure knowledge management platform via cloud or s

Enables AI systems to search, read, edit, and manage documents within Outline's knowledge management platform through direct API integration with both cloud and self-hosted instances.

github stars

110

Works with cloud and self-hosted OutlineAutomatic rate limiting with retry logicDirect content access via MCP Resources

best for

  • / Teams using Outline for knowledge management
  • / Automating documentation workflows
  • / AI-assisted content creation and editing
  • / Document search and organization

capabilities

  • / Search and read Outline documents
  • / Create and edit documents
  • / Manage document collections and hierarchies
  • / Add and view threaded comments
  • / Find document backlinks and references
  • / Archive and organize documents

what it does

Integrates AI systems with Outline knowledge management platform to search, read, create, and edit documents through direct API access. Works with both cloud and self-hosted Outline instances.

about

Outline is a community-built MCP server published by vortiago that provides AI assistants with tools and capabilities via the Model Context Protocol. Outline: Connect AI to search, read, edit, and manage documents in a secure knowledge management platform via cloud or s It is categorized under productivity.

how to install

You can install Outline in your AI client of choice. Use the install panel on this page to get one-click setup for Cursor, Claude Desktop, VS Code, and other MCP-compatible clients. This server runs locally on your machine via the stdio transport.

license

MIT

Outline is released under the MIT license. This is a permissive open-source license, meaning you can freely use, modify, and distribute the software.

readme

MCP Outline Server

<!-- mcp-name: io.github.Vortiago/mcp-outline -->

PyPI Python 3.10+ License: MIT CI Docker

A Model Context Protocol server for interacting with Outline document management.

Features

  • Document operations: Search, read, create, edit, archive documents
  • Collections: List, create, manage document hierarchies
  • Comments: Add and view threaded comments
  • Backlinks: Find documents referencing a specific document
  • MCP Resources: Direct content access via URIs (outline://document/{id}, outline://collection/{id}, etc.)
  • Automatic rate limiting: Transparent handling of API limits with retry logic

Prerequisites

Before using this MCP server, you need:

  • An Outline account (cloud hosted or self-hosted)
  • API key from Outline web UI: Settings → API Keys → Create New
  • Python 3.10+ (for non-Docker installations)

Getting your API key: Log into Outline → Click your profile → Settings → API Keys → "New API Key". Copy the generated token.

Quick Start

One-Click Install

Click a button to install with interactive API key prompt:

Install in VS Code Install in VS Code Insiders Install in Cursor

Manual Install

Install with uv (recommended), pip, or Docker:

uvx mcp-outline          # using uv
pip install mcp-outline   # using pip
# using Docker
docker run -e OUTLINE_API_KEY=<your-key> ghcr.io/vortiago/mcp-outline:latest

Then add to your MCP client config (works with VS Code, Claude Desktop, Cursor, and others):

{
  "inputs": [
    {
      "id": "outline_api_key",
      "type": "promptString",
      "description": "Enter OUTLINE_API_KEY",
      "password": true
    },
    {
      "id": "outline_api_url",
      "type": "promptString",
      "description": "Outline API URL (optional, for self-hosted)",
      "password": false
    }
  ],
  "servers": {
    "mcp-outline": {
      "command": "uvx",
      "args": ["mcp-outline"],
      "env": {
        "OUTLINE_API_KEY": "${input:outline_api_key}",
        "OUTLINE_API_URL": "${input:outline_api_url}"
      }
    }
  }
}
<details> <summary>Claude Code</summary>
claude mcp add mcp-outline uvx mcp-outline
</details> <details> <summary>Claude Desktop</summary>

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "mcp-outline": {
      "command": "uvx",
      "args": ["mcp-outline"],
      "env": {
        "OUTLINE_API_KEY": "<YOUR_API_KEY>",
        "OUTLINE_API_URL": "<YOUR_OUTLINE_URL>"
      }
    }
  }
}
</details>

Setup guides for more clients: Docker (HTTP), Cline, Codex, Windsurf, and others

Configuration

VariableRequiredDefaultNotes
OUTLINE_API_KEYYes*-Required for tool calls to succeed. For SSE/HTTP, can alternatively be provided per-request via x-outline-api-key header (details)
OUTLINE_API_URLNohttps://app.getoutline.com/apiFor self-hosted: https://your-domain/api
OUTLINE_VERIFY_SSLNotrueSet false for self-signed certificates
OUTLINE_READ_ONLYNofalsetrue = disable ALL write operations (details)
OUTLINE_DISABLE_DELETENofalsetrue = disable only delete operations (details)
OUTLINE_DISABLE_AI_TOOLSNofalsetrue = disable AI tools (for Outline instances without OpenAI)
OUTLINE_DYNAMIC_TOOL_LISTNofalsetrue = enable per-user tool filtering by role/key scopes (details)
OUTLINE_MAX_CONNECTIONSNo100Max concurrent connections in pool
OUTLINE_MAX_KEEPALIVENo20Max idle connections in pool
OUTLINE_TIMEOUTNo30.0Read timeout in seconds
OUTLINE_CONNECT_TIMEOUTNo5.0Connection timeout in seconds
OUTLINE_WRITE_TIMEOUTNo30.0Write timeout in seconds
MCP_TRANSPORTNostdioTransport mode: stdio (local), sse or streamable-http (remote)
MCP_HOSTNo127.0.0.1Server host. Use 0.0.0.0 in Docker for external connections
MCP_PORTNo3000HTTP server port (only for sse and streamable-http modes)

Access Control

FeatureEnv VarEffect
Read-only modeOUTLINE_READ_ONLY=trueDisables all write operations — only search, read, and export tools available
Disable deletesOUTLINE_DISABLE_DELETE=trueDisables only delete operations, all other writes allowed
Dynamic tool listOUTLINE_DYNAMIC_TOOL_LIST=trueFilters tools per-user based on Outline role and API key scopes
Per-user Outline API keysx-outline-api-key headerEach user passes their own Outline API key in HTTP mode for multi-user setups

Read-only mode takes precedence over disable-delete. See Configuration Guide for details.

Tools

Note: Tool availability depends on your access control settings.

Search & Discovery

  • search_documents(query, collection_id?, limit?, offset?) - Search documents by keywords with pagination
  • list_collections() - List all collections
  • get_collection_structure(collection_id) - Get document hierarchy within a collection
  • get_document_id_from_title(query, collection_id?) - Find document ID by title search

Document Reading

  • read_document(document_id) - Get document content
  • export_document(document_id) - Export document as markdown

Document Management

  • create_document(title, collection_id, text?, parent_document_id?, publish?) - Create new document
  • update_document(document_id, title?, text?, append?) - Update document (append mode available)
  • move_document(document_id, collection_id?, parent_document_id?) - Move document to different collection or parent

Document Lifecycle

  • archive_document(document_id) - Archive document
  • unarchive_document(document_id) - Restore document from archive
  • delete_document(document_id, permanent?) - Delete document (or move to trash)
  • restore_document(document_id) - Restore document from trash
  • list_archived_documents() - List all archived documents
  • list_trash() - List all documents in trash

Comments & Collaboration

  • add_comment(document_id, text, parent_comment_id?) - Add comment to document (supports threaded replies)
  • list_document_comments(document_id, include_anchor_text?, limit?, offset?) - View document comments with pagination
  • get_comment(comment_id, include_anchor_text?) - Get specific comment details
  • get_document_backlinks(document_id) - Find documents that link to this document

Collection Management

  • create_collection(name, description?, color?) - Create new collection
  • update_collection(collection_id, name?, description?, color?) - Update collection properties
  • delete_collection(collection_id) - Delete collection
  • export_collection(collection_id, format?) - Export collection (default: outline-markdown)
  • export_all_collections(format?) - Export all collections

FAQ

What is the Outline MCP server?
Outline is a Model Context Protocol (MCP) server profile on explainx.ai. MCP lets AI hosts (e.g. Claude Desktop, Cursor) call tools and resources through a standard interface; this page summarizes categories, install hints, and community ratings.
How do MCP servers relate to agent skills?
Skills are reusable instruction packages (often SKILL.md); MCP servers expose live capabilities. Teams frequently combine both—skills for workflows, MCP for APIs and data. See explainx.ai/skills and explainx.ai/mcp-servers for parallel directories.
How are reviews shown for Outline?
This profile displays 10 aggregated ratings (sample rows for discoverability plus signed-in user reviews). Average score is about 4.5 out of 5—verify behavior in your own environment before production use.
MCP server reviews

Ratings

4.510 reviews
  • Shikha Mishra· Oct 10, 2024

    Outline is among the better-indexed MCP projects we tried; the explainx.ai summary tracks the official description.

  • Piyush G· Sep 9, 2024

    We evaluated Outline against two servers with overlapping tools; this profile had the clearer scope statement.

  • Chaitanya Patil· Aug 8, 2024

    Useful MCP listing: Outline is the kind of server we cite when onboarding engineers to host + tool permissions.

  • Sakshi Patil· Jul 7, 2024

    Outline reduced integration guesswork — categories and install configs on the listing matched the upstream repo.

  • Ganesh Mohane· Jun 6, 2024

    I recommend Outline for teams standardizing on MCP; the explainx.ai page compares cleanly with sibling servers.

  • Oshnikdeep· May 5, 2024

    Strong directory entry: Outline surfaces stars and publisher context so we could sanity-check maintenance before adopting.

  • Dhruvi Jain· Apr 4, 2024

    Outline has been reliable for tool-calling workflows; the MCP profile page is a good permalink for internal docs.

  • Rahul Santra· Mar 3, 2024

    According to our notes, Outline benefits from clear Model Context Protocol framing — fewer ambiguous “AI plugin” claims.

  • Pratham Ware· Feb 2, 2024

    We wired Outline into a staging workspace; the listing’s GitHub and npm pointers saved time versus hunting across READMEs.

  • Yash Thakker· Jan 1, 2024

    Outline is a well-scoped MCP server in the explainx.ai directory — install snippets and categories matched our Claude Code setup.