\[！警告\] 由于Outline已经推出了自己的项目，因此不再维护此项目 官方MCP服务器 支持OAuth。你应该用它。
______________________________________________________________________
概述MCP服务器
•
一种模型上下文协议（MCP）服务器，提供与以下对象交互的工具 大纲的API，使人工智能代理能够通过Outline知识库平台以编程方式管理文档、集合和其他实体。
快速安装
光标
在Cursor中单击安装：
克劳德桌面版
您现在可以从以下网址下载Claude Desktop扩展 发布页面 快速简单的设置（只需双击它）。
克劳德代码
使用以下命令将Outline MCP服务器添加到Claude Code中：
claude mcp add outline -s user -t stdio -e OUTLINE_API_KEY=... -- npx -y --package=outline-mcp-server@latest -c outline-mcp-server-stdio其他方法
使用适当的命令定义，可以将此MCP服务器添加到几乎任何代理中 npx 以及env变量。有关如何手动运行服务器的更多信息，请阅读下面的内容。 跳到跑步→
特性
- 文档管理
- ✅ 创建具有可自定义属性的新文档 - ✅ 获取文档详细信息 - ✅ 更新现有文档 - ✅ 删除文档 - ✅ 列出文件 - ✅ 搜索文档 - ✅ 询问有关文档的自然语言问题 - ✅ 从现有文档创建模板 - ✅ 将文档移动到不同的集合或位置 - ✅ 归档文件
- 收集管理
- ✅ 获取收藏详细信息 - ✅ 列出收藏 - ✅ 创建和更新集合
- 评论管理
- ✅ 列出文档和集合的注释 - ✅ 在文档上创建注释 - ✅ 更新现有评论 - ✅ 删除评论
- 用户管理
- ✅ 列出并筛选用户
快速开始
先决条件
- Node.js（v24或更高版本）
- 具有API访问权限的大纲帐户
- 使用适当权限概述API密钥
- 注意：如果您需要使用AI驱动的询问功能，则必须在大纲工作区设置中启用“AI答案”功能
跑步
outline-mcp-server 支持最新的流式http协议、弃用的sse协议和老式的stdio。
# S-HTTP/SSE servers (with optional env var)
OUTLINE_API_KEY=... npx -y outline-mcp-server@latest
# S-HTTP/SSE servers (without env var, use headers for auth)
npx -y outline-mcp-server@latest
# STDIO (requires env var)
OUTLINE_API_KEY=... npx -y --package=outline-mcp-server@latest -c outline-mcp-server-stdio当运行没有环境变量的HTTP/SSE服务器时，您需要在请求头中提供API密钥。服务器将在启动时显示可用的身份验证方法。
游标（mcp.json）
将以下MCP定义添加到您的配置中：
{
"outline": {
"command": "npx",
"args": ["-y", "--package=outline-mcp-server@latest", "-c", "outline-mcp-server-stdio"],
"env": {
"OUTLINE_API_KEY": "",
"OUTLINE_API_URL": "https://app.getoutline.com/api",
"OUTLINE_MCP_PORT": "6060",
"OUTLINE_MCP_HOST": "127.0.0.1"
}
}
}认证
Outline MCP服务器支持两种身份验证方法：
- 环境变量（stdio模式所需）：设置
OUTLINE_API_KEY作为环境变量 - 请求头（HTTP/SSE模式）：在请求标头中提供API密钥
对于 stdio模式，API关键环境变量是必需的，并在启动时进行验证。
对于 HTTP/SSE模式，您有两个选择：
- 集
OUTLINE_API_KEY作为环境变量（回退方法） - 在请求头中提供API密钥（建议用于请求身份验证）
基于标头的身份验证
使用HTTP/SSE端点时，您可以使用以下任何头提供API密钥：
x-outline-api-key: your_api_key_hereoutline-api-key: your_api_key_hereauthorization: Bearer your_api_key_here
如果没有提供标头，服务器将回退到 OUTLINE_API_KEY 环境变量。如果两者都不可用，则请求将失败并出现身份验证错误。
环境变量
OUTLINE_API_KEY(_stdio需要，HTTP/SSE可选_)：大纲的API密钥OUTLINE_API_URL(_可选的_)：大纲API的替代URL（如果使用alt域/自托管）OUTLINE_MCP_PORT(_可选的_)：指定服务器将运行的端口（默认值：6060）OUTLINE_MCP_HOST(_可选的_)：将服务器绑定到的主机/IP（默认值：127.0.0.1）。使用0.0.0.0绑定到所有网络接口
用法
安装后，您可以将MCP服务器与支持模型上下文协议的AI助手一起使用，例如通过Cursor使用Claude。
您的AI助手现在可以处理的示例查询：
- “列出我的大纲工作区中的所有文档”
- 在“产品”集合中创建新文档
- “查找与特定主题相关的所有文档”
- “就您的文档提出一个自然语言问题”
- “从现有文档创建模板”
- “更新文档内容”
- “向文档添加注释”
Docker使用
您可以使用Docker或Docker Compose运行Outline MCP服务器，以便于部署。
1.准备好你的 .env 文件
复制 .env.example 到 .env 并填写您的大纲API密钥：
cp .env.example .env
# Edit .env and set OUTLINE_API_KEY=your_outline_api_key_here2.使用Docker Compose构建和运行（推荐）
docker-compose up --build- 默认情况下，服务器将在端口6060上可用。
- 环境变量从您的
.env文件。
3.使用Docker手动构建和运行
docker build -t outline-mcp-server .
docker run --env-file .env -p 6060:6060 outline-mcp-server- 您可以在运行时用以下命令覆盖环境变量
-e如果需要的话。
4.定制
- 若要更改API URL，请设置
OUTLINE_API_URL在你的.env文件或作为环境变量。 - 要更改端口或主机，请设置
OUTLINE_MCP_PORT和OUTLINE_MCP_HOST在你的.env文件或作为环境变量。 - 有关更高级的设置，请编辑
docker-compose.yml根据需要。
______________________________________________________________________
发展
# Clone this repository
git clone https://github.com/mmmeff/outline-mcp.git
cd outline-mcp
# Install dependencies
npm install创建一个 .env 使用大纲API密钥的文件：
OUTLINE_API_KEY=your_outline_api_key_here
# Optional -------
# OUTLINE_API_URL=https://your-outline-instance.com/api # defaults to https://app.getoutline.com/api
# OUTLINE_MCP_PORT=9001# Builds/watches the project alongside running @modelcontextprotocol/inspector
npm run dev贡献
此项目使用 语义释放 用于自动版本控制和包发布。请遵循 约定式提交 为您的提交消息制定规范，以确保正确的版本控制。
看 贡献.md 了解如何为该项目做出贡献的详细指南。
发布过程
使用语义发布和GitHub操作完全自动化发布。当提交被推送到 master 分支，发生以下情况：
- CI管道运行测试并构建包
- 语义发布分析提交消息以确定下一个版本号
- 新版本会自动发布到npm
- GitHub版本是使用自动生成的发行说明创建的
- CHANGELOG.md文件已更新
无需手动进行版本升级或版本创建。
许可证
麻省理工学院