MCP 大纲服务器

一个模型上下文协议 (MCP) 服务器，使 AI 助手能够与 Outline 进行交互 ( https://www.getoutline.com )

概述

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

特征

目前已实施：

文档搜索：按关键字搜索文档
收藏管理：列出收藏并查看文档结构
文档阅读：阅读文档内容，导出为markdown
评论管理：查看和添加文档评论
文档创建：在集合中创建新文档
文档编辑：更新文档内容和移动文档
反向链接管理：查看链接到特定文档的文档

入门

先决条件

Python 3.10+
具有 API 访问权限的概要帐户
Outline API 密钥（从您的 Outline 帐户设置中获取）

安装

# Clone the repository
git clone https://github.com/Vortiago/mcp-outline.git
cd mcp-outline

# Install in development mode
uv pip install -e ".[dev]"

配置

在项目根目录中创建一个.env文件，其中包含以下变量：

# Outline API Configuration
OUTLINE_API_KEY=your_outline_api_key_here

# For cloud-hosted Outline (default)
# OUTLINE_API_URL=https://app.getoutline.com/api

# For self-hosted Outline
# OUTLINE_API_URL=https://your-outline-instance.example.com/api

运行服务器

# Development mode with the MCP Inspector
mcp dev src/mcp_outline/server.py

# Or use the provided script
./start_server.sh

# Install in Claude Desktop (if available)
mcp install src/mcp_outline/server.py --name "Document Outline Assistant"

使用示例

搜索文档

Search for documents containing "project planning"

列表集合

Show me all available collections

阅读文档

Get the content of document with ID "docId123"

创建新文档

Create a new document titled "Research Report" in collection "colId456" with content "# Introduction\n\nThis is a research report..."

添加评论

Add a comment to document "docId123" saying "This looks great, but we should add more details to the methodology section."

移动文档

Move document "docId123" to collection "colId789"

贡献

欢迎贡献代码！欢迎提交 Pull 请求。

发展

# Run tests
uv run pytest tests/

# Format code
uv run ruff format .

执照

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅LICENSE文件。

致谢

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

MCP Outline Server

Integrations