Back to search
conf-mcp
MCP serverGitHub
Simple stdio MCP server for reading and searching within Atlassian Confluence
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Checked today
Badge for your README
Markdown
[](/listings/i-v-s--conf-mcp)HTML
<a href="/listings/i-v-s--conf-mcp"><img src="/api/listings/i-v-s--conf-mcp/badge.svg" alt="findsafeskills safety rating" /></a>Install
i
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 236 lines
- # conf-mcp
- Простой stdio MCP-сервер для чтения и поиска страниц Atlassian Confluence
- Server / Data Center 7.19.1. Все запросы к Confluence используют GET.
- ## Сборка и настройки
- Нужны Rust с поддержкой edition 2024 и Cargo. Проект проверен на Rust 1.100.
- ```sh
- cargo build --release --locked
- mkdir -p ~/.config
- cp conf-mcp.example.toml ~/.config/conf-mcp.toml
- chmod 600 ~/.config/conf-mcp.toml
- ```
- Укажите адрес приложения и Personal Access Token в `~/.config/conf-mcp.toml`:
- ```toml
- base_url = "https://confluence.example.com/confluence"
- token = "your-personal-access-token"
- download_dir = "~/.cache/conf-mcp/images"
- ```
- `base_url` должен включать context path приложения, если он используется,
- например `/confluence`. Не добавляйте `/rest/api` или адрес конкретной страницы.
- Для приложения в корне домена достаточно `https://confluence.example.com`.
- Переменные `CONFLUENCE_BASE_URL` и `CONFLUENCE_TOKEN` переопределяют соответствующие
- поля файла. Файл необязателен, если оба значения заданы через окружение.
- Пустые значения и некорректный TOML считаются ошибкой конфигурации.
- `download_dir` — необязательный каталог загруженных изображений и метаданных
- кэша. Поддерживаются абсолютные пути и префикс `~/` (через `HOME`); пустые и
- остальные относительные пути отклоняются. Переменные внутри строки не раскрываются.
- Если параметр не задан, используется `$XDG_CACHE_HOME/conf-mcp/images` при абсолютном
- `XDG_CACHE_HOME`, иначе `$HOME/.cache/conf-mcp/images`. Без этих переменных можно
- читать страницы, но для `get_image` нужно явно задать `download_dir`.
- Каталог создаётся только при первом вызове `get_image`. Новые каталоги на Unix
- получают права `0700`, файлы — `0600`; права существующего каталога не меняются.
- PAT передаётся как `Authorization: Bearer …`; логин и пароль не требуются.
- Сервер использует права владельца токена. Проверка TLS включена и использует
- доверенные сертификаты системы. Таймаут HTTP-запроса — 30 секунд.
- Перенаправления отключены: указывайте окончательный адрес Confluence.
- ### Дополнительные сертификаты CA на Linux
- Переменная `SSL_CERT_FILE` задаёт PEM-файл доверенных сертификатов для TLS.
- Она должна присутствовать в окружении процесса `conf-mcp`. В этом окружении
- можно использовать тот же bundle, что настроен для YouTrack:
- ```sh
- SSL_CERT_FILE="$HOME/.config/yt-mcp-ca-bundle.pem" ./target/release/conf-mcp
- ```
- При запуске из MCP-клиента добавьте в конфигурацию сервера поле `env`:
- ```json
- {
- "env": {
- "SSL_CERT_FILE": "/home/user/.config/yt-mcp-ca-bundle.pem"
- }
- }
- ```
- На Linux этот файл заменяет системный набор CA, если `SSL_CERT_DIR` не задан.
- Указанный bundle содержит системные сертификаты и дополнительный промежуточный
- сертификат `GlobalSign RSA OV SSL CA 2018`. Проверка сертификата сервера и имени
- хоста остаётся включённой.
- CA-bundle помогает при ошибке доверия цепочке сертификатов. Ошибки разрешения
- DNS и запрет создания TCP-сокетов возникают до TLS; для них требуется сетевой
- доступ в окружении, запускающем сервер.
- ## Подключение MCP-клиента
- Укажите абсолютный путь к собранному бинарному файлу в настройках клиента,
- поддерживающего stdio MCP. Например, для формата `mcpServers`:
- ```json
- {
- "mcpServers": {
- "confluence": {
- "command": "/home/user/src/rust/conf-mcp/target/release/conf-mcp"
- }
- }
- }
- ```
- Клиент должен запускать процесс от пользователя, в домашнем каталоге которого
- находится файл настроек. Также можно передать настройки через поле `env`
- клиента с ключами `CONFLUENCE_BASE_URL` и `CONFLUENCE_TOKEN`.
- Сервер читает JSON-RPC из stdin и пишет только сообщения MCP в stdout.
- Диагностика запуска выводится в stderr. Процесс завершается при закрытии stdin.
- HTTP-сервер и сетевой порт для MCP не запускаются.
- ## Инструменты
- ### `get_page`
- Обязательный параметр `page` — строка с числовым ID либо абсолютной ссылкой
- на настроенный экземпляр Confluence:
- ```json
- {"page": "123456"}
- ```
- ```json
- {"page": "https://confluence.example.com/confluence/pages/viewpage.action?pageId=123456"}
- ```
- ```json
- {"page": "https://confluence.example.com/confluence/display/DEV/Getting+Started"}
- ```
- Ссылка `/display/SPACE/Title` разрешается через поиск текущей страницы по точному
- названию и пространству. Ссылки другого экземпляра и короткие `/x/…` отклоняются.
- Результат содержит `id`, `title`, `space_key`, `version`, `url` и `markdown`.
- HTML берётся из `body.view`: сервер Confluence выполняет доступное ему
- отображение макросов. Заголовки, списки, обычные таблицы, блоки кода и ссылки
- преобразуются в Markdown. Относительные ссылки становятся абсолютными.
- ### `search_pages`
- Укажите ровно один параметр: `query` для полнотекстового поиска либо `cql`
- для готового запроса. В обоих режимах автоматически добавляется `type = page`.
- ```json
- {"query": "Rust stdio", "limit": 25}
- ```
- ```json
- {"cql": "space = DEV AND label = docs ORDER BY lastmodified DESC", "limit": 10}
- ```
- `start` — неотрицательное смещение, по умолчанию 0. `limit` — от 1 до 100,
- по умолчанию 25. Результат содержит `results` со списком ID, заголовков,
- пространств и ссылок, а также `start`, `limit` и `next_start`.
- Если `next_start` не равен `null`, передайте его как `start` следующего вызова
- с тем же запросом. Полное содержимое страниц загружается через `get_page`.
- Результаты обоих инструментов возвращаются через MCP `structuredContent`
- и дублируются как JSON в текстовом блоке для совместимости с клиентами.
- ### `get_image`
- Обязательный параметр `url` — абсолютная ссылка на изображение из Markdown,
- полученного через `get_page`:
- ```json
- {"url": "https://confluence.example.com/confluence/download/attachments/123456/schema.png?version=1&api=v2"}
- ```
- Инструмент загружает файл с существующим PAT в `download_dir` и возвращает
- короткий JSON через `structuredContent` и текстовый блок:
- ```json
- {"path": "/home/user/.cache/conf-mcp/images/<sha256>.png", "mime_type": "image/png", "size_bytes": 1190607, "cached": false}
- ```
- `path` — абсолютный путь. Для просмотра Codex должен открыть его через `view_image`.
- Клиент и сервер должны иметь доступ к одной файловой системе. Содержимое изображения
- и Base64 в MCP-ответ не включаются. Это изменение формата ответа: прежний блок `image`
- больше не возвращается. Сохраните путь для повторного просмотра; не печатайте байты
- файла или его Base64 в терминал.
- Обычный вызов повторно использует проверенный локальный файл в течение часа после
- скачивания (`cached: true`), в том числе после перезапуска сервера. Для принудительного
- скачивания укажите `refresh` (по умолчанию `false`):
- ```json
- {"url": "https://confluence.example.com/confluence/download/attachments/123456/schema.png?version=1&api=v2", "refresh": true}
- ```
- Ключ кэша учитывает полный нормализованный URL, параметры версии и авторизацию.
- Токен на диск не записывается. Повреждённые, отсутствующие и просроченные файлы
- скачиваются заново; при ошибке обновления старый файл сохраняется, инструмент
- возвращает ошибку. Одновременные обычные запросы одного URL используют одну загрузку.
- Имена файлов основаны на SHA-256 содержимого. Новое содержимое получает новый путь,
- а прежние файлы остаются доступны. Файлы и скрытые `.index-*.json` сохраняются после
- завершения процесса; удаляйте их вручную из `download_dir`, когда они больше не нужны.
- Часовой срок определяет актуальность кэша, а не время удаления файлов.
- Поддерживаются PNG, JPEG, GIF и WebP: формат определяется по сигнатуре файла,
- а не расширению или HTTP-заголовку. Исходные байты передаются без изменения размера
- или преобразования. Лимит — 5 МиБ на файл, таймаут всей загрузки — 30 секунд.
- SVG и прочие форматы отклоняются. Проверяется как заявленный, так и фактический размер.
- Допускаются только ссылки с теми же схемой, хостом и портом, внутри context path
- настроенного Confluence. Ссылки с логином или паролем отклоняются; перенаправления
- не выполняются. Используются те же TLS-настройки, включая `SSL_CERT_FILE`.
- Изображения из `get_page` загружаются только отдельным вызовом `get_image`.
- В stderr выводятся время выполнения `get_image`, размер файла и признак попадания
- в кэш. URL, токен и содержимое изображения в диагностике не печатаются.
- Ошибки Confluence возвращаются с `isError: true`, процесс продолжает работать.
- Токен и тела ошибочных HTTP-ответов в диагностику не выводятся.
- ## Проверка
- ```sh
- cargo test --locked
- cargo fmt -- --check
- cargo clippy --locked --all-targets -- -D warnings
- ```
- Тесты используют HTTP-моки в памяти и запуск отдельного процесса для проверки
- stdio: конфигурации, инициализации MCP, списка инструментов, ошибок и EOF.
- Настоящий Confluence и токен для них не нужны. При наличии всех зависимостей
- в кэше команды Cargo можно запускать с `--offline`.
- ## Границы первой версии
- Поддерживаются текущие страницы и загрузка изображений по ссылке через `get_image`.
- В Markdown изображения сохраняются как ссылки. Работа с прочими вложениями,
- комментариями, деревом дочерних страниц, историей версий и изменение данных
- не реализованы. JavaScript не выполняется.
- Преобразователь использует `htmd` с HTML5-парсером `html5ever`. Он преобразует
- заголовки, списки, таблицы и блоки кода в Markdown. Для таблиц без заголовков
- добавляется пустой ряд заголовка, чтобы сохранить их структуру в Markdown.
- Небольшой адаптер разрешает относительные ссылки и сохраняет язык и отступы
- блоков кода Confluence. Сложная вёрстка и объединённые
- ячейки таблиц могут отображаться упрощённо. Содержимое макросов доступно в пределах
- HTML, который вернул Confluence. Автоматические тесты используют моки;
- проверка подключения к конкретному экземпляру выполняется отдельно.
- Документация: [REST API 7.19.1](https://docs.atlassian.com/ConfluenceServer/rest/7.19.1/),
- [PAT](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html),
- [MCP Rust SDK](https://github.com/modelcontextprotocol/rust-sdk).
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.