UI5 MCP Server

The UI5 MCP Server is an official SAP tool for development with SAPUI5 and OpenUI5, the widely used JavaScript framework for enterprise applications with a consistent, accessible user interface. It connects AI coding agents to framework-specific knowledge over the Model Context Protocol — knowledge that would otherwise live only in documentation, style guides, and internal tooling — closing a gap that generic coding assistants typically have with such a specialized, convention-heavy framework: without it, agents can easily produce code that compiles fine but violates UI5 conventions around data binding, modularity, or manifest structure.

Available tools

The repository lists ten MCP tools. create_ui5_app scaffolds new UI5 applications from predefined templates, and create_integration_card generates new UI Integration Cards. get_api_reference returns formatted UI5 API documentation, get_guidelines and get_integration_cards_guidelines give access to official development best practices, and get_typescript_conversion_guidelines supports migrating JavaScript projects to TypeScript. get_project_info extracts metadata and configuration from an existing UI5 project, and get_version_info retrieves framework version information. For quality assurance, run_manifest_validation checks the app manifest file against the official UI5 schema, and run_ui5_linter wires in the already-established @ui5/linter, reporting code issues directly back to the agent.

Installation and setup

The server runs exclusively as a local stdio process; there is no SAP-hosted remote endpoint. It requires Node.js 20.17.0 or 22.9.0 and newer, plus npm 8 or newer. Standard setup runs through npx -y @ui5/mcp-server, and the server can alternatively be installed directly from the GitHub MCP server registry. Claude Code offers the shortcut claude mcp add --transport stdio --scope user ui5-mcp-server -- npx -y @ui5/mcp-server, and Codex has an analogous codex mcp add command. For native Windows environments outside WSL, the documentation recommends wrapping npx with cmd /c.

Configuration and security

Environment variables let you fine-tune the server: UI5_MCP_SERVER_ALLOWED_DOMAINS defaults to localhost and services.odata.org, restricting which domains the tools may reach out to, and can be extended per project. UI5_MCP_SERVER_CDN_URL lets you redirect the source for UI5 resources, defaulting to sdk.openui5.org for OpenUI5 and ui5.sap.com for SAPUI5. Further variables control the log level, the data directory used for cached API references, and disabling structured content or MCP resources for clients that don't support them, such as Cursor or the Gemini CLI.

SAPUI5 and OpenUI5

The npm package describes itself as an "MCP server for SAPUI5/OpenUI5 development," covering both variants of the same framework: the open-source OpenUI5 and the commercial SAPUI5, which adds SAP-specific controls and themes for business applications. The server detects automatically, via get_project_info, which variant a project is configured for, and adjusts the CDN source and API references accordingly.

Who the UI5 MCP Server is for

The server suits teams already working productively with SAPUI5 or OpenUI5 who want AI agents to stay closely tied to official conventions when creating new views, controllers, and fragments, rather than getting generic, framework-unaware code. It is particularly useful for TypeScript migrations of existing UI5 applications and for getting started with UI Integration Cards, where the built-in guideline tools pull directly from official documentation instead of relying on a model's often outdated training knowledge. Teams outside the SAP ecosystem will find a comparable but framework-agnostic tool for component libraries in the catalog's Storybook MCP Server.

Node.js version 20.17.0 or 22.9.0 (or newer), npm version 8 or newer, an existing UI5 project (SAPUI5 or OpenUI5), and an MCP-capable client such as Claude Code, Codex, Cursor, or VS Code Copilot.

Start the server via npx -y @ui5/mcp-server as a stdio process and register it in the MCP client configuration, e.g. via claude mcp add --transport stdio --scope user ui5-mcp-server -- npx -y @ui5/mcp-server in Claude Code or the analogous codex mcp add command in Codex. Alternatively, install directly from the GitHub MCP server registry.

npx -y @ui5/mcp-server

No authentication required; the server runs as a local stdio process on the developer's machine and is not exposed over the network.

Read access to the local UI5 project directory (source code, manifest, configuration) and network access to the domains allowed via UI5_MCP_SERVER_ALLOWED_DOMAINS (defaulting to localhost and services.odata.org) for fetching API references and framework resources.

Project code, manifest contents, and API references retrieved via the tools are sent to the connected AI agent and its model provider. The server itself runs locally and does not send data to SAP; API references are fetched from the configured CDN domains (defaulting to sdk.openui5.org or ui5.sap.com) and cached locally.

The domain allowlist (UI5_MCP_SERVER_ALLOWED_DOMAINS) should not be carelessly opened to all domains, since tools could otherwise reach arbitrary external addresses. If the UI5 project contains real customer data in configuration or sample files, that data reaches the connecting agent's model provider; for sensitive SAP projects, it is advisable to deliberately limit context to anonymized examples.