项目简介

Outline MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器，它充当了 Outline 知识库平台与大型语言模型 (LLM) 应用之间的桥梁。该服务器通过 MCP 协议向 LLM 客户端提供了一系列工具，使 AI 助手能够以编程方式访问和管理 Outline 平台上的文档、集合、评论和用户等资源。借助 Outline MCP Server，LLM 应用可以方便地与 Outline 知识库集成，实现知识的检索、创建、更新和删除等操作，从而扩展 LLM 的上下文理解和应用能力。

主要功能点

文档管理: 支持创建、获取、更新、删除、列出、搜索文档，以及基于自然语言提问文档内容、创建文档模板、移动和归档文档等高级操作。
集合管理: 支持获取、列出、创建和更新集合。
评论管理: 支持在文档上创建、更新和删除评论。
用户管理: 支持列出和筛选用户。
标准 MCP 协议: 遵循 MCP 协议规范，易于与任何兼容 MCP 协议的 LLM 客户端集成。
工具化能力: 将 Outline API 的各项功能封装为独立的工具，方便 LLM 客户端按需调用。
灵活的部署: 可以通过 npm 包全局安装或直接使用 npx 运行，并支持自定义端口。
多种运行方式: 基于 Supergateway，理论上支持 Stdio, SSE, WebSocket 等多种 MCP 传输协议 (仓库文档目前只提及 Stdio 和 SSE)。

安装步骤

环境准备:
- 确保已安装 Node.js (v18 或更高版本)。
- 拥有一个 Outline 账户，并已开通 API 访问权限。
- 获取 Outline API 密钥 (API key)，并确保该密钥具有相应的操作权限。
安装 Outline MCP Server:

可以通过 npm 全局安装或使用 npx 直接运行：

方法一：全局安装 (推荐)
```
npm install -g outline-mcp-server
```
安装完成后，即可在命令行中使用 'outline-mcp-server' 命令。

方法二：使用 npx 直接运行

无需全局安装，直接使用 npx 运行：
```
npx outline-mcp-server
```
配置环境变量:

Outline MCP Server 运行需要 Outline API 密钥。请设置以下环境变量：
- 'OUTLINE_API_KEY': 必需。你的 Outline API 密钥。
- 'OUTLINE_API_URL': 可选。你的 Outline API 的 URL。如果使用 Outline 自托管版本或非默认域名，请设置此项。默认为 'https://app.getoutline.com/api'。
你可以在运行命令前临时设置环境变量，或者将环境变量添加到你的 shell 配置文件（如 '.bashrc', '.zshrc'）中。

临时设置环境变量示例 (Linux/macOS):
```
OUTLINE_API_KEY=your_outline_api_key npx outline-mcp-server
```
临时设置环境变量示例 (Windows PowerShell):
```
$env:OUTLINE_API_KEY="your_outline_api_key"; npx outline-mcp-server
```

自定义端口 (可选):

默认情况下，Outline MCP Server 运行在 6060 端口。如果需要自定义端口，可以使用 '--port' 命令行选项：

OUTLINE_API_KEY=your_outline_api_key outline-mcp-server --port 7070

服务器配置

对于需要配置 MCP 服务器的 LLM 客户端（例如 Cursor），你需要提供以下配置信息以连接到 Outline MCP Server。以下是一个 JSON 格式的配置示例，你需要根据你的实际情况进行调整。

{
  "serverName": "outline-mcp-server",
  "command": "npx outline-mcp-server",
  "args": [
    "--port",
    "端口号"  // 可选，如果需要自定义端口，请修改为实际端口号，默认 6060
  ],
  "env": {
    "OUTLINE_API_KEY": "你的 Outline API 密钥", // 必需，请替换为你的实际 API 密钥
    "OUTLINE_API_URL": "你的 Outline API URL"   // 可选，如果使用了非默认 Outline API URL，请取消注释并替换
  }
}

配置参数说明:

'serverName': MCP 服务器的名称，可以自定义，例如 "outline-mcp-server"。
'command': 启动 MCP 服务器的命令。这里使用 'npx outline-mcp-server'，假设你已安装了 'outline-mcp-server' 或希望使用 npx 直接运行。如果全局安装，也可以直接使用 'outline-mcp-server'。
'args': 传递给启动命令的参数。
- '--port': 可选参数，用于指定服务器监听的端口号。如果不需要自定义端口，可以移除此参数。如果需要自定义，请将 '"端口号"' 替换为实际端口号，例如 '"7070"'。
'env': 环境变量配置。
- 'OUTLINE_API_KEY': 必需。你的 Outline API 密钥。 请务必将其替换为你的实际 API 密钥。
- 'OUTLINE_API_URL': 可选。你的 Outline API 的 URL。如果你使用了非默认的 Outline API URL (例如自托管的 Outline 服务)，请取消注释此行并将其替换为你的 API URL。如果使用默认的 'https://app.getoutline.com/api'，则可以省略此配置。

注意:

请将上述 JSON 配置信息填入你的 LLM 客户端的 MCP 服务器配置中。
确保 'OUTLINE_API_KEY' 配置正确，否则 Outline MCP Server 将无法连接到 Outline API。
如果你的 LLM 客户端支持更细粒度的配置方式，请根据客户端的文档进行配置，核心是确保客户端能够通过 'npx outline-mcp-server' 命令启动服务器，并正确传递 'OUTLINE_API_KEY' 环境变量。

基本使用方法

成功配置并启动 Outline MCP Server 后，你的 LLM 助手就可以通过 MCP 协议调用服务器提供的工具来操作 Outline 知识库了。

你可以向你的 AI 助手发出自然语言指令，例如：

"列出我 Outline 工作空间中的所有文档"
"在 '产品' 集合中创建一个新文档"
"查找所有与特定主题相关的文档"
"用自然语言提问关于我的文档"
"从现有文档创建一个模板"
"更新文档的内容"
"给文档添加评论"

具体的指令格式和支持的功能取决于你的 LLM 客户端对 MCP 协议和 Outline MCP Server 工具的集成程度。请参考你的 LLM 客户端的文档，了解如何使用 MCP 服务器以及如何调用 Outline MCP Server 提供的工具。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息