MCP Outline Server

MCP Outline 服务

📢 Outline 官方 MCP 服务现已推出

Outline 现已提供官方 MCP 服务——我们建议使用该服务。 阅读文档。

一个用于与 Outline 文档管理系统交互的模型上下文协议服务。

功能

• 文档操作：搜索、读取、创建、编辑和归档文档
• 集合：列出、创建和管理文档层级结构
• 评论：添加和查看串联评论
• 反向链接：查找引用特定文档的文档
• MCP 资源：通过 URI 直接访问内容（outline://document/{id}、outline://collection/{id} 等）
• 自动速率限制：透明处理 API 限制并提供重试逻辑

前提条件

使用此 MCP 服务前，你需要：

• 一个 Outline 账户（云托管或可自托管）
• 从 Outline Web 界面获取 API 密钥：设置 → API 密钥 → 创建新密钥
• Python 3.10+（非 Docker 安装时）

获取 API 密钥：登录 Outline → 点击个人资料 → 设置 → API 密钥 → “新建 API 密钥”。复制生成的令牌。

快速开始

一键安装

点击按钮，通过交互式提示输入 API 密钥并安装：

手动安装

使用 uv（推荐）、pip 或 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

然后添加到 MCP 客户端配置中（适用于 VS Code、Claude Desktop、Cursor 等）：

{
  "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

{
  "mcpServers": {
    "mcp-outline": {
      "command": "uvx",
      "args": ["mcp-outline"],
      "env": {
        "OUTLINE_API_KEY": "<YOUR_API_KEY>",
        "OUTLINE_API_URL": "<YOUR_OUTLINE_URL>"
      }
    }
  }
}

更多客户端的设置指南：Docker (HTTP)、Cline、Codex、Windsurf 等

配置

访问控制

只读模式的优先级高于禁用删除。详情请参阅配置指南。

工具

注意：工具是否可用取决于你的访问控制设置。

搜索与发现

• search_documents(query, collection_id?, limit?, offset?, statusFilter?) - 按关键字搜索文档，支持分页。默认搜索已发布的文档；传入 statusFilter 以及 draft、archived 和/或 published，即可包含其他状态的文档
• list_recently_updated_documents(date_filter?, collection_id?, status_filter?, limit?, offset?) - 按最近变更时间列出文档，最新的排在前面（例如“本周有哪些变更”）。date_filter 按最后变更时间筛选：day/week/month/year（默认值为 week）。默认仅列出已发布的文档
• list_collections() - 列出所有集合
• get_collection_structure(collection_id) - 获取集合中的文档层级结构
• get_document_id_from_title(query, collection_id?) - 按标题搜索查找文档 ID

文档阅读

• read_document(document_id, offset?, limit?) - 获取文档内容，支持按行范围分页
• export_document(document_id) - 将文档导出为 Markdown

文档导航

• get_document_toc(document_id) - 获取包含标题结构和行号的目录
• read_document_section(document_id, heading) - 根据标题匹配（不区分大小写的子字符串）读取特定章节

文档管理

• create_document(title, collection_id, text?, parent_document_id?, publish?) - 创建新文档
• update_document(document_id, title?, text?, append?) - 替换整个文档内容（可使用追加模式）

文档编辑

• edit_document(document_id, edits, save?) - 通过字符串匹配批量替换来编辑；save=False 会在本地暂存更改，最后一次调用时使用 save=True 提交所有更改
• move_document(document_id, collection_id?, parent_document_id?) - 将文档移至其他集合或父文档下

文档生命周期

• archive_document(document_id) - 归档文档
• unarchive_document(document_id) - 从归档中恢复文档
• delete_document(document_id, permanent?) - 删除文档（或移至回收站）
• restore_document(document_id) - 从回收站恢复文档
• list_archived_documents() - 列出所有已归档文档
• list_trash() - 列出回收站中的所有文档

评论与协作

• add_comment(document_id, text, parent_comment_id?) - 向文档添加评论（支持线程式回复）
• list_document_comments(document_id, include_anchor_text?, limit?, offset?) - 分页查看文档评论
• get_comment(comment_id, include_anchor_text?) - 获取特定评论的详细信息
• get_document_backlinks(document_id) - 查找链接到此文档的文档

集合管理

• create_collection(name, description?, color?) - 创建新集合
• update_collection(collection_id, name?, description?, color?) - 更新集合属性
• delete_collection(collection_id) - 删除集合
• export_collection(collection_id, format?) - 导出集合（默认：outline-markdown）
• export_all_collections(format?) - 导出所有集合

批量操作

• batch_create_documents(documents) - 一次创建多个文档
• batch_update_documents(updates) - 一次更新多个文档
• batch_move_documents(document_ids, collection_id?, parent_document_id?) - 移动多个文档
• batch_archive_documents(document_ids) - 归档多个文档
• batch_delete_documents(document_ids, permanent?) - 删除多个文档

AI 驱动

• ask_ai_about_documents(question, collection_id?, document_id?) - 使用自然语言询问有关文档的问题

资源

• outline://collection/{id} - 集合元数据（名称、描述、颜色、文档数量）
• outline://collection/{id}/tree - 文档的层级树结构
• outline://collection/{id}/documents - 集合中的文档平铺列表
• outline://document/{id} - 完整文档内容（Markdown）
• outline://document/{id}/backlinks - 链接到此文档的文档

开发

git 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)

有关可自托管的 Outline 设置、MCP Inspector 等内容，请参阅开发指南。

故障排除

服务无法连接？ 测试你的 API 密钥：

curl -H "Authorization: Bearer YOUR_API_KEY" YOUR_OUTLINE_URL/api/auth.info

有关工具、速率限制和 Docker 的常见问题，请参阅故障排除指南。

贡献

欢迎贡献！请参阅 CONTRIBUTING.md 了解设置说明。

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

致谢

• 基于 MCP Python SDK 构建
• 使用 Outline API 管理文档