Outline

Автоматизируйте управление документами Outline с помощью ИИ-агентов через Outline MCP Server. Создавайте, обновляйте и ищите документы и коллекции программно. Поддерживает запросы на естественном языке и оптимизирует рабочие процессы. Повышайте эффективность совместной работы!

Совместная работа Обучение и документация Управление контентом ★ 21 GitHub (21 ★)

Предоставляет сервер Model Context Protocol (MCP) для взаимодействия с Outline API, позволяя AI-агентам программно управлять документами, коллекциями и другими сущностями платформы базы знаний Outline. Он предлагает такие функции, как создание, получение, обновление, удаление, поиск и шаблонизация документов, а также управление коллекциями и комментариями. Этот сервер упрощает интеграцию возможностей управления знаниями Outline в рабочие процессы на основе ИИ, оптимизируя задачи, связанные с документами, и обеспечивая взаимодействие с вашей базой знаний на естественном языке.

Ключевые особенности

01Управление документами (Создание, Получение, Обновление, Удаление, Список, Поиск, Запрос)

02Управление коллекциями (Получение, Список, Создание, Обновление)

03Управление комментариями (Создание, Обновление, Удаление)

04Управление пользователями (Список и Фильтрация)

05Поддерживает запросы на естественном языке по документам

0621 звезда на GitHub

Примеры использования

01Обеспечение взаимодействия на естественном языке с документами Outline через ИИ.

02Предоставление AI-ассистентам возможности создавать и управлять документами в Outline.

03Автоматизация задач, связанных с документами, с помощью AI-агентов.

Outline MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with Outline's API, enabling AI agents to manage documents, collections, and other entities programmatically through the Outline knowledge base platform.

Features

Document Management
- ✅ Create new documents with customizable properties
- ✅ Get document details
- ✅ Update existing documents
- ✅ Delete documents
- ✅ List documents
- ✅ Search documents
- ✅ Ask natural language questions about documents
- ✅ Create templates from existing documents
- ✅ Move documents to different collections or locations
- ✅ Archive documents
Collection Management
- ✅ Get collection details
- ✅ List collections
- ✅ Create and update collections
Comment Management
- ✅ Create comments on documents
- ✅ Update existing comments
- ✅ Delete comments
User Management
- ✅ List and filter users

Note: The SSE server implementation uses Supergateway, which provides more reliable connectivity when used with Cursor's MCP integration.

Quick Start

Prerequisites

Node.js (v18 or higher)
An Outline account with API access
Outline API key with appropriate permissions

Installation

# Run directly with npx
OUTLINE_API_KEY=… npx outline-mcp-server

# or install from npm
npm install -g outline-mcp-server
OUTLINE_API_KEY=… outline-mcp-server

# Run with a custom port (default is 6060)
OUTLINE_API_KEY=… outline-mcp-server --port 7070

Env

OUTLINE_API_KEY (required): your API key for outline, duh
OUTLINE_API_URL (optional): Alternative URL for your outline API (if using an alt domain/self-hosting)

CLI Options

--port <number> (optional): Specify the port on which the server will run (default: 6060)

Usage

Once installed, you can use the MCP server with AI assistants that support the Model Context Protocol, such as Claude via Cursor.

Example queries your AI assistant can now handle:

"List all the documents in my Outline workspace"
"Create a new document in the 'Product' collection"
"Find all documents related to a specific topic"
"Ask a natural language question about your documents"
"Create a template from an existing document"
"Update the content of a document"
"Add a comment to a document"

Development

# Clone this repository
git clone https://github.com/mmmeff/outline-mcp.git
cd outline-mcp

# Install dependencies
npm install

Create a `.env` file with your Outline API key:

OUTLINE_API_KEY=your_outline_api_key_here
OUTLINE_API_URL=https://your-outline-instance.com/api  # Optional, defaults to https://app.getoutline.com/api

# Builds/watches the project alongside running @modelcontextprotocol/inspector
npm run dev

Contributing

This project uses semantic-release for automated versioning and package publishing. Please follow the Conventional Commits specification for your commit messages to ensure proper versioning.

See CONTRIBUTING.md for detailed guidelines on how to contribute to this project.

Release Process

Releases are fully automated using semantic-release and GitHub Actions. When commits are pushed to the master branch, the following happens:

The CI pipeline runs tests and builds the package
semantic-release analyzes commit messages to determine the next version number
A new version is automatically published to npm
A GitHub release is created with auto-generated release notes
The CHANGELOG.md file is updated

No manual version bumping or release creation is needed.

License

MIT

Outline MCP Server

Сервер для интеграции AI-агентов с платформой Outline через протокол MCP (Model Context Protocol). Позволяет программам управлять документами, коллекциями, комментариями и пользователями напрямую через API Outline.

Возможности

Управление документами

Создание документов с кастомными параметрами
Чтение, обновление и удаление существующих документов
Поиск и фильтрация документов
Запросы к документам на естественном языке
Создание шаблонов из готовых документов
Перемещение документов между коллекциями
Архивация документов

Управление коллекциями

Получение информации о коллекции
Создание и обновление коллекций
Список коллекций рабочего пространства

Управление комментариями

Создание комментариев в документах
Редактирование и удаление комментариев

Управление пользователями

Фильтрация и просмотр списка пользователей

Быстрый старт

Требования

Node.js v18+
Аккаунт Outline с доступом к API
API-ключ Outline с необходимыми правами

Установка и запуск

# Запуск через 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`	(обязательно) Ваш API-ключ Outline
`OUTLINE_API_URL`	(опционально) Альтернативный URL API (для кастомного домена или self-hosted версии). По умолчанию `https://app.getoutline.com/api`

Использование

После запуска сервер подключается к AI-ассистентам, поддерживающим MCP (например, Claude через Cursor).

Примеры запросов к ассистенту:

«Покажи список всех документов в моём Outline»
«Создай новый документ в коллекции 'Продукты'»
«Найди все документы по теме «онбординг»
«Какой план проекта описан в документах?» (запрос на естественном языке)
«Сделай шаблон из документа 'Отчёт'»
«Обнови содержимое документа с ID 123»
«Добавь комментарий к документу 'Регламент'»

Разработка

# Клонирование репозитория
git clone https://github.com/mmmeff/outline-mcp.git
cd outline-mcp

# Установка зависимостей
npm install

# Создание файла .env
# OUTLINE_API_KEY=ваш_ключ
# OUTLINE_API_URL=https://ваш-экземпляр.outline.com/api

# Запуск в режиме разработки с инспектором MCP
npm run dev

Важные замечания

Для стабильного соединения с интеграцией Cursor рекомендуется SSE-реализация через Supergateway
Все коммиты должны следовать спецификации Conventional Commits, так как проект использует semantic-release для автоматической публикации версий
Релизы публикуются автоматически через GitHub Actions при пуше в ветку master: запускаются тесты, определяется номер версии, создаётся GitHub-релиз и пакет публикуется в npm
Подробное руководство по контрибьюции — в CONTRIBUTING.md

Лицензия

MIT

Каковы предварительные требования для использования Outline MCP Server?

Вам понадобится Node.js (v18 или выше), учетная запись Outline с доступом к API и действующий ключ API Outline.

Что можно делать с Outline MCP Server?

Вы можете автоматизировать создание, обновление, поиск и удаление документов. Вы также можете управлять коллекциями, комментариями и пользователями через API, подходящий для взаимодействия с ИИ-агентами.

Что такое Outline MCP Server?

Outline MCP Server — это инструмент, который позволяет ИИ-агентам программно взаимодействовать с вашей базой знаний Outline. Он предоставляет API для управления документами, коллекциями, пользователями и комментариями.

Как установить Outline MCP Server?

Вы можете установить его глобально с помощью npm: npm install -g outline-mcp-server. Затем запустите его с вашим ключом API Outline: OUTLINE_API_KEY=... outline-mcp-server.

Поддерживает ли Outline MCP Server запросы на естественном языке?

Да, он поддерживает запросы на естественном языке по вашим документам, позволяя ИИ-агентам отвечать на вопросы на основе содержимого вашей базы знаний Outline.

Источник: https://mcpmarket.com/server/outline

Ключевые особенности

Примеры использования

Outline MCP Server

Features

Quick Start

Prerequisites

Installation

Env

CLI Options

Usage

Development

Create a .env file with your Outline API key:

Contributing

Release Process

License

Outline MCP Server

Возможности

Управление документами

Управление коллекциями

Управление комментариями

Управление пользователями

Быстрый старт

Требования

Установка и запуск

Настройка среды

Использование

Разработка

Важные замечания

Лицензия

Каковы предварительные требования для использования Outline MCP Server?

Что можно делать с Outline MCP Server?

Что такое Outline MCP Server?

Как установить Outline MCP Server?

Поддерживает ли Outline MCP Server запросы на естественном языке?

Комментарии

Create a `.env` file with your Outline API key: