4.12.3 (2025-03-21)

### Bug Fixes

docs:* correct API URL env var name in README (a2854f8)") | Mar 21, 2025 |

Skip to content

You signed in with another tab or window. Reload
to refresh your session. You signed out in another tab or window. Reload
to refresh your session. You switched accounts on another tab or window. Reload
to refresh your session. Dismiss alert

mmmeff / outline-mcp-server Public

• Notifications
  You must be signed in to change notification settings

• Fork 1

• Star 6

6 stars
1 fork
Branches
Tags
Activity

Star

Notifications
You must be signed in to change notification settings

mmmeff/outline-mcp-server

master

1 Branch
21 Tags

Go to file

Code

Folders and files

| Name | | Name | Last commit message | Last commit date |
| --- | --- | --- | --- |
| Latest commit
-------------


mmmeff

chore(docs): Update .env.example to use correct env var for API URL

Mar 24, 2025

c48cf8a
 · Mar 24, 2025

History
-------

81 Commits

| | |
| .github/workflows | | .github/workflows | feat: adopt semantic release | Mar 16, 2025 |
| bin | | bin | Add CLI check for OUTLINE_API_KEY env var | Mar 14, 2025 |
| scripts | | scripts | feat: adopt semantic release | Mar 16, 2025 |
| src | | src | fix: failure to dynamically load tools when running transpiled code | Mar 16, 2025 |
| .cursorrules | | .cursorrules | chore: add cursorRules | Mar 16, 2025 |
| .env.example | | .env.example | chore(docs): Update .env.example to use correct env var for API URL | Mar 24, 2025 |
| .gitignore | | .gitignore | chore: naive implementation on auto-smoke testing | Mar 16, 2025 |
| .npmignore | | .npmignore | add npmignore | Mar 14, 2025 |
| .prettierignore | | .prettierignore | add prettier to project | Mar 16, 2025 |
| .prettierrc | | .prettierrc | add prettier to project | Mar 16, 2025 |
| .releaserc.json | | .releaserc.json | feat: adopt semantic release | Mar 16, 2025 |
| CHANGELOG.md | | CHANGELOG.md | chore(release): 4.12.3 [skip ci] | Mar 21, 2025 |
| CONTRIBUTING.md | | CONTRIBUTING.md | feat: adopt semantic release | Mar 16, 2025 |
| README.md | | README.md | docs: fix api url env var | Mar 18, 2025 |
| package-lock.json | | package-lock.json | chore: naive implementation on auto-smoke testing | Mar 16, 2025 |
| package.json | | package.json | chore(release): 4.12.3 [skip ci] | Mar 21, 2025 |
| playwright.config.ts | | playwright.config.ts | fix: restore src->build config to not break everything else | Mar 16, 2025 |
| tsconfig.json | | tsconfig.json | fix: failure to dynamically load tools when running transpiled code | Mar 16, 2025 |
| View all files | | |

Repository files navigation

Outline MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with Outline
's API, enabling AI agents to manage documents, collections, and other entities programmatically through the Outline knowledge base platform.

Features

• Document Management

  • ✅ Create new documents with customizable properties
  • ✅ Get document details
  • ✅ Update existing documents
  • ✅ Delete documents
  • ✅ List documents
  • ✅ Search documents
  • ✅ Ask natural language questions about documents
  • ✅ Create templates from existing documents
  • ✅ Move documents to different collections or locations
  • ✅ Archive documents

  • Collection Management

  • ✅ Get collection details

  • ✅ List collections
  • ✅ Create and update collections

  • Comment Management

  • ✅ Create comments on documents

  • ✅ Update existing comments
  • ✅ Delete comments

  • User Management

  • ✅ List and filter users

Note: The SSE server implementation uses Supergateway
, which provides more reliable connectivity when used with Cursor's MCP integration.

Quick Start

Prerequisites

• Node.js (v18 or higher)
• An Outline account with API access
• Outline API key with appropriate permissions

Installation

# Run directly with npx
OUTLINE_API_KEY=… npx outline-mcp-server

# or install from npm
npm install -g outline-mcp-server
OUTLINE_API_KEY=… outline-mcp-server

# Run with a custom port (default is 6060)
OUTLINE_API_KEY=… outline-mcp-server --port 7070

Env

• OUTLINE_API_KEY (required): your API key for outline, duh
• OUTLINE_API_URL (optional): Alternative URL for your outline API (if using an alt domain/self-hosting)

CLI Options

• --port <number> (optional): Specify the port on which the server will run (default: 6060)

Usage

Once installed, you can use the MCP server with AI assistants that support the Model Context Protocol, such as Claude via Cursor.

Example queries your AI assistant can now handle:

• "List all the documents in my Outline workspace"
• "Create a new document in the 'Product' collection"
• "Find all documents related to a specific topic"
• "Ask a natural language question about your documents"
• "Create a template from an existing document"
• "Update the content of a document"
• "Add a comment to a document"

Development

# Clone this repository
git clone https://github.com/mmmeff/outline-mcp.git
cd outline-mcp

# Install dependencies
npm install

Create a .env file with your Outline API key:

OUTLINE_API_KEY=your_outline_api_key_here
OUTLINE_API_URL=https://your-outline-instance.com/api  # Optional, defaults to https://app.getoutline.com/api

# Builds/watches the project alongside running @modelcontextprotocol/inspector
npm run dev

Contributing

This project uses semantic-release
for automated versioning and package publishing. Please follow the Conventional Commits
specification for your commit messages to ensure proper versioning.

See CONTRIBUTING.md
for detailed guidelines on how to contribute to this project.

Release Process

Releases are fully automated using semantic-release and GitHub Actions. When commits are pushed to the master branch, the following happens:

1. The CI pipeline runs tests and builds the package
2. semantic-release analyzes commit messages to determine the next version number
3. A new version is automatically published to npm
4. A GitHub release is created with auto-generated release notes
5. The CHANGELOG.md file is updated

No manual version bumping or release creation is needed.

License

MIT

About

No description, website, or topics provided.

Resources

Readme

Activity

Stars

6 stars

Watchers

1 watching

Forks

1 fork

Report repository

Releases 14

v4.12.3 Latest\
\
Mar 21, 2025

+ 13 releases

Packages 0

No packages published

Contributors 3

• 
  mmmeff Matt

• 
  semantic-release-bot Semantic Release Bot

• 
  actus-wirtenberger Philipp Wirtenberger

Languages

• TypeScript 92.0%

• JavaScript 7.8%

• Shell 0.2%

You can’t perform that action at this time.