outline-wiki-mcp
v1.0.0
Published
MCP server for Outline wiki integration
Readme
Outline Wiki MCP Server
A Model Context Protocol server for Outline wiki integration. Enables LLM applications to search, read, create, and manage wiki documents through a standardized interface.
Features
- Full-text Search - Find documents across your entire wiki
- Document Management - Create, read, update, delete, and move documents
- Collection Organization - Browse and manage document collections
- Archive & Restore - Soft-delete with archive/restore functionality
- Draft Access - Work with unpublished drafts
- Markdown Export - Export documents as clean markdown
- MCP Resources - Browse collections and documents via resource URIs
Installation
npx outline-wiki-mcpOr install globally:
npm install -g outline-wiki-mcpConfiguration
Environment Variables
| Variable | Required | Description |
| ------------------ | -------- | ------------------------------------------------ |
| OUTLINE_BASE_URL | Yes | Your Outline instance URL |
| OUTLINE_API_KEY | Yes | API key from Outline settings (starts ol_api_) |
Getting an API Key
- Open Outline > Settings > API
- Click Create API Key
- Copy the key (starts with
ol_api_)
Config File (Alternative)
Use a JSON config file with the --config flag:
{
"baseUrl": "https://your-instance.getoutline.com",
"apiKey": "ol_api_xxx"
}Client Setup
Add to your claude_desktop_config.json:
Using npx:
{
"mcpServers": {
"outline": {
"command": "npx",
"args": ["-y", "outline-wiki-mcp"],
"env": {
"OUTLINE_BASE_URL": "https://your-instance.getoutline.com",
"OUTLINE_API_KEY": "ol_api_xxx"
}
}
}
}Using Docker:
{
"mcpServers": {
"outline": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"OUTLINE_BASE_URL=https://your-instance.getoutline.com",
"-e",
"OUTLINE_API_KEY=ol_api_xxx",
"ghcr.io/raisedadead/outline-wiki-mcp"
]
}
}
}claude mcp add outline \
-e OUTLINE_BASE_URL=https://your-instance.getoutline.com \
-e OUTLINE_API_KEY=ol_api_xxx \
-s user \
-- npx -y outline-wiki-mcpVerify with /mcp after restarting.
Add to your VS Code settings.json:
{
"mcp.servers": {
"outline": {
"command": "npx",
"args": ["-y", "outline-wiki-mcp"],
"env": {
"OUTLINE_BASE_URL": "https://your-instance.getoutline.com",
"OUTLINE_API_KEY": "ol_api_xxx"
}
}
}
}This server uses stdio transport. Configure your MCP client to run:
OUTLINE_BASE_URL=https://your-instance.getoutline.com \
OUTLINE_API_KEY=ol_api_xxx \
npx outline-wiki-mcpOr with a config file:
npx outline-wiki-mcp --config /path/to/config.jsonTools
Document Operations
| Tool | Description |
| ---------------------------- | --------------------------------------- |
| outline_search | Full-text search across all documents |
| outline_get_document | Retrieve document content by ID |
| outline_list_documents | List documents in a collection |
| outline_create_document | Create a new document |
| outline_update_document | Update an existing document |
| outline_move_document | Move document to a different collection |
| outline_delete_document | Permanently delete a document |
| outline_archive_document | Archive a document (soft delete) |
| outline_unarchive_document | Restore an archived document |
| outline_list_drafts | List all unpublished drafts |
| outline_export_document | Export document as clean markdown |
Collection Operations
| Tool | Description |
| --------------------------- | ---------------------------- |
| outline_list_collections | List all collections |
| outline_get_collection | Get collection details by ID |
| outline_create_collection | Create a new collection |
| outline_update_collection | Update collection properties |
| outline_delete_collection | Delete a collection |
Resources
Browse your wiki structure using resource URIs:
| URI Pattern | Description |
| ---------------------------- | --------------------------------- |
| outline://collections | List all collections |
| outline://collections/{id} | Collection details with documents |
| outline://documents/{id} | Document content in markdown |
Development
pnpm install # Install dependencies
pnpm build # Compile TypeScript
pnpm dev # Watch mode
pnpm test # Run tests
pnpm lint # Type-checkLocal Testing
OUTLINE_BASE_URL=https://your-instance.getoutline.com \
OUTLINE_API_KEY=ol_api_xxx \
node dist/index.jsContributing
Contributions are welcome. See CONTRIBUTING.md for development setup, testing guidelines, and commit conventions.
License
MIT - see LICENSE
Links
- Outline - Knowledge base for teams
- Outline API - API reference
- Model Context Protocol - MCP specification
- MCP Servers - Reference implementations
