Installation

Prerequisites

Before installing, make sure you have:

• Node.js 20+
• npm (or pnpm for monorepo workflows)
• An Outline API key

Option A: Install from npm (recommended)

This is the fastest path for most users.

npm i -g @sigee-min/outline-mcp
outline-mcp

If you do not want a global install, run directly:

npx -y @sigee-min/outline-mcp

Option B: Run from source (monorepo)

Use this when you want to develop or customize locally.

git clone <repo-url>
cd outline-mcp
pnpm install
pnpm --filter @sigee-min/outline-mcp build
pnpm --filter @sigee-min/outline-mcp dev

Required environment variables

OUTLINE_API_KEY is required to run the MCP server.

OUTLINE_API_KEY=your_api_key
OUTLINE_BASE_URL=https://app.getoutline.com
OUTLINE_ALLOWED_ACTIONS=read,write,delete

For self-hosted Outline, set OUTLINE_BASE_URL to your own endpoint.

Quick verification

After build, validate that the package can expose tools:

pnpm --filter @sigee-min/outline-mcp build
pnpm -s dlx @modelcontextprotocol/inspector --cli node apps/mcp/dist/index.js --method tools/list

If this succeeds, your runtime wiring is working.

Next step

Continue to MCP Client Setup.