Outline

You run a dedicated MCP server that acts as the bridge between your Outline API usage and your client tools. It provides a fast, reliable way to interact with Outline data and documents through a simple, configurable interface that can run locally or be exposed via HTTP.

How to use

You connect your MCP client to the server to perform actions such as creating, retrieving, updating, and organizing documents and collections. The server exposes a straightforward set of operations that your client can call using the MCP protocol. You can run in STDIO mode for local, on-demand interactions, or in HTTP mode to accept requests over a network.

How to install

Prerequisites: you need a Rust toolchain installed if you build from source, plus a stable shell environment. You may also use a pre-built binary or a package manager as described.

Step 1: Choose an installation method from the options below.

Step 2: Install or download the binary.

Step 3: Run the server in STDIO or HTTP mode as described in the configuration section.

Configuration and usage notes

Configure your MCP client to connect to the server using the appropriate mode. The following configuration shows how you define a server named Outline knowledge base that runs locally and uses an API key for Outline access.

{
  "mcpServers": {
    "Outline knowledge base": {
      "command": "outline-mcp",
      "env": {
        "OUTLINE_API_KEY": "your-api-key-here",
        "OUTLINE_API_URL": "https://app.getoutline.com/api"
      }
    }
  }
}
```"}]} ,{

What to run and where to start

To start in STDIO mode, set the required API key in your environment and run the binary directly in your shell. In HTTP mode, set host and port, then start the server to listen for incoming connections.

Available tools

create_document

Create a new document in a collection.

get_document

Retrieve a document by its ID.

update_document

Update the contents or metadata of an existing document.

delete_document

Remove a document from the store.

list_documents

List documents with optional filtering and sorting.

search_documents

Search documents by a query string.

archive_document

Archive a document to reduce visibility without deleting it.

move_document

Move a document between collections.

create_collection

Create a new collection to organize documents.

get_collection

Retrieve details about a collection.

update_collection

Update collection metadata.

list_collections

List all collections available.

create_comment

Add a comment to a document for collaboration.

update_comment

Edit an existing comment.

delete_comment

Remove a comment from a document.

create_template_from_document

Create reusable templates from existing documents.

list_users

Manage and list users with access to the Outline data.