Skip to main content
Glama
ytrafimovich

mcp-outline

by ytrafimovich

mcp-outline

An MCP server that connects Claude Code to your Outline knowledge base, giving Claude tools to search and retrieve documents.

Tools

  • outline_search — full-text search across your Outline workspace

  • outline_get_document — fetch a document's full content by ID

Related MCP server: Outline Wiki MCP Server

Prerequisites

  • Node.js 18+

  • An Outline API key — go to Preferences → API & Access → New API key

    Use the scope documents:read to restrict the key to read-only document access:

    New API key dialog showing documents:read scope

Setup

1. Clone and install

git clone https://github.com/YOUR_USERNAME/mcp-outline.git ~/.claude/mcp-outline
cd ~/.claude/mcp-outline
npm install

You can clone it anywhere; ~/.claude/mcp-outline is just a tidy location that keeps it with your Claude config.

2. Register the MCP server globally

Run this once from your terminal to add the server to your user-level Claude Code config (available in every project):

claude mcp add -s user outline \
  npx tsx /Users/YOUR_USERNAME/.claude/mcp-outline/src/server.ts \
  --env OUTLINE_API_KEY=YOUR_OUTLINE_API_KEY \
  --env OUTLINE_BASE_URL=https://app.getoutline.com

Replace:

  • /Users/YOUR_USERNAME/.claude/mcp-outline with the actual absolute path where you cloned the repo

  • YOUR_OUTLINE_API_KEY with your Outline API key

  • Omit --env OUTLINE_BASE_URL=... if you use the default https://app.getoutline.com

The -s user flag registers the server at the user scope, so it is available globally in every Claude Code session without needing per-project configuration.

3. Verify

claude mcp list

outline should appear in the list of active MCP servers.

Usage

Once configured, Claude Code can use the Outline tools automatically when you ask questions about your docs:

"Search our Outline for the onboarding guide"

"Get the Outline document with ID abc-123"

License

ISC

Available Tools

2 tools
outline_get_documentC

Get an Outline document by ID

ParametersJSON Schema
NameRequiredDescriptionDefault
idYes

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, so the description carries full burden. It only states 'Get' without disclosing side effects, authentication needs, rate limits, or whether it is read-only. Minimal behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise with a single sentence, which is efficient for a simple tool. However, it could be slightly expanded to include key details without losing brevity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema and low schema coverage, the description should compensate with details about return values, errors, or prerequisites. It falls short, leaving the agent with insufficient information to fully understand the tool's behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, yet the description only adds 'by ID' which vaguely explains the parameter. It does not specify the format, source, or typical value of the 'id' parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Get an Outline document by ID' which is a specific verb+resource. It distinguishes from the sibling 'outline_search' by implying retrieval of a single document rather than searching. However, it could be more specific about what the document contains.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus outline_search or any alternatives. The description does not mention prerequisites, error conditions, or appropriate contexts.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updatesv1.0.0
    • First observedoutline_get_document
    • First observedoutline_search

TDQS

B3.1/5.0

Scored across 2 tools

Disambiguation5/5

The two tools have clearly distinct purposes: one retrieves a document by ID, and the other performs a search. There is no overlap or ambiguity.

Naming Consistency5/5

Both tools follow the pattern 'outline_<verb>[_<noun>]' with consistent snake_case and a common prefix, making them predictable.

Tool Count3/5

With only 2 tools, the surface is thin for a documentation server. While it covers basic retrieval and search, it lacks other expected operations, making it borderline.

Completeness3/5

The server provides get and search capabilities but is missing create, update, delete, and list operations. This represents notable gaps for typical document management.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers