Skycloak
официальныйСервер Model Context Protocol для управляемого Skycloak Keycloak. Управляйте кластерами, realm'ами, приложениями, SSO и пользователями из любого MCP-клиента.
Что можно делать с Skycloak MCP?
- Инвентаризация кластеров и обновления — Список кластеров, проверка версий и получение пути обновления для любого кластера, который отстаёт.
- Управление реалмами и приложениями — Создание и обновление реалмов и приложений, назначение ролей и ротация секретов клиентов приложений.
- Настройка поставщиков идентификации — Добавление поставщиков идентификации OIDC в реалм, проверка подключения и просмотр существующих подключений SSO.
- Администрирование пользователей и групп — Просмотр пользователей, ролей и групп реалма, назначение ролей и добавление пользователей в группы.
- Аудит и просмотр событий — Запрос событий и журналов безопасности или получение недавних неудачных попыток входа в реалм с группировкой по исходному IP-адресу.
- Назначения для SIEM и вебхуков — Создание назначения SIEM или подписки на вебхук и отправка тестового события для проверки доставки.
Документация
skycloak-mcp
Официальный сервер Model Context Protocol для Skycloak (управляемый Keycloak): управляйте кластерами, realm, приложениями и SSO из любого MCP-клиента (Claude Desktop, Claude Code, Cursor).
Статус: ранний выпуск. Набор инструментов расширяется; см. журнал изменений, чтобы узнать, что доступно.
Быстрый старт
claude mcp add --transport http skycloak https://mcp.skycloak.io
Не нужны API-ключ, идентификатор клиента или конфигурация. Откроется браузер, вы войдёте в Skycloak, и инструменты появятся. Любой MCP-клиент, поддерживающий потоковый HTTP, работает так же: укажите ему URL — и больше ничего.
Затем попросите, например:
- «Какие из моих кластеров Keycloak отстают по обновлениям?»
- «Создай staging realm в кластере ЕС с входом через Google и GitHub».
- «Кого добавили в production realm за последнюю неделю?»
- «Настрой назначение SIEM, которое пересылает события администратора на наш вебхук Datadog».
Аутентификация и безопасность
- Размещённый HTTP с OAuth (не нужно настраивать учётные данные). Укажите клиенту
https://mcp.skycloak.ioбез заголовка. Сервер отвечает401со ссылкой на метаданные RFC 9728 по адресу/.well-known/oauth-protected-resource, клиент выполняет в браузере поток авторизации с кодом против realm входа Skycloak, а полученный токен доступа обменивается на краткосрочный API-ключ с областью действия workspace, от имени которого работает сеанс. Ключ действует час и обновляется автоматически. В конфигурации клиента ничего не сохраняется. - Размещённый HTTP с API-ключом. Создайте ключ в панели управления Skycloak и передавайте его как
Authorization: Bearer <key>(илиAPI-Key: <key>). Каждый запрос содержит собственные учётные данные и действует только в workspace этих учётных данных. Сервер не хранит состояние сеанса, поэтому запрос никогда не наследует данные другого вызывающего. Ключи не проверяются до использования: источником истины является API Skycloak, поэтому недействительный ключ приводит к401при первом вызове инструмента, а не при подключении. - Инструменты соответствуют вашей роли. При использовании OAuth список инструментов ограничивается разрешёнными областями действия сеанса, поэтому участнику workspace с правами только на чтение не показываются инструменты записи, вызов которых завершился бы
403. При использовании API-ключа регистрируется весь набор инструментов, поскольку серверу неизвестны области действия ключа, а неавторизованный вызов приводит к403от API. - Локальный stdio. Запустите
skycloak-mcp initи подтвердите вход в браузере (поток авторизации устройства OAuth 2.0). Программа создаёт API-ключ с областью действия workspace, сохраняет его в системном хранилище ключей и автоматически определяет workspace по умолчанию (передайте--workspace <id>, чтобы выбрать другой). Командаskycloak-mcp logoutудаляет сохранённый ключ. - Без браузера / CI. Задайте переменную окружения
SKYCLOAK_API_KEY(создайте ключ в панели управления Skycloak), чтобы полностью пропустить браузер. Она всегда имеет приоритет над хранилищем ключей. - Возможность записи определяется вашими учётными данными, а не флагом. Размещённый сервер по адресу
https://mcp.skycloak.ioподдерживает запись, а доступные вам изменения ограничены областями действия ключа и вашей ролью в workspace: участник с правами только на чтение не может ничего изменять, независимо от списка инструментов. Добавьте?readonly=trueк URL, чтобы принудительно включить для сеанса только инструменты чтения. Локальный бинарный файл работает наоборот и регистрирует инструменты записи, только если запущен с--allow-writes. - Учётные данные кластера доступны только по запросу.
get_cluster_credentialsвозвращает учётные данные администратора Keycloak для кластера, которые затем увидит ассистент с ключом, поэтому по умолчаниюinitне запрашивает эту область действия. Используйте ключ с соответствующей областью: создайте его в панели управления или войдите через stdio с помощьюskycloak-mcp init --allow-credentials. Без неё инструмент возвращает ошибку 403 с описанием обоих способов. - Для разрушительных операций требуется подтверждение: например, для удаления realm нужен явный аргумент
confirm=true. - Ограничение частоты запросов зависит от вашего плана Skycloak; при ответе
429сервер возвращаетRetry-After.
Инструменты
141 инструмент: 62 только для чтения и 79 для записи. Инструменты чтения доступны всегда. На размещённом сервере также регистрируются инструменты записи, доступ к которым ограничен областями действия ваших учётных данных; локальный бинарный файл регистрирует их, только если запущен с --allow-writes.
В именах инструментов используется префикс skycloak_, опущенный в таблице ниже, поэтому list_clusters в вашем клиенте — это skycloak_list_clusters.
| Область | Только для чтения | Запись (--allow-writes) |
|---|---|---|
| Кластеры | list_clusters, get_cluster, list_cluster_locations, list_cluster_types, list_cluster_features, list_cluster_versions, list_cluster_upgrades, get_cluster_upgrade_path, get_cluster_credentials, get_cluster_insights, get_cluster_maintenance_window | create_cluster, update_cluster, delete_cluster, cancel_cluster_upgrade, restart_cluster_instances, set_cluster_maintenance_window, delete_cluster_maintenance_window |
| Безопасность на границе сети | get_cluster_security, list_cluster_captcha_domains | update_cluster_security, add_cluster_captcha_domain, remove_cluster_captcha_domain |
| Realm | list_realms, get_realm | create_realm, update_realm, delete_realm |
| Приложения | list_applications, get_application, list_application_roles, list_application_sessions | create_application, update_application, delete_application, assign_application_role, remove_application_role, rotate_application_secret |
| Поставщики удостоверений | list_identity_providers, get_identity_provider, list_identity_provider_templates, discover_oidc | create_identity_provider (OIDC), update_identity_provider, delete_identity_provider, test_identity_provider |
| Пользователи, роли и группы | list_realm_users, get_realm_user, list_realm_roles, get_realm_role, list_realm_groups, get_realm_group, list_realm_group_members, list_user_roles, list_user_groups | create_realm_user, update_realm_user, delete_realm_user, create_realm_role, update_realm_role, delete_realm_role, create_realm_group, update_realm_group, delete_realm_group, assign_realm_user_role, remove_realm_user_role, add_realm_user_to_group, remove_realm_user_from_group |
| Пользовательские домены | list_domains, get_domain, list_domain_routes, get_domain_route | create_domain, verify_domain, delete_domain, create_domain_route, update_domain_route, delete_domain_route |
| Брендинг и темы | list_themes, get_theme, get_theme_assignment, get_client_theme_assignment, get_login_branding, get_email_branding, download_theme_content, get_theme_settings | set_theme_assignment, set_client_theme_assignment, update_theme, update_theme_content, update_theme_settings, delete_theme, upsert_login_branding, delete_login_branding, upsert_email_branding, delete_email_branding |
| Расширения | list_extensions, list_cluster_extensions | install_extension, upgrade_extension, update_extension, uninstall_extension, delete_extension |
| SMTP | get_smtp | upsert_smtp, delete_smtp, test_smtp |
| Экспорт и журналы | list_exports, get_export, get_logs, get_security_logs, query_events | create_export, delete_export, export_cluster_events |
| Импорт и экспорт realm | get_realm_export, get_realm_import | create_realm_export, create_realm_import, create_realm_import_upload_url |
| SIEM | list_siem_destinations, get_siem_destination | create_siem_destination, update_siem_destination, delete_siem_destination, test_siem_destination |
| Вебхуки | list_webhook_event_types, list_webhook_subscriptions, get_webhook_subscription | create_webhook_subscription, update_webhook_subscription, delete_webhook_subscription, test_webhook_subscription |
| OpenFGA | list_openfga_instances, get_openfga_instance | create_openfga_instance, delete_openfga_instance |
Соглашения: для разрушительных операций (delete_*, uninstall_extension, cancel_cluster_upgrade, update_theme_content, update_theme_settings, restart_cluster_instances) требуется confirm=true. update_theme_settings включает или отключает exact_theme_names для workspace; API-ключ вызывающего должен быть создан для владельца или администратора workspace, иначе вызов вернёт 403, даже если передан themes:write. При включении существующие темы в фоновом режиме перемещаются под точные имена, по которым они обслуживаются; для темы, содержимое которой было заменено под её точным именем, возвращается restart_required: true из get_theme/list_themes/update_theme_content, пока restart_cluster_instances не перезапустит экземпляры Keycloak этого кластера. Перезапуск может быть отложен до окна обслуживания кластера, а не выполнен сразу; об этом сообщают deferred: true и, если известно, next_window. Операция create_cluster выполняется асинхронно: опрашивайте get_cluster, пока кластер не перейдёт в состояние available. create_domain возвращает DNS-записи, которые должен создать клиент; verify_domain запускает проверку DNS. set_theme_assignment активирует пользовательскую тему для каждого типа тем Keycloak (пустая строка сбрасывает настройку на встроенное значение по умолчанию). update_theme_content заменяет архив темы на месте (ZIP в base64 или JAR Keycloakify в content_base64), сохраняя ID, имя, realm и назначения приложения темы. Поэтому для редактирования темы больше не нужно удалять её и загружать заново; операция требует confirm=true, поскольку перезаписанный архив невозможно восстановить, а update_theme по-прежнему изменяет только имя, описание и версию. Описание вызова см. в docs/theme-content-update.md. update_cluster_security не изменяет настройки CAPTCHA. Импорт и экспорт realm перемещают конфигурацию одного realm и отличаются от create_export, который выгружает базу данных всего кластера: обе операции асинхронны, а архив realm всегда зашифрован, поэтому для повторного импорта потребуется пароль, использованный при экспорте. Realm можно импортировать напрямую из существующего экспорта (source_export_id) или из загруженного архива (create_realm_import_upload_url, PUT, затем upload_s3_key); при импорте создаётся realm, а при совпадении имени операция завершается отказом, а не перезаписывает существующий realm. Для импорта требуется confirm=true, поскольку вместе с realm импортируются пользователи и учётные данные.
Экземпляры OpenFGA: для каждого инструмента OpenFGA требуется cluster_id. create_openfga_instance привязывает экземпляр OpenFGA к одному realm кластера; у realm может быть не более одного экземпляра. Операция возвращает 403, если план workspace не включает OpenFGA или достигнут лимит экземпляров workspace, 409, если у realm уже есть экземпляр, и 422, если realm находится в состоянии master, не существует или отключён. Операция выполняется асинхронно: опрашивайте get_openfga_instance, пока status не перейдёт в состояние ready или failed. Экземпляр принимает только токены этого realm, содержащие его audience, а get_openfga_instance возвращает api_url, issuer и audience, необходимые для вызова. Маппер audience, добавляющий audience в токены realm, добавляется в Keycloak. Просмотр списка и удаление доступны без доступа к OpenFGA. delete_openfga_instance удаляет развёртывание, маршрут и базу данных; содержащиеся в ней данные авторизации восстановить невозможно. Пока экземпляр не удалён, он отображается в состоянии deleting.
Расположение кластеров: location в create_cluster, а также в значениях, возвращаемых list_clusters, get_cluster и list_cluster_locations, — это одно из значений us (восток США), us-west (запад США), ca (Канада), eu (Европа) или au (Австралия), регистр не имеет значения. us всегда означает восток США. us-west доступно только workspace, которым предоставлен доступ: list_cluster_locations перечисляет все расположения, для которых в вашем workspace установлено значение available, а при создании кластера в недоступном расположении API возвращает 400 «location not available».
Подсказки
Восемь подсказок помогут начать работу с этим набором инструментов. Клиенты показывают их как команды со слешем или предлагаемые действия; каждая принимает аргументы (realm, кластер, временной интервал) и направляет модель к нужным инструментам в правильном порядке.
| Запрос | Что делает |
|---|---|
audit_self_registration | Находит все realm, в которых по-прежнему разрешена самостоятельная регистрация, в одном или во всех кластерах |
review_upgrades | Выявляет кластеры с устаревшей версией Keycloak и описывает путь обновления |
triage_failed_logins | Получает недавние неудачные попытки входа в realm и группирует их по исходному IP-адресу |
review_identity_providers | Перечисляет SSO-подключения realm и проверяет, включено ли конкретное |
review_admin_changes | Показывает, кто и что недавно изменил в realm, уделяя особое внимание настройкам входа и безопасности |
provision_environment | Создаёт кластер, добавляет realm и настраивает поставщика удостоверений, подтверждая каждый шаг |
set_up_custom_domain | Добавляет пользовательский домен, возвращает точные DNS-записи, проверяет их и направляет домен в realm |
rotate_client_secret | Заново создаёт секрет клиента приложения, предварительно описав масштаб последствий |
Доступ к запросам ограничен так же, как и к упоминаемым в них инструментам: три запроса, изменяющие данные, предлагаются только сеансам, которым доступны соответствующие инструменты записи, а их инструкции требуют подтвердить изменения у вас. Кроме того, по-прежнему действует требование confirm=true для деструктивных инструментов.
Навыки
Если запрос — это отправная точка, то навык представляет собой полноценное операционное руководство, которое модель загружает по требованию. Сервер поставляет четыре навыка через черновое расширение SEP-2640 Skills: оно объявляет io.modelcontextprotocol/skills в своих возможностях, отвечает на skills/list и skills/get, а каждый SKILL.md предоставляет как обычный ресурс по адресу skill://<name>/SKILL.md с дайджестом sha256 в записи списка. Каталог плагинов OpenAI импортирует навыки именно в таком формате.
| Навык | Что в нём описано |
|---|---|
auth-incident-triage | Разбор ситуации «пользователи не могут войти»: отделение сбоев платформы от атак и изменений конфигурации с использованием событий, журналов WAF и состояния кластера. Только чтение |
enterprise-sso-rollout | Сквозное подключение корпоративного IdP к realm: проверка issuer, регистрация вышестоящего приложения, настройка брокера, проверка подключения и подтверждение по реальным событиям входа |
keycloak-migration-doctor | Предварительная проверка экспорта, импорта или миграции Keycloak на наличие проблем, с которыми действительно сталкивается служба поддержки (политики скриптов, устаревший путь /auth, ожидания относительно частичного экспорта), а также диагностика неудачного задания по его реальному error_message, а не по общему уведомлению на панели |
keycloak-upgrade-readiness | Оценка расхождений версий, выяснение того, что нарушает новая версия Keycloak (расширения, темы), и планирование последовательности развёртывания в разных средах с экспортом в качестве плана отката |
Доступ к навыкам ограничен так же, как и к упоминаемым в них инструментам: три сценария, основанные на инструментах записи, недоступны сеансам только для чтения, а сеансу с ограниченной областью предлагаются только навыки, инструменты которых ему доступны. Исходные файлы находятся в internal/tools/skills/, по одному каталогу на навык, в стандартном формате Agent Skills, поэтому их можно просто скопировать в локальный каталог навыков.
Подключение
Для размещённого HTTP-сервера проще всего использовать OAuth — для этого не нужны учётные данные:
claude mcp add --transport http skycloak https://mcp.skycloak.io
При первом вызове откроется браузер. Подтвердите вход на странице Skycloak — после этого появятся инструменты. Если вы состоите в нескольких рабочих пространствах, укажите нужное:
claude mcp add --transport http skycloak "https://mcp.skycloak.io?workspace=<workspace-id>"
В противном случае создайте API-ключ на панели управления Skycloak и настройте MCP-клиент на его передачу в качестве токена bearer:
claude mcp add --transport http skycloak https://mcp.skycloak.io --header "Authorization: Bearer sk_sc_XXX"
Это добавит следующее в .claude.json:
{
"mcpServers": {
"skycloak": {
"type": "http",
"url": "https://mcp.skycloak.io",
"headers": {
"Authorization": "Bearer sk_sc_XXX"
}
}
}
}
Gemini CLI устанавливает размещённый сервер как расширение из манифеста в этом репозитории:
gemini extensions install https://github.com/sky-cloak/skycloak-mcp
Antigravity устанавливает размещённый сервер как плагин из пакета в plugins/skycloak/:
agy plugin install ./plugins/skycloak
Copilot CLI устанавливает его из манифеста Agent Plugins в корне репозитория после одобрения записи:
copilot plugin install skycloak@awesome-copilot
Для локального stdio сначала выполните вход, а затем укажите клиенту skycloak-mcp run:
skycloak-mcp init # one-time browser sign-in; stores a key in your keychain
Claude Desktop / Cursor (локально, stdio):
{
"mcpServers": {
"skycloak": {
"command": "skycloak-mcp",
"args": ["run", "--transport", "stdio"]
}
}
}
Claude Code:
claude mcp add skycloak -- skycloak-mcp run --transport stdio
Для headless-режима / CI (без браузера) пропустите init и передайте ключ: добавьте "env": { "SKYCLOAK_API_KEY": "sk_sc_..." } в конфигурацию или claude mcp add skycloak --env SKYCLOAK_API_KEY=sk_sc_... -- skycloak-mcp run --transport stdio.
Добавляйте --allow-writes только если собираетесь вносить изменения (войдите с помощью skycloak-mcp init --allow-writes или используйте ключ с правами записи).
Добавьте ?readonly=true к URL размещённого HTTP-сервера, чтобы открыть для этого HTTP-сеанса только инструменты чтения, или ?readonly=false, чтобы запросить набор инструментов с правами записи. По умолчанию параметр запроса имеет значение false, но инструменты записи регистрируются, только если сервер запущен с --allow-writes.
Добавьте ?workspace=<uuid>, чтобы выбрать рабочее пространство, от имени которого действует сеанс OAuth. Это нужно только в том случае, если вы состоите более чем в одном рабочем пространстве. Если рабочее пространство одно, сервер выберет его сам; если их несколько и ни одно не указано, подключение завершится ошибкой со списком доступных рабочих пространств.
Запуск HTTP-транспорта
skycloak-mcp run --transport http --http-addr :8080
Собственные учётные данные ему не нужны: вызывающие стороны передают их в каждом запросе, поэтому при развёртывании ничего не требуется внедрять. GET /healthz и GET /readyz не требуют аутентификации и сообщают только о том, что процесс запущен; они намеренно не проверяют доступность API Skycloak, чтобы кратковременный сбой вышестоящего сервиса не приводил к одновременному провалу проверок всех реплик. Сервер не хранит состояние сеансов, поэтому репликам не нужна привязка сеансов, и их можно свободно масштабировать или перезапускать. SIGTERM прекращает принимать новые подключения и завершает обработку текущих вызовов.
Путь OAuth включён, если заданы SKYCLOAK_ISSUER и SKYCLOAK_DASHBOARD_URL; по умолчанию они заданы. В этом случае GET /.well-known/oauth-protected-resource предоставляется без аутентификации и указывает realm в качестве сервера авторизации. Значение resource берётся из SKYCLOAK_PUBLIC_URL, если оно задано, а иначе — из Host и схемы самого запроса, поэтому для развёртывания на одном хосте за ingress дополнительная настройка не нужна. Схема берётся из X-Forwarded-Proto, если оно задано, а иначе для любого хоста, кроме loopback, используется https: TLS завершается на вышестоящем узле, и публикация идентификатора http:// не соответствовала бы URL, по которому подключился клиент. Задайте SKYCLOAK_PUBLIC_URL, если ваш ingress переписывает Host. Документ также указывает openid profile email в качестве scopes_supported, а запрос WWW-Authenticate повторяет их в параметре scope, поэтому клиент, прочитав любой из них, запрашивает их у realm: openid обязателен, поскольку при обмене токена панель управления обращается к конечной точке userinfo Keycloak, а Keycloak отклоняет токен, выданный без него. Если токен приходит без этого параметра, проверка отклоняет его с 401 и запросом аутентификации, вместо того чтобы передавать его на заведомо неудачный обмен. Поэтому клиент, у которого ещё есть ранее выданный токен, перестаёт повторять запросы и выполняет вход заново. Если очистить любую из переменных issuer или панели управления, OAuth полностью отключится, и сервер будет запрашивать только API-ключ.
OPENAI_APPS_CHALLENGE_TOKEN предоставляет токен проверки домена каталога плагинов OpenAI
по адресу /.well-known/openai-apps-challenge в виде обычного текста без какого-либо другого содержимого. Если переменная не задана,
маршрут не регистрируется, и путь возвращает 404.
При запуске в одной строке журнала указываются определённые параметры подключения (oauth=, issuer=, dashboard=, public_url=, endpoint=, allow_writes=), чтобы можно было обнаружить ошибочную конфигурацию без повторного развёртывания. Для каждого запроса, отклонённого на пути OAuth, в журнал записывается одна строка с указанием этапа сбоя (verify, exchange или scopes), полученного вызывающей стороной статуса и исходной ошибки. При сбое проверки добавляется проверка, отклонившая токен (expired, wrong_issuer, bad_signature, unknown_key_id, wrong_token_type, no_openid_scope и так далее); при сбое обмена добавляются статус панели управления и вызванный хост. После проверки токена вызывающая сторона указывается по его subject, но никогда не по учётным данным: токен доступа, заголовок Authorization и созданный API-ключ никогда не попадают в журнал.
Что сервер отправляет в API Skycloak
Размещённый сервер и локальный бинарный файл отправляют в API Skycloak одинаковые заголовки (SKYCLOAK_ENDPOINT):
| Заголовок | Значение | Назначение |
|---|---|---|
API-Key | ваш API-ключ или ключ, созданный для сеанса | аутентификация запроса |
API-Version | SKYCLOAK_API_VERSION | фиксирует контракт API, для которого был собран сервер |
User-Agent | skycloak-mcp/<version> | идентифицирует клиент |
X-MCP-Tool | зарегистрированное имя инструмента, например skycloak_list_realms | указывает, какой инструмент выполнил запрос |
X-MCP-Call-Id | случайный UUID, создаваемый один раз для каждого вызова инструмента | объединяет все запросы одного вызова |
X-MCP-Tool и X-MCP-Call-Id отправляются только в запросах, выполняемых при обработке вызова инструмента. Один вызов может выполнять несколько запросов: по одному для каждого кластера, если cluster_id не указан, а также повторные запросы для 429 или 5xx; все они используют один и тот же идентификатор вызова. Skycloak использует эту пару, чтобы подсчитывать частоту использования каждого инструмента и определять, какие инструменты улучшать, документировать или выводить из эксплуатации. В них нет аргументов, результатов или каких-либо сведений о вас, кроме тех, которые уже определяются API-ключом. Они отправляются только в API Skycloak, а не в ваши кластеры Keycloak и никуда больше. Запросы вне вызова инструмента, например для входа и создания API-ключей, не содержат ни одного из этих заголовков.
Конфигурация
| Переменная среды | Значение по умолчанию |
|---|---|
SKYCLOAK_API_KEY | отсутствует (необязательна для stdio; HTTP-клиенты вместо неё передают заголовки API-Key) |
SKYCLOAK_ENDPOINT | https://api.skycloak.io |
SKYCLOAK_API_VERSION | текущая версия API |
SKYCLOAK_ISSUER | https://login.app.skycloak.io/realms/skycloak (вход через CLI и сервер авторизации, по которому HTTP-транспорт проверяет токены) |
SKYCLOAK_CLIENT_ID | skycloak-mcp (только поток устройства CLI) |
SKYCLOAK_DASHBOARD_URL | https://app.skycloak.io (создаёт ключи CLI и ключи HTTP-сеансов) |
SKYCLOAK_PUBLIC_URL | отсутствует (определяется по каждому запросу; задайте, если ingress переписывает Host) |
OPENAI_APPS_CHALLENGE_TOKEN | Предоставляет токен проверки каталога плагинов OpenAI по адресу /.well-known/openai-apps-challenge. Если переменная не задана, этот путь возвращает 404. |
Команды: init (вход через браузер), run (запуск сервера), logout (удаление сохранённого ключа). init принимает --workspace <id>, --allow-writes, --allow-credentials и --ttl-days (по умолчанию 90).
| Флаг | Значение по умолчанию | Описание |
|---|---|---|
--transport | stdio | stdio или http |
--http-addr | :8080 | адрес прослушивания HTTP-транспорта |
--allow-writes | false | включает инструменты изменения данных для stdio и разрешает HTTP-сеансам с readonly=false регистрировать инструменты записи |
Разработка
make build # build the server binary
make test # unit tests
make run # run on stdio for local testing
make inspector # MCP Inspector against the local binary
make lint # golangci-lint
make generate # regenerate the API client from the OpenAPI spec
Клиент API в internal/apiclient сгенерирован из спецификации Skycloak OpenAPI
с помощью oapi-codegen.
Синхронизация с API
Клиент в internal/apiclient сгенерирован из internal/apiclient/openapi.yaml с помощью oapi-codegen; для его обновления выполните make generate. CI завершится ошибкой, если сгенерированный код в репозитории будет расходиться со спецификацией. Повторные запросы при 429/5xx выполняются с задержкой, учитывающей Retry-After.
Распространение
При каждом теге выпускаются бинарные файлы GitHub и образ контейнера ghcr.io/sky-cloak/skycloak-mcp, а также выполняется публикация в MCP Registry под именем io.skycloak/skycloak-mcp. Большинству пользователей не нужно ни то ни другое: для размещённого сервера установка не требуется.
Пакеты плагинов
plugins/skycloak/ — это одна папка для двух клиентов: .antigravity-plugin/plugin.json с mcp_config.json для Antigravity и .claude-plugin/plugin.json для Claude. Оба клиента подключаются к размещённому серверу и поставляются с четырьмя навыками, которые побайтно совпадают с internal/tools/skills/, поскольку установщик получает только эту папку.
Файлы plugin.json и mcp.json в корне репозитория содержат манифест Agent Plugins v1.0.0, который использует маркетплейс GitHub awesome-copilot. Этот формат не поддерживает поле для логотипа, поэтому логотип для списка хранится в extensions["com.github.copilot"].
Поле version в этих манифестах и в .grok-plugin/plugin.json задаётся CI на основе тега релиза, поскольку списки каталогов отслеживают main. Это описано в разделе об обновлении каталогов файла README плагина.
Безопасность
Пожалуйста, сообщайте об уязвимостях конфиденциально. См. SECURITY.md.
Участники
Создано в Skycloak Гильяно Молером, Невиллом Оманги и Афиласом. История репозитория была схлопнута при открытии репозитория, поэтому журнал коммитов не отражает, кто что написал.
Лицензия
Apache-2.0. Описание OpenAPI в internal/apiclient/openapi.yaml создано на основе API платформы Skycloak и является собственностью Skycloak; оно включено сюда, чтобы можно было сгенерировать и проверить клиент. См. NOTICE.