UI5 MCP Server

Official SAP server that lets AI agents scaffold UI5 projects, look up API references, retrieve best practices, and validate code via linter and manifest checks.

Description

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.

Requirements

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.

Installation instructions

The UI5 MCP Server runs as a local stdio process and can be connected to an MCP-capable client in a few steps.

Step 1: Prerequisites

Install Node.js version 20.17.0 or 22.9.0 (or newer) and npm version 8 or newer. An existing UI5 project isn't strictly required — create_ui5_app can also scaffold a brand-new project from scratch.

Step 2: Connecting the server to your client

For most MCP clients, the standard configuration works with npx -y @ui5/mcp-server as the stdio command. Claude Code users can set it up directly via the CLI:

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

Codex has the analogous command codex mcp add --transport stdio ui5-mcp-server -- npx -y @ui5/mcp-server. VS Code additionally offers installation directly from the GitHub MCP server registry. On native Windows (outside WSL), npx may need to be wrapped with cmd /c, since the process call can otherwise fail.

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

Recording project conventions for the agent

To make an agent use the server proactively, the official documentation recommends adding a short rule to the project-wide AGENTS.md or CLAUDE.md file: instructing the agent to call get_guidelines before UI5-specific tasks to fetch current coding standards, rather than relying on potentially outdated training knowledge.

First steps with the agent

For a new project, ask the agent to call create_ui5_app with a suitable template. In an existing project, get_project_info gives an initial overview of the framework variant (SAPUI5 or OpenUI5) and version. Before larger changes, it's worth checking get_api_reference for the affected controls, and after finishing a change, run_ui5_linter and run_manifest_validation verify that the generated code follows official conventions.

Step 3: Adjusting the configuration

If the default domain list (localhost, services.odata.org) isn't enough because the project connects to additional OData services, add further domains to UI5_MCP_SERVER_ALLOWED_DOMAINS as an environment variable in the client configuration. Teams working exclusively with SAPUI5 rather than OpenUI5 usually don't need to change anything — the server detects the framework variant automatically from the project configuration and picks the matching CDN source.

Common pitfalls

Without a supported Node.js version, the server won't start at all; running node --version before setup saves unnecessary troubleshooting. If a tool needs an external domain for API calls that isn't in the allowlist, the affected tools fail until the domain is added. Since the server runs purely locally, it doesn't work as a shared team endpoint — each developer sets it up individually on their own machine.

bash
node --version

Step 4: Standardizing the setup across a team

Because every developer starts the server locally on their own, it's worth documenting the client configuration (the claude mcp add command or the equivalent entry for Codex/Cursor) together with the AGENTS.md rule to call get_guidelines, right in the project repository instead of passing it along verbally. That way new team members start with the same configuration and the same agent behavior, without diverging local settings creeping in and producing inconsistent code that partly violates UI5 conventions.

bash
claude mcp add
npx -y @ui5/mcp-server

Authentication

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

Required access permissions

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.

Transmitted or stored data

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.

Security risks

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.

License and costs

License
Apache-2.0
Cost
free

The server is part of the Apache-2.0-licensed UI5 tooling ecosystem and fully free to use, with no account or subscription. Using SAPUI5-specific controls may require an existing SAP license agreement; the MCP tool itself does not add any extra cost.

Alternatives

Not recorded yet.

At a glance

Provider
SAP
Status
Official server
Deployment
Local
Current version
0.2.20
GitHub stars
104
Last reviewed
16.09.2026

Repository and documentation

Categories

Supported clients