Outline MCP

MCP大纲服务器

## 📢 官方概述MCP服务器可用 大纲现在发货 官方MCP服务器 --我们建议使用它。 阅读文档.

______________________________________________________________________

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

特性

• 文档操作：搜索、阅读、创建、编辑、存档文档
• 集合：列出、创建、管理文档层次结构
• 评论：添加和查看线程评论
• 导入链接：查找引用特定文档的文档
• MCP资源：通过URI直接访问内容(outline://document/{id}，outline://collection/{id}等）
• 自动速率限制：使用重试逻辑透明处理API限制

先决条件

在使用此MCP服务器之前，您需要：

• 一 大纲 帐户（云托管或自托管）
• 大纲web UI中的API键： 设置→ API密钥→ 新建
• Python 3.10+（适用于非Docker安装）

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

快速开始

一键安装

点击一个按钮，使用交互式API键提示进行安装：

%22%2C%22password%22%3Afalse%7D%5D&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22mcp-outline%22%5D%2C%22env%22%3A%7B%22OUTLINE_API_KEY%22%3A%22%24%7Binput%3Aoutline_api_key%7D%22%2C%22OUTLINE_API_URL%22%3A%22%24%7Binput%3Aoutline_api_url%7D%22%7D%7D>) %22%2C%22password%22%3Afalse%7D%5D&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22mcp-outline%22%5D%2C%22env%22%3A%7B%22OUTLINE_API_KEY%22%3A%22%24%7Binput%3Aoutline_api_key%7D%22%2C%22OUTLINE_API_URL%22%3A%22%24%7Binput%3Aoutline_api_url%7D%22%7D%7D&quality=insiders>)

手动安装

使用uv（推荐）、pip或Docker安装：

uvx mcp-outline          # using uv
pip install mcp-outline   # using pip

# using Docker
docker run -e OUTLINE_API_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 Code

claude mcp add mcp-outline uvx mcp-outline

Claude Desktop

添加 ~/Library/Application Support/Claude/claude_desktop_config.json:

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

更多客户端的设置指南：

配置

访问控制

只读模式优先于禁用删除。看 配置指南 了解详情。

工具

备注：工具可用性取决于您的 访问控制 设置。

搜索与发现

• search_documents(query, collection_id?, limit?, offset?) -按关键字分页搜索文档
• list_collections() -列出所有收藏
• get_collection_structure(collection_id) -获取集合中的文档层次结构
• get_document_id_from_title(query, collection_id?) -通过标题搜索查找文档ID

文档阅读

• read_document(document_id) -获取文档内容
• export_document(document_id) -将文档导出为标记

文档管理

• create_document(title, collection_id, text?, parent_document_id?, publish?) -创建新文档
• update_document(document_id, title?, text?, append?) -更新文档（附加模式可用）
• 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?) -导出集合（默认：大纲标记）
• 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} -完整文档内容（标记）
• 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)

看 开发指南 用于自托管大纲设置、MCP检查器等。

故障排除

服务器未连接？ 测试您的API密钥：

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

看 故障排除指南 关于工具、速率限制和Docker的常见问题。

贡献

欢迎投稿！看 贡献.md 有关设置说明。

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

致谢

• 内置于 MCP Python SDK
• 用途 API大纲 用于文档管理