Outline MCP Server

🚀 Outline MCP 服務器概述

Outline MCP 服務器是一個模型上下文協議（MCP）服務器，它提供了與 Outline 的 API 進行交互的工具。藉助該服務器，AI 代理能夠通過 Outline 知識庫平臺，以程序化的方式管理文檔、集合和其他實體。

🚀 快速開始

先決條件

• Node.js（v18 或更高版本）
• 帶有 API 訪問權限的 Outline 賬戶
• 帶有適當權限的 Outline API 密鑰

安裝

# 直接使用 npx 運行
OUTLINE_API_KEY=… npx outline-mcp-server

# 或從 npm 安裝
npm install -g outline-mcp-server
OUTLINE_API_KEY=… outline-mcp-server

# 使用自定義端口運行（默認是 6060）
OUTLINE_API_KEY=… outline-mcp-server --port 7070

環境變量

• OUTLINE_API_KEY（必填）：您的 Outline API 密鑰。
• OUTLINE_API_URL（可選）：使用備用域名或自託管的 Outline API 的替代 URL。

CLI 選項

• --port <number>（可選）：指定服務器運行的端口（默認：6060）。

使用方法

安裝完成後，您可以使用支持模型上下文協議的 AI 助手（例如通過 Cursor 的 Claude）與 MCP 服務器交互。

示例查詢您的 AI 助手現在可以處理：

• “列出我所有 Outline 工作區中的文檔”
• “在‘產品’集合中創建新文檔”
• “查找特定主題相關的所有文檔”
• “對您的文檔提出自然語言問題”
• “從現有文檔創建模板”
• “更新文檔內容”
• “向文檔添加評論”

✨ 主要特性

文檔管理

• ✅ 創建具有自定義屬性的新文檔
• ✅ 獲取文檔詳細信息
• ✅ 更新現有文檔
• ✅ 刪除文檔
• ✅ 列出文檔
• ✅ 搜索文檔
• ✅ 對文檔提出自然語言問題
• ✅ 從現有文檔創建模板
• ✅ 將文檔移動到不同的集合或位置
• ✅ 歸檔文檔

集合管理

• ✅ 獲取集合詳細信息
• ✅ 列出集合
• ✅ 創建和更新集合

評論管理

• ✅ 在文檔上創建評論
• ✅ 更新現有評論
• ✅ 刪除評論

用戶管理

• ✅ 列出並過濾用戶

⚠️ 重要提示

SSE 服務器實現使用 Supergateway，在與 Cursor 的 MCP 集成時提供更可靠的連接。

🛠️ 開發

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

# 安裝依賴項
npm install

創建一個包含您的 Outline API 密鑰的 .env 文件：

OUTLINE_API_KEY=your_outline_api_key_here
OUTLINE_API_URL=https://your-outline-instance.com/api  # 可選，默認為 https://app.getoutline.com/api

# 構建/監視項目的同時運行 @modelcontextprotocol/mcp-ai
npm run dev

🤝 貢獻

歡迎貢獻！請參考 CONTRIBUTING.md。

📄 許可證

MIT License

📞 聯繫方式

• 作者：mmmeff
• 倉庫：GitHub 上的 outline-mcp