UI5 MCP Server

Сервер UI5 Model Context Protocol для разработки UI5-приложений.

Описание

Сервер UI5 Model Context Protocol предоставляет инструменты, повышающие удобство работы разработчика с инструментами AI, ориентированными на агентов.

Ключевые возможности

Помогает в создании новых проектов UI5 при работе с агентно-ориентированными инструментами AI
Поддерживает разработчика в обнаружении и исправлении ошибок, специфичных для UI5, в коде
Предоставляет дополнительную UI5-специфическую информацию для инструментов AI с агентной архитектурой

Совет

Не забудьте также ознакомиться с нашим анонсом в блоге SAP Community!

Доступные инструменты

create_integration_card: Создает каркас новой UI Integration Card.
create_ui5_app: Создает каркас нового UI5-приложения на основе набора шаблонов.
get_api_reference: Получает и форматирует документацию UI5 API.
get_guidelines: Предоставляет доступ к лучшим практикам разработки UI5.
get_integration_cards_guidelines: Предоставляет доступ к лучшим практикам разработки UI Integration Cards.
get_project_info: Извлекает метаданные и конфигурацию из проекта UI5.
get_typescript_conversion_guidelines: Предоставляет рекомендации по конвертации UI5-приложений и контролов из JavaScript в TypeScript.
get_version_info": Получает информацию о версии фреймворка UI5.
run_manifest_validation: Валидирует manifest в соответствии с схемой UI5 Manifest.
run_ui5_linter: Интегрируется с @ui5/linter для анализа и уведомления об ошибках в коде UI5.

Требования

Node.js Version v20.17.0, v22.9.0 или выше
npm Версия v8.0.0 или выше
Клиент MCP, например VS Code (GitHub Copilot), Cline, Claude Code, Codex или любой другой клиент, совместимый с MCP

Установка

Стандартная конфигурация для большинства клиентов

Эта конфигурация подходит для большинства MCP-клиентов:

{
    "mcpServers": {
        "@ui5/mcp-server": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "@ui5/mcp-server"
            ]
        }
    }
}

Специальная конфигурация для native Windows На native Windows (не WSL) возможно потребуется префикс для npx с cmd /c:

{
    "mcpServers": {
        "@ui5/mcp-server": {
            "type": "stdio",
            "command": "cmd",
            "args": [
                "/c",
                "npx -y @ui5/mcp-server"
            ]
        }
    }
}

Конкретные клиенты MCP

Помимо общей конфигурации, перечисленной выше, некоторые клиенты MCP предлагают ярлыки для установки MCP-серверов. Ниже приведены инструкции для некоторых популярных клиентов, но также можно обратиться к документации вашего конкретного клиента.

VS Code

Предпочтительно: устанавливать из GitHub MCP server registry

Или можно использовать CLI VS Code:

# Использование VS Code CLI
code --add-mcp '{"name":"@ui5/mcp-server","type": "stdio","command":"npx","args":["-y", "@ui5/mcp-server"]}'

Cline

Откройте панель Cline в VSCode.
Нажмите на значок "MCP Servers" вверху, рядом с символом «плюс»
Перейдите на вкладку "Configure" (Настроить), затем нажмите "Configure MCP servers"
В открывшемся редакторе вставьте вышеуказанную Standard Configuration for Most Clients

Подробности смотрите на docs.cline.bot/mcp/adding-and-configuring-servers.

Claude Code

claude mcp add --transport stdio --scope user ui5-mcp-server -- npx -y @ui5/mcp-server

Codex

codex mcp add --transport stdio ui5-mcp-server -- npx -y @ui5/mcp-server

Добавление правил в ваш проект

Следующие правила направляют крупномасштабные языковые модели (LLMs) на корректное использование сервера MCP для UI5. Добавляйте эти правила в существующий глобальный или проектно-специфичный файл AGENTS.md. Точное расположение может различаться в зависимости от клиента MCP. Например, у Claude Code файл может называться CLAUDE.md вместо AGENTS.md.

## Guidelines for UI5

Use the `get_guidelines` tool of the UI5 MCP server to retrieve the latest coding standards and best practices for UI5 development.

Конфигурация

Сервер UI5 MCP можно сконфигурировать с использованием следующих переменных окружения. Он не принимает аргументы командной строки.

Параметры конфигурации:

UI5_MCP_SERVER_ALLOWED_DOMAINS:

Значение по умолчанию: localhost, services.odata.org

Описание: список доменов через запятую, разрешенных к использованию в различных инструментах, например: localhost, example.com, sub.example.com. Установите пустую строку, чтобы разрешить любые домены.

Для поддоменов-«подстановок» используйте точку в начале: .example.com. Это будет соответствовать www.example.com, но не example.com.

UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT:

Описание: установите любое значение, чтобы отключить структурированный контент в ответах MCP сервера.

UI5_MCP_SERVER_RESPONSE_NO_RESOURCES:

Описание: установите любое значение, чтобы отключить ресурсы в ответах MCP сервера. Это полезно для клиентов, не поддерживающих ресурсы, таких как Cursor или Gemini CLI.

UI5_MCP_SERVER_CDN_URL:

Значение по умолчанию: https://sdk.openui5.org для OpenUI5 и https://ui5.sap.com для SAPUI5

Описание: переопределяет базовый URL, используемый для получения ресурсов UI5 с CDN. Например: https://example.com. При установке этот URL будет использоваться и для OpenUI5, и для SAPUI5. Значение должно быть действительным URL. Обратите внимание, что версия проекта будет автоматически добавлена к URL. Это означает, что во время выполнения URL может выглядеть так: https://example.com/1.120.0/resources/[...].
UI5_LOG_LVL:

Значение по умолчанию: info

Описание: внутренний уровень логирования [log level] (https://ui5.github.io/cli/stable/pages/Troubleshooting/#changing-the-log-level): silent, error, warn, info, perf, verbose, silly
UI5_DATA_DIR:

Значение по умолчанию: директория .ui5 в домашнем каталоге пользователя

Описание: Каталог, в котором MCP server хранит данные, такие как кэшированные ссылки на API.

Поддержка, обратная связь, вклад

Этот проект открыт к запросам функций/предложениям, баг-репортам и т. д. через issues на GitHub. Вклад и обратная связь приветствуются и всегда уместны. Для получения дополнительной информации о том, как вносить вклад, структуре проекта и другой информации о участии смотрите наши Contribution Guidelines.

Вы можете также пообщаться с нами в канале [#tooling] открытого сообщества OpenUI5 Slack: OpenUI5 Community Slack. Для публичных вопросов и ответов используйте тег [ui5-tooling] на Stack Overflow.

Безопасность / Раскрытие

Если вы нашли ошибку, которая может быть проблемой безопасности, следуйте нашим инструкциям в нашей политике безопасности о том, как сообщать об этом. Пожалуйста, не создавайте GitHub-issues по общим сомнениям или проблемам, связанным с безопасностью.

Кодекс поведения

Мы, участники, вкладчики и лидеры сообщества, обязуемся обеспечить безопасную и недискриминационную среду для участия каждого. Участвуя в этом проекте, вы соглашаетесь соблюдать наш Code of Conduct в любое время.

Лицензирование

Copyright 2026 SAP SE или аффилированная компания SAP и участники проекта UI5 MCP server. Смотрите наш LICENSE для информации об авторских правах и лицензировании. Подробная информация, включая сторонние компоненты и их лицензирование/авторское право, доступна через инструмент REUSE.