Skip to content
Back to search

conf-mcp

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
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/i-v-s--conf-mcp/badge.svg)](/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
  1. # conf-mcp
  2. Простой stdio MCP-сервер для чтения и поиска страниц Atlassian Confluence
  3. Server / Data Center 7.19.1. Все запросы к Confluence используют GET.
  4. ## Сборка и настройки
  5. Нужны Rust с поддержкой edition 2024 и Cargo. Проект проверен на Rust 1.100.
  6. ```sh
  7. cargo build --release --locked
  8. mkdir -p ~/.config
  9. cp conf-mcp.example.toml ~/.config/conf-mcp.toml
  10. chmod 600 ~/.config/conf-mcp.toml
  11. ```
  12. Укажите адрес приложения и Personal Access Token в `~/.config/conf-mcp.toml`:
  13. ```toml
  14. base_url = "https://confluence.example.com/confluence"
  15. token = "your-personal-access-token"
  16. download_dir = "~/.cache/conf-mcp/images"
  17. ```
  18. `base_url` должен включать context path приложения, если он используется,
  19. например `/confluence`. Не добавляйте `/rest/api` или адрес конкретной страницы.
  20. Для приложения в корне домена достаточно `https://confluence.example.com`.
  21. Переменные `CONFLUENCE_BASE_URL` и `CONFLUENCE_TOKEN` переопределяют соответствующие
  22. поля файла. Файл необязателен, если оба значения заданы через окружение.
  23. Пустые значения и некорректный TOML считаются ошибкой конфигурации.
  24. `download_dir` — необязательный каталог загруженных изображений и метаданных
  25. кэша. Поддерживаются абсолютные пути и префикс `~/` (через `HOME`); пустые и
  26. остальные относительные пути отклоняются. Переменные внутри строки не раскрываются.
  27. Если параметр не задан, используется `$XDG_CACHE_HOME/conf-mcp/images` при абсолютном
  28. `XDG_CACHE_HOME`, иначе `$HOME/.cache/conf-mcp/images`. Без этих переменных можно
  29. читать страницы, но для `get_image` нужно явно задать `download_dir`.
  30. Каталог создаётся только при первом вызове `get_image`. Новые каталоги на Unix
  31. получают права `0700`, файлы — `0600`; права существующего каталога не меняются.
  32. PAT передаётся как `Authorization: Bearer …`; логин и пароль не требуются.
  33. Сервер использует права владельца токена. Проверка TLS включена и использует
  34. доверенные сертификаты системы. Таймаут HTTP-запроса — 30 секунд.
  35. Перенаправления отключены: указывайте окончательный адрес Confluence.
  36. ### Дополнительные сертификаты CA на Linux
  37. Переменная `SSL_CERT_FILE` задаёт PEM-файл доверенных сертификатов для TLS.
  38. Она должна присутствовать в окружении процесса `conf-mcp`. В этом окружении
  39. можно использовать тот же bundle, что настроен для YouTrack:
  40. ```sh
  41. SSL_CERT_FILE="$HOME/.config/yt-mcp-ca-bundle.pem" ./target/release/conf-mcp
  42. ```
  43. При запуске из MCP-клиента добавьте в конфигурацию сервера поле `env`:
  44. ```json
  45. {
  46. "env": {
  47. "SSL_CERT_FILE": "/home/user/.config/yt-mcp-ca-bundle.pem"
  48. }
  49. }
  50. ```
  51. На Linux этот файл заменяет системный набор CA, если `SSL_CERT_DIR` не задан.
  52. Указанный bundle содержит системные сертификаты и дополнительный промежуточный
  53. сертификат `GlobalSign RSA OV SSL CA 2018`. Проверка сертификата сервера и имени
  54. хоста остаётся включённой.
  55. CA-bundle помогает при ошибке доверия цепочке сертификатов. Ошибки разрешения
  56. DNS и запрет создания TCP-сокетов возникают до TLS; для них требуется сетевой
  57. доступ в окружении, запускающем сервер.
  58. ## Подключение MCP-клиента
  59. Укажите абсолютный путь к собранному бинарному файлу в настройках клиента,
  60. поддерживающего stdio MCP. Например, для формата `mcpServers`:
  61. ```json
  62. {
  63. "mcpServers": {
  64. "confluence": {
  65. "command": "/home/user/src/rust/conf-mcp/target/release/conf-mcp"
  66. }
  67. }
  68. }
  69. ```
  70. Клиент должен запускать процесс от пользователя, в домашнем каталоге которого
  71. находится файл настроек. Также можно передать настройки через поле `env`
  72. клиента с ключами `CONFLUENCE_BASE_URL` и `CONFLUENCE_TOKEN`.
  73. Сервер читает JSON-RPC из stdin и пишет только сообщения MCP в stdout.
  74. Диагностика запуска выводится в stderr. Процесс завершается при закрытии stdin.
  75. HTTP-сервер и сетевой порт для MCP не запускаются.
  76. ## Инструменты
  77. ### `get_page`
  78. Обязательный параметр `page` — строка с числовым ID либо абсолютной ссылкой
  79. на настроенный экземпляр Confluence:
  80. ```json
  81. {"page": "123456"}
  82. ```
  83. ```json
  84. {"page": "https://confluence.example.com/confluence/pages/viewpage.action?pageId=123456"}
  85. ```
  86. ```json
  87. {"page": "https://confluence.example.com/confluence/display/DEV/Getting+Started"}
  88. ```
  89. Ссылка `/display/SPACE/Title` разрешается через поиск текущей страницы по точному
  90. названию и пространству. Ссылки другого экземпляра и короткие `/x/…` отклоняются.
  91. Результат содержит `id`, `title`, `space_key`, `version`, `url` и `markdown`.
  92. HTML берётся из `body.view`: сервер Confluence выполняет доступное ему
  93. отображение макросов. Заголовки, списки, обычные таблицы, блоки кода и ссылки
  94. преобразуются в Markdown. Относительные ссылки становятся абсолютными.
  95. ### `search_pages`
  96. Укажите ровно один параметр: `query` для полнотекстового поиска либо `cql`
  97. для готового запроса. В обоих режимах автоматически добавляется `type = page`.
  98. ```json
  99. {"query": "Rust stdio", "limit": 25}
  100. ```
  101. ```json
  102. {"cql": "space = DEV AND label = docs ORDER BY lastmodified DESC", "limit": 10}
  103. ```
  104. `start` — неотрицательное смещение, по умолчанию 0. `limit` — от 1 до 100,
  105. по умолчанию 25. Результат содержит `results` со списком ID, заголовков,
  106. пространств и ссылок, а также `start`, `limit` и `next_start`.
  107. Если `next_start` не равен `null`, передайте его как `start` следующего вызова
  108. с тем же запросом. Полное содержимое страниц загружается через `get_page`.
  109. Результаты обоих инструментов возвращаются через MCP `structuredContent`
  110. и дублируются как JSON в текстовом блоке для совместимости с клиентами.
  111. ### `get_image`
  112. Обязательный параметр `url` — абсолютная ссылка на изображение из Markdown,
  113. полученного через `get_page`:
  114. ```json
  115. {"url": "https://confluence.example.com/confluence/download/attachments/123456/schema.png?version=1&api=v2"}
  116. ```
  117. Инструмент загружает файл с существующим PAT в `download_dir` и возвращает
  118. короткий JSON через `structuredContent` и текстовый блок:
  119. ```json
  120. {"path": "/home/user/.cache/conf-mcp/images/<sha256>.png", "mime_type": "image/png", "size_bytes": 1190607, "cached": false}
  121. ```
  122. `path` — абсолютный путь. Для просмотра Codex должен открыть его через `view_image`.
  123. Клиент и сервер должны иметь доступ к одной файловой системе. Содержимое изображения
  124. и Base64 в MCP-ответ не включаются. Это изменение формата ответа: прежний блок `image`
  125. больше не возвращается. Сохраните путь для повторного просмотра; не печатайте байты
  126. файла или его Base64 в терминал.
  127. Обычный вызов повторно использует проверенный локальный файл в течение часа после
  128. скачивания (`cached: true`), в том числе после перезапуска сервера. Для принудительного
  129. скачивания укажите `refresh` (по умолчанию `false`):
  130. ```json
  131. {"url": "https://confluence.example.com/confluence/download/attachments/123456/schema.png?version=1&api=v2", "refresh": true}
  132. ```
  133. Ключ кэша учитывает полный нормализованный URL, параметры версии и авторизацию.
  134. Токен на диск не записывается. Повреждённые, отсутствующие и просроченные файлы
  135. скачиваются заново; при ошибке обновления старый файл сохраняется, инструмент
  136. возвращает ошибку. Одновременные обычные запросы одного URL используют одну загрузку.
  137. Имена файлов основаны на SHA-256 содержимого. Новое содержимое получает новый путь,
  138. а прежние файлы остаются доступны. Файлы и скрытые `.index-*.json` сохраняются после
  139. завершения процесса; удаляйте их вручную из `download_dir`, когда они больше не нужны.
  140. Часовой срок определяет актуальность кэша, а не время удаления файлов.
  141. Поддерживаются PNG, JPEG, GIF и WebP: формат определяется по сигнатуре файла,
  142. а не расширению или HTTP-заголовку. Исходные байты передаются без изменения размера
  143. или преобразования. Лимит — 5 МиБ на файл, таймаут всей загрузки — 30 секунд.
  144. SVG и прочие форматы отклоняются. Проверяется как заявленный, так и фактический размер.
  145. Допускаются только ссылки с теми же схемой, хостом и портом, внутри context path
  146. настроенного Confluence. Ссылки с логином или паролем отклоняются; перенаправления
  147. не выполняются. Используются те же TLS-настройки, включая `SSL_CERT_FILE`.
  148. Изображения из `get_page` загружаются только отдельным вызовом `get_image`.
  149. В stderr выводятся время выполнения `get_image`, размер файла и признак попадания
  150. в кэш. URL, токен и содержимое изображения в диагностике не печатаются.
  151. Ошибки Confluence возвращаются с `isError: true`, процесс продолжает работать.
  152. Токен и тела ошибочных HTTP-ответов в диагностику не выводятся.
  153. ## Проверка
  154. ```sh
  155. cargo test --locked
  156. cargo fmt -- --check
  157. cargo clippy --locked --all-targets -- -D warnings
  158. ```
  159. Тесты используют HTTP-моки в памяти и запуск отдельного процесса для проверки
  160. stdio: конфигурации, инициализации MCP, списка инструментов, ошибок и EOF.
  161. Настоящий Confluence и токен для них не нужны. При наличии всех зависимостей
  162. в кэше команды Cargo можно запускать с `--offline`.
  163. ## Границы первой версии
  164. Поддерживаются текущие страницы и загрузка изображений по ссылке через `get_image`.
  165. В Markdown изображения сохраняются как ссылки. Работа с прочими вложениями,
  166. комментариями, деревом дочерних страниц, историей версий и изменение данных
  167. не реализованы. JavaScript не выполняется.
  168. Преобразователь использует `htmd` с HTML5-парсером `html5ever`. Он преобразует
  169. заголовки, списки, таблицы и блоки кода в Markdown. Для таблиц без заголовков
  170. добавляется пустой ряд заголовка, чтобы сохранить их структуру в Markdown.
  171. Небольшой адаптер разрешает относительные ссылки и сохраняет язык и отступы
  172. блоков кода Confluence. Сложная вёрстка и объединённые
  173. ячейки таблиц могут отображаться упрощённо. Содержимое макросов доступно в пределах
  174. HTML, который вернул Confluence. Автоматические тесты используют моки;
  175. проверка подключения к конкретному экземпляру выполняется отдельно.
  176. Документация: [REST API 7.19.1](https://docs.atlassian.com/ConfluenceServer/rest/7.19.1/),
  177. [PAT](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html),
  178. [MCP Rust SDK](https://github.com/modelcontextprotocol/rust-sdk).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.