Сервер Atlassian Confluence MCP

Этот проект предоставляет сервер Model Context Protocol (MCP), который действует как мост между помощниками ИИ (например, Claude от Anthropic, Cursor AI или другими MCP-совместимыми клиентами) и вашим экземпляром Atlassian Confluence. Он позволяет ИИ безопасно получать доступ и взаимодействовать с вашими пространствами и страницами Confluence в режиме реального времени.

Обзор

Что такое МКП?

Model Context Protocol (MCP) — открытый стандарт, позволяющий системам искусственного интеллекта безопасно и контекстно подключаться к внешним инструментам и источникам данных.

Этот сервер реализует MCP специально для Confluence Cloud, связывая ваши данные Confluence с помощниками на основе искусственного интеллекта.

Зачем использовать этот сервер?

Философия минимального ввода, максимального вывода : все, что вам нужно, — это простые идентификаторы, такие как spaceKey и pageId . Каждый инструмент возвращает исчерпывающие сведения, не требуя дополнительных флагов.
Полный доступ к базе знаний : предоставьте вашему помощнику на базе искусственного интеллекта полный доступ к вашей документации, вики-страницам и содержимому базы знаний в режиме реального времени.
Расширенное форматирование контента : весь контент страницы автоматически преобразуется из формата документов Atlassian в Markdown с соответствующими заголовками, таблицами, списками и другими элементами форматирования.
Безопасная локальная аутентификация : учетные данные никогда не хранятся на сервере. Сервер работает локально, поэтому ваши токены никогда не покидают вашу машину, и вы можете запрашивать только те разрешения, которые вам нужны.
Интуитивно понятные ответы Markdown : все ответы используют хорошо структурированную разметку Markdown для удобства чтения с последовательным форматированием и навигационными ссылками.

Начиная

Предпосылки

Node.js (>=18.x): Загрузить
Аккаунт Atlassian с доступом к Confluence Cloud

Шаг 1: Получите свой токен API Atlassian

Перейдите на страницу управления токенами API Atlassian: https://id.atlassian.com/manage-profile/security/api-tokens
Нажмите Создать токен API .
Дайте ему описательную метку (например, mcp-confluence-access ).
Нажмите «Создать» .
Скопируйте сгенерированный API-токен немедленно. Вы больше не сможете его увидеть.

Шаг 2: Настройте учетные данные

Метод A: Файл конфигурации MCP (рекомендуется)

Создайте или отредактируйте ~/.mcp/configs.json :

{
	"confluence": {
		"environments": {
			"ATLASSIAN_SITE_NAME": "<YOUR_SITE_NAME>",
			"ATLASSIAN_USER_EMAIL": "<YOUR_ATLASSIAN_EMAIL>",
			"ATLASSIAN_API_TOKEN": "<YOUR_COPIED_API_TOKEN>"
		}
	}
}

<YOUR_SITE_NAME> : Имя вашего сайта Confluence (например, mycompany для mycompany.atlassian.net ).
<YOUR_ATLASSIAN_EMAIL> : адрес электронной почты вашей учетной записи Atlassian.
<YOUR_COPIED_API_TOKEN> : токен API из шага 1.

Примечание: Для обратной совместимости сервер также распознает конфигурации под полным именем пакета ( @aashari/mcp-server-atlassian-confluence ), именем пакета без области действия ( mcp-server-atlassian-confluence ) или в формате atlassian-confluence , если рекомендуемый ключ confluence не найден. Однако для новых конфигураций предпочтительнее использовать короткий ключ confluence .

Метод B: Переменные среды

Передайте учетные данные напрямую при запуске сервера:

ATLASSIAN_SITE_NAME="<YOUR_SITE_NAME>" \
ATLASSIAN_USER_EMAIL="<YOUR_EMAIL>" \
ATLASSIAN_API_TOKEN="<YOUR_API_TOKEN>" \
npx -y @aashari/mcp-server-atlassian-confluence

Шаг 3: Подключите своего помощника на базе искусственного интеллекта

Настройте MCP-совместимый клиент для запуска этого сервера.

Конфигурация Клода / Курсора:

{
	"mcpServers": {
		"confluence": {
			"command": "npx",
			"args": ["-y", "@aashari/mcp-server-atlassian-confluence"]
		}
	}
}

Эта конфигурация запускает сервер автоматически во время выполнения.

Инструменты

В этом разделе рассматриваются инструменты MCP, доступные при использовании этого сервера с помощником AI. Обратите внимание, что инструменты MCP используют snake_case для имен инструментов и camelCase для параметров.

`conf_ls_spaces`

Перечисляет доступные пользователю пространства Confluence.

Фильтры: type («глобальный», «личный»), status («текущий», «архивный»).
Пагинация: limit , cursor .
Сортировка по умолчанию: по имени.

Пример:

{ "type": "global", "status": "current", "limit": 10 }

«Покажите мне первые 10 текущих глобальных пространств слияния».

`conf_get_space`

Получите полную информацию о конкретном пространстве, используя его spaceKey . Включает домашнюю страницу, описание и другие метаданные.

Пример:

{ "spaceKey": "DEV" }

«Расскажите мне о пространстве DEV в Confluence».

`conf_ls_pages`

Списки страниц.

Фильтры: spaceIds (массив идентификаторов пространств), spaceKeys (массив ключей пространств), title (текст в заголовке), status (например, «текущий», «архивированный»).
Сортировка: sort (например, «-дата-изменения», «название»).
Пагинация: limit , cursor .

Пример (по клавише пробела и названию):

{
	"spaceKeys": ["DEV"],
	"title": "API Documentation",
	"status": ["current"],
	"sort": "-modified-date"
}

«Покажите мне текущие страницы в разделе DEV со словом «Документация API» в заголовке, отсортированные по дате изменения».

`conf_get_page`

Получите полный контент (в формате Markdown) и метаданные для определенной страницы по ее pageId .

Пример:

{ "pageId": "12345678" }

«Получить содержимое страницы Confluence 12345678».

`conf_search`

Поиск контента Confluence.

Запрос: cql (полная строка языка запросов Confluence) или объединение более простых фильтров:
- query (свободный текстовый поиск по тексту и названию)
- title (текст в заголовке)
- spaceKey (ограничение пробелом)
- labels (массив меток - содержимое должно иметь ВСЕ)
- contentType ('страница', 'запись в блоге')
Пагинация: limit , cursor .
Возвращает результаты как Markdown, включая фрагменты и метаданные. Выполненный запрос CQL также возвращается в метаданных.

Пример (простой поиск):

{
	"query": "release notes Q1",
	"spaceKey": "PRODUCT",
	"contentType": "page",
	"limit": 5
}

«Ищите «заметки о выпуске Q1» на страницах в разделе ПРОДУКТ».

Пример (расширенный CQL):

{ "cql": "space = DEV AND label = api AND created >= '2023-01-01'" }

«Найдите контент в пространстве DEV с меткой «api», созданный с 1 января 2023 года».

Интерфейс командной строки (CLI)

CLI использует kebab-case для команд (например, ls-spaces ) и опций (например, --space-key ).

Быстрое использование с `npx`

npx -y @aashari/mcp-server-atlassian-confluence ls-spaces --type global --status current --limit 10
npx -y @aashari/mcp-server-atlassian-confluence get-space --space-key DEV
npx -y @aashari/mcp-server-atlassian-confluence ls-pages --space-key DEV --title "Release Notes" --status current --sort "-modified-date"
npx -y @aashari/mcp-server-atlassian-confluence get-page --page-id 12345678
npx -y @aashari/mcp-server-atlassian-confluence search --query "security best practices" --space-key DOCS --type page --limit 5
npx -y @aashari/mcp-server-atlassian-confluence search --cql "label = official-docs AND creator = currentUser()"

Установить глобально

npm install -g @aashari/mcp-server-atlassian-confluence

Затем выполните напрямую:

mcp-atlassian-confluence ls-spaces
mcp-atlassian-confluence get-page --page-id 12345678

Откройте для себя больше возможностей CLI

Используйте --help , чтобы просмотреть флаги и использование всех доступных команд:

mcp-atlassian-confluence --help

Или получите подробную справку по конкретной команде:

mcp-atlassian-confluence ls-spaces --help
mcp-atlassian-confluence get-space --help
mcp-atlassian-confluence ls-pages --help
mcp-atlassian-confluence get-page --help
mcp-atlassian-confluence search --help

Лицензия

Лицензия ISC

Atlassian Confluence MCP Server

Integrations