mcp-outline

🚀 MCP 文档服务器

本项目所实现的模型上下文协议（MCP）服务器，能让 AI 助手与 Outline（https://www.getoutline.com）文档服务展开交互，搭建起自然语言交互和 Outline 文档管理能力的桥梁。

🚀 快速开始

本项目实现了一个模型上下文协议（MCP）服务器，允许 AI 助手（如 Claude）与 Outline 文档管理功能进行交互，搭建自然语言交互与 Outline 文档管理能力之间的桥梁。

✨ 主要特性

当前已实现的功能如下：

• 文档搜索：通过关键词搜索文档
• 集合管理：列出所有可用的集合，并查看文档结构
• 文档阅读：获取文档内容，导出为 Markdown 格式
• 评论管理：查看和添加文档上的评论
• 文档创建：在指定集合中新建文档
• 文档编辑：更新文档内容并移动文档
• 反向链接管理：查看引用特定文档的其他文档

📦 安装指南

依赖项

• Python 3.10+
• Outline 账户及 API 访问权限
• Outline API Key（从您的 Outline 账户设置中获取）

安装步骤

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

# 以开发模式安装
uv pip install -e ".[dev]"

配置

在项目根目录创建一个 .env 文件，添加以下变量：

# Outline API 配置
OUTLINE_API_KEY=your_outline_api_key_here

# 对于云端部署的 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 Desktop 中安装（如果可用）
mcp install src/mcp_outline/server.py --name "文档大纲助手"

💻 使用示例

基础用法

搜索文档

搜索包含“项目计划”关键词的文档

列示集合

显示所有可用的集合

阅读文档

获取 ID 为“docId123”的文档内容

创建新文档

在集合“colId456”中创建名为“研究报告”的新文档，内容如下：
# 引言

这是一个研究报道...

添加评论

向 ID 为“docId123”的文档添加一条评论：“这份看起来很棒，但我们应在方法论部分添加更多细节。”

移动文档

将文档“docId123”移动到集合“colId789”

📚 详细文档

开发

# 运行测试
uv run pytest tests/

# 格式化代码
uv run ruff format .

📄 许可证

本项目在 MIT 许可证下开源，详情请查看 LICENSE 文件。

致谢

• 使用 MCP Python SDK 构建
• 采用 Outline API 进行文档管理