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