Outline

🚀 MCP Outline 服務器

MCP Outline 服務器是一個模型上下文協議（MCP）服務器，它充當自然語言交互與 Outline 文檔管理功能之間的橋樑，能讓 AI 助手與 Outline（https://www.getoutline.com）的文檔服務實現交互。

🚀 快速開始

該項目實現了一個模型上下文協議（MCP）服務器，允許 AI 助手（如 Claude）與 Outline 文檔服務交互，提供一個連接自然語言交互與 Outline 文檔管理能力的橋樑。

✨ 主要特性

目前已實現的功能：

• 文檔搜索：通過關鍵詞搜索文檔
• 集合管理：列出所有可用的集合，並查看文檔結構
• 文檔閱讀：讀取文檔內容，導出為 Markdown 格式
• 評論管理：查看和添加文檔上的評論
• 文檔創建：在指定集合中新建文檔
• 文檔編輯：更新文檔內容並移動文檔
• 反向鏈接管理：查看與特定文檔相關的其他文檔

📦 安裝指南

先決條件

• Python 3.10+ 版本
• Outline 賬戶及 API 訪問權限
• Outline API 密鑰（從你的 Outline 賬戶設置中獲取）

安裝

# 克隆倉庫
git clone https://github.com/Vortiago/mcp-outline.git
cd mcp-outline

# 以開發模式安裝
uv pip install -e ".[dev]"

配置

在項目根目錄下創建一個 .env 文件，並添加以下變量：

# Outline API 配置
OUTLINE_API_KEY=你的Outline_API_密鑰

# 適用於雲端部署的 Outline（默認）
# OUTLINE_API_URL=https://app.getoutline.com/api

# 適用於自託管的 Outline
# OUTLINE_API_URL=https://your-outline-instance.example.com/api

運行服務器

# 開發模式與 MCP 監視器一起運行
mcp dev src/mcp_outline/server.py

# 或使用提供的腳本
./start_server.sh

# 在 Claude 桌面版中安裝（如果有）
mcp install src/mcp_outline/server.py --name "文檔大綱助手"

💻 使用示例

基礎用法

搜索文檔

搜索包含“項目規劃”的文檔

列出集合

顯示所有可用的集合

閱讀文檔

獲取 ID 為“docId123”的文檔內容

創建新文檔

在集合“colId456”中新建一個名為“研究報告”的文檔，內容如下：
# 引言

這是研究報告的開頭部分...

添加評論

向 ID 為“docId123”的文檔添加一條評論：“這份看起來很不錯，但我們在方法論部分應該加入更多細節。”

移動文檔

將文檔“docId123”移動到集合“colId789”

📚 詳細文檔

貢獻

歡迎貢獻！請隨時提交 Pull Request。

開發

# 運行測試
uv run pytest tests/

# 格式化代碼
uv run ruff format .

📄 許可證

該項目在 MIT 許可證下開源，詳情請查看 LICENSE 文件。

致謝

• 使用 MCP Python SDK 構建
• 與 Outline API 結合使用進行文檔管理