MCP Outline Server
📢 Official Outline MCP Server Available
Outline now ships an official MCP server — we recommend using it. Read the docs.
接入你的智能体
發布者自己的指令。不是 PlugMCP 端點。
用我們的金鑰與日誌託管一份副本。
uvx mcp-outline==1.11.0Claude Code 沒有本機指令的安裝連結。複製下方指令並在終端機中執行。
OUTLINE_API_KEY=<secret> OUTLINE_API_URL=<value> claude mcp add vortiago-mcp-outline -- uvx mcp-outline==1.11.0在終端機中執行。
{ "mcpServers": { "vortiago-mcp-outline": { "command": "uvx", "args": [ "mcp-outline==1.11.0" ], "env": { "OUTLINE_API_KEY": "<secret>", "OUTLINE_API_URL": "<value>" } } }}claude_desktop_config.json
遠端 URL 還是本機指令? 兩種安裝方式的差異
來自發布者
📢 Official Outline MCP Server Available
Outline now ships an official MCP server — we recommend using it. Read the docs.
A Model Context Protocol (MCP) server enabling AI assistants to interact with Outline documentation services.
A Model Context Protocol server for interacting with Outline document management.
Before using this MCP server, you need:
Getting your API key: Log into Outline → Click your profile → Settings → API Keys → "New API Key". Copy the generated token.
Click a button to install with interactive API key prompt:
Install with uv (recommended), pip, or Docker:
uvx mcp-outline # using uv
pip install mcp-outline # using pip
# using Docker
docker run -e OUTLINE_API_KEY=<your-key> ghcr.io/vortiago/mcp-outline:latest
Then add to your MCP client config (works with VS Code, Claude Desktop, Cursor, and others):
{
"inputs": [
{
"id": "outline_api_key",
"type": "promptString",
"description": "Enter OUTLINE_API_KEY",
"password": true
},
{
"id": "outline_api_url",
"type": "promptString",
"description": "Outline API URL (optional, for self-hosted)",
"password": false
}
],
"servers": {
"mcp-outline": {
"command": "uvx",
"args": ["mcp-outline"],
"env": {
"OUTLINE_API_KEY": "${input:outline_api_key}",
"OUTLINE_API_URL": "${input:outline_api_url}"
}
}
}
}
claude mcp add mcp-outline uvx mcp-outline
Installing the repo as a plugin instead also bundles the
outline-explorer agent (fast read-only wiki exploration) and the
outline skill (Outline conventions: mermaidjs fences, document
structure, editing workflows).
Add to ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"mcp-outline": {
"command": "uvx",
"args": ["mcp-outline"],
"env": {
"OUTLINE_API_KEY": "<YOUR_API_KEY>",
"OUTLINE_API_URL": "<YOUR_OUTLINE_URL>"
}
}
}
}
Setup guides for more clients: Docker (HTTP), Cline, Codex, Windsurf, and others
Read-only mode takes precedence over disable-delete. See Configuration Guide for details.
Note: Tool availability depends on your access control settings.
search_documents(query, collection_id?, limit?, offset?, statusFilter?) - Search documents by keywords with pagination. Defaults to published documents; pass statusFilter with draft, archived, and/or published to include other stateslist_recently_updated_documents(date_filter?, collection_id?, status_filter?, limit?, offset?) - List documents by most recent change, newest first (e.g. "what changed this week"). date_filter windows by last change: day/week/month/year (default week). Defaults to published documentslist_collections() - List all collectionsget_collection_structure(collection_id) - Get document hierarchy within a collectionget_document_id_from_title(query, collection_id?) - Find document ID by title searchread_document(document_id, offset?, limit?) - Get document content with optional line-range paginationexport_document(document_id) - Export document as markdownget_document_toc(document_id) - Get table of contents with heading structure and line numbersread_document_section(document_id, heading) - Read a specific section by heading match (case-insensitive substring)create_document(title, collection_id, text?, parent_document_id?, publish?) - Create new documentupdate_document(document_id, title?, text?, append?) - Replace full document content (append mode available)edit_document(document_id, edits, save?) - String-match editing with batched replacements; save=False stages changes locally, save=True on the final call pushes all changesmove_document(document_id, collection_id?, parent_document_id?) - Move document to different collection or parentarchive_document(document_id) - Archive documentunarchive_document(document_id) - Restore document from archivedelete_document(document_id, permanent?) - Delete document (or move to trash)restore_document(document_id) - Restore document from trashlist_archived_documents() - List all archived documentslist_trash() - List all documents in trashadd_comment(document_id, text, parent_comment_id?) - Add comment to document (supports threaded replies)list_document_comments(document_id, include_anchor_text?, limit?, offset?) - View document comments with paginationget_comment(comment_id, include_anchor_text?) - Get specific comment detailsget_document_backlinks(document_id) - Find documents that link to this documentcreate_collection(name, description?, color?) - Create new collectionupdate_collection(collection_id, name?, description?, color?) - Update collection propertiesdelete_collection(collection_id) - Delete collectionexport_collection(collection_id, format?) - Export collection (default: outline-markdown)export_all_collections(format?) - Export all collectionsbatch_create_documents(documents) - Create multiple documents at oncebatch_update_documents(updates) - Update multiple documents at oncebatch_move_documents(document_ids, collection_id?, parent_document_id?) - Move multiple documentsbatch_archive_documents(document_ids) - Archive multiple documentsbatch_delete_documents(document_ids, permanent?) - Delete multiple documentsask_ai_about_documents(question, collection_id?, document_id?) - Ask natural language questions about your documentsoutline://collection/{id} - Collection metadata (name, description, color, document count)outline://collection/{id}/tree - Hierarchical document tree structureoutline://collection/{id}/documents - Flat list of documents in collectionoutline://document/{id} - Full document content (markdown)outline://document/{id}/backlinks - Documents that link to this documentgit clone https://github.com/Vortiago/mcp-outline.git
cd mcp-outline
uv sync --group dev
uv run poe test-unit # unit tests
uv run poe test-integration # integration tests (starts MCP server via stdio)
uv run poe test-e2e # E2E tests (requires Docker)
See Development Guide for self-hosted Outline setup, MCP Inspector, and more.
Server not connecting? Test your API key:
curl -H "Authorization: Bearer YOUR_API_KEY" YOUR_OUTLINE_URL/api/auth.info
See Troubleshooting Guide for common issues with tools, rate limiting, and Docker.
Contributions welcome! See CONTRIBUTING.md for setup instructions.
This project is licensed under the MIT License - see the LICENSE file for details.
A Model Context Protocol (MCP) server enabling AI assistants to interact with Outline documentation services.
{ "mcpServers": { "vortiago-mcp-outline": { "command": "uvx", "args": [ "mcp-outline==1.11.0" ], "env": { "OUTLINE_API_KEY": "<secret>", "OUTLINE_API_URL": "<value>" } } }}工具
尚無工具清單。遠端伺服器會在首次健康檢查後取得工具清單。
常見問題
在本頁複製適用於 Cursor、Claude Desktop、Claude Code 或 VS Code 的 stdio 設定。它使用發布者的安裝方式,而不是 PlugMCP 代理伺服器。
發布者列出了以下環境變數:OUTLINE_API_KEY, OUTLINE_API_URL。
MCP Outline 透過 stdio 在本機執行。
上次檢查時間:2026-11-17。 A Model Context Protocol (MCP) server enabling AI assistants to interact with Outline documentation services.