STARWARCLOUD STARWAR.AI
返回市场
轮廓-MCP服务器

轮廓-MCP服务器

作者：mmmeff76 星标更新：2025-10-12
安装使用来源：spider==github.com

项目介绍

Outline MCP Server

npm • downloads

一个模型上下文协议（MCP）服务器，提供与Outline API交互的工具，使AI代理能够通过Outline知识库平台程序化地管理文档、集合和其他实体。

快速安装

Claude Desktop

🎉 outline-mcp-server 现在有了Claude Desktop扩展！

您现在可以从发布页面下载一个Claude Desktop扩展进行快速简便的设置（只需双击即可）。

Cursor

在Cursor中单击安装：

安装MCP服务器

功能

  • 文档管理

    • ✅ 创建具有可定制属性的新文档
    • ✅ 获取文档详情
    • ✅ 更新现有文档
    • ✅ 删除文档
    • ✅ 列出文档
    • ✅ 搜索文档
    • ✅ 对文档提出自然语言问题
    • ✅ 从现有文档创建模板
    • ✅ 将文档移动到不同的集合或位置
    • ✅ 归档文档

  • 集合管理

    • ✅ 获取集合详情
    • ✅ 列出集合
    • ✅ 创建和更新集合

  • 评论管理

    • ✅ 在文档上创建评论
    • ✅ 更新现有评论
    • ✅ 删除评论

  • 用户管理

    • ✅ 列出并筛选用户

快速开始

先决条件

  • Node.js（v20或更高版本）
  • 具有API访问权限的Outline账户
  • 具有适当权限的Outline API密钥
  • 注意：如果您需要使用AI驱动的提问功能，必须在您的Outline工作区设置中启用“AI答案”功能

运行

outline-mcp-server 支持最新的流式传输协议、已弃用的sse协议以及传统的stdio。

# S-HTTP/SSE服务器（带可选环境变量）
OUTLINE_API_KEY=... npx -y outline-mcp-server@latest

# S-HTTP/SSE服务器（不带环境变量，使用请求头进行身份验证）
npx -y outline-mcp-server@latest

# STDIO（需要环境变量）
OUTLINE_API_KEY=... npx -y --package=outline-mcp-server@latest -c outline-mcp-server-stdio

当运行没有环境变量的HTTP/SSE服务器时，您需要在请求头中提供API密钥。服务器将在启动时显示可用的身份验证方法。

Cursor（mcp.json）

向您的配置添加以下MCP定义：

{
  "outline": {
    "command": "npx",
    "args": ["-y", "outline-mcp-server-stdio@latest"],
    "env": {
      "OUTLINE_API_KEY": "<REPLACE_ME>",
      "OUTLINE_API_URL": "https://app.getoutline.com/api",
      "OUTLINE_MCP_PORT": "6060",
      "OUTLINE_MCP_HOST": "127.0.0.1"
    }
  }
}

身份验证

Outline MCP服务器支持两种身份验证方法：

  1. 环境变量（stdio模式必需）：设置环境变量 OUTLINE_API_KEY
  2. 请求头（HTTP/SSE模式）：在请求头中提供API密钥

对于stdio模式，需要在启动时设置并验证API密钥环境变量。

对于HTTP/SSE模式，您有两种选择：

  • 设置环境变量 OUTLINE_API_KEY（备用方法）
  • 在请求头中提供API密钥（推荐用于每次请求的身份验证）

基于请求头的身份验证

当使用HTTP/SSE端点时，您可以使用以下任一头部提供API密钥：

  • x-outline-api-key: your_api_key_here
  • outline-api-key: your_api_key_here
  • authorization: Bearer your_api_key_here

如果没有提供头部，服务器将回退到环境变量 OUTLINE_API_KEY。如果两者都不可用，则请求将以身份验证错误失败。

环境变量

  • OUTLINE_API_KEY（stdio模式必需，HTTP/SSE模式可选）：您的Outline API密钥
  • OUTLINE_API_URL（可选）：您的Outline API的替代URL（如果使用其他域名或自托管）
  • OUTLINE_MCP_PORT（可选）：指定服务器运行的端口（默认：6060）
  • OUTLINE_MCP_HOST（可选）：绑定服务器的主机/IP（默认：127.0.0.1）。使用0.0.0.0绑定所有网络接口

使用

安装后，您可以使用支持模型上下文协议的AI助手（如通过Cursor的Claude）来使用MCP服务器。

示例查询您的AI助手可以处理：

  • “列出我的Outline工作区中的所有文档”
  • “在‘产品’集合中创建新文档”
  • “查找与特定主题相关的所有文档”
  • “对您的文档提出自然语言问题”
  • “从现有文档创建模板”
  • “更新文档的内容”
  • “在文档上添加评论”

Docker使用

您可以使用Docker或Docker Compose运行Outline MCP服务器以实现轻松部署。

1. 准备您的.env文件

复制.env.example到.env并填写您的Outline API密钥：

cp .env.example .env
# 编辑.env并设置OUTLINE_API_KEY=your_outline_api_key_here

2. 使用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，请在您的.env文件或作为环境变量设置 OUTLINE_API_URL。
  • 要更改端口或主机，请在您的.env文件或作为环境变量设置 OUTLINE_MCP_PORT 和 OUTLINE_MCP_HOST。
  • 对于更高级的设置，根据需要编辑 docker-compose.yml。

开发

# 克隆此仓库
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
# OUTLINE_MCP_PORT=9001

# 构建/监视项目并运行 @modelcontextprotocol/inspector
npm run dev

贡献

此项目使用semantic-release进行自动化版本管理和包发布。请遵循常规提交规范以确保正确的版本管理。

参见CONTRIBUTING.md了解如何为此项目贡献的详细指南。

发布过程

使用semantic-release和GitHub Actions完全自动化发布。当提交推送到master分支时，会发生以下情况：

  1. CI管道运行测试并构建包
  2. semantic-release分析提交消息以确定下一个版本号
  3. 自动发布新版本到npm
  4. 创建带有自动生成的发行说明的GitHub发行版
  5. 更新CHANGELOG.md文件

无需手动版本提升或创建发行版。

许可证

MIT