RELATED 01
UI5 Web Components for React MCP Server
OFFICIAL SERVERComponent APIs, guides and app templates for UI5 Web Components for React, served offline
542GitHub stars
570/wknpm downloads
52popularity score
UI5 MCP Server
SAP's MCP server for building, checking and documenting SAPUI5 and OpenUI5 apps
Official · UI5 TypeScript Local · stdio Developer tools
77 popularity score ★ 108 ↓ 106k/wk
Connect your client
Local (npm)
Add in one click
Opens the app, which asks before it adds the server.
Or add it by command or config
Claude CodeTerminal
claude mcp add ui5 -- npx -y @ui5/mcp-serverClaude Desktopclaude_desktop_config.json
{
"mcpServers": {
"ui5": {
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}Cursor~/.cursor/mcp.json
{
"mcpServers": {
"ui5": {
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}VS Code.vscode/mcp.json
{
"servers": {
"ui5": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}Codex~/.codex/config.toml
[mcp_servers.ui5]
command = "npx"
args = ["-y", "@ui5/mcp-server"]Gemini CLITerminal
gemini mcp add --scope user ui5 npx -- -y @ui5/mcp-serverSettings 6
UI5_MCP_SERVER_ALLOWED_DOMAINS |
Optional: Comma-separated hosts that OData URLs may use; default localhost, services.odata.org; empty allows any. |
|---|---|
UI5_MCP_SERVER_CDN_URL |
Optional: Base URL for UI5 resources instead of sdk.openui5.org / ui5.sap.com. |
UI5_MCP_SERVER_RESPONSE_NO_RESOURCES |
Optional: Set to any value to leave MCP resources out of responses, for clients without resource support. |
UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT |
Optional: Set to any value to turn off structured content in responses. |
UI5_DATA_DIR |
Optional: Where cached data such as API references is kept; default ~/.ui5. |
UI5_LOG_LVL |
Optional: Log level, from silent to silly; default info. |
What it does
The UI5 MCP Server is SAP's own server for working on SAPUI5 and OpenUI5 front-end projects from a coding assistant. It runs locally over stdio through npx and has ten tools in version 0.3.2. They fall into three groups: scaffolding a new UI5 app or UI Integration Card, checking existing code (running the UI5 linter, validating manifest.json against the UI5 manifest schema), and supplying reference material (API documentation for a given control, framework version data, project metadata, and SAP's written guidelines for UI5, Integration Cards and JavaScript-to-TypeScript conversion).
The scaffolding tool goes further than writing files. In the 0.3.2 source, create_ui5_app defaults to SAPUI5, TypeScript and the latest framework version, refuses any version older than 1.96.0, and stops if the target folder already exists. Unless told otherwise it then runs npm install in the new folder and makes a git repository with an initial commit (runNpmInstall and initializeGitRepository both default to true). Given an OData V4 service URL, it reads the service metadata and builds the app around one entity set. A URL starting with / is taken to mean http://localhost:4004, the usual address of a local CAP service.
API references are fetched from the UI5 CDN (sdk.openui5.org or ui5.sap.com, or the address in UI5_MCP_SERVER_CDN_URL) and cached under ~/.ui5 by default. The makers suggest adding a line to AGENTS.md or CLAUDE.md that tells the assistant to call get_guidelines first.
What it needs
| Runtime | Node.js 20+ |
|---|
Node.js 20.17.0, or 22.9.0 or later, and npm 8 or later. git must be on PATH if create_ui5_app is to set up a repository, which it does by default. Fetching API references and running npm install for a new app need internet access. No account or key is needed. On native Windows the docs say npx may need the cmd /c prefix.
Limits
Version 0.3.2 is still pre-1.0. Tools that take an OData service URL accept only localhost and services.odata.org by default. Other hosts need to be added to UI5_MCP_SERVER_ALLOWED_DOMAINS, and an empty value allows any host. create_ui5_app will not write into an existing folder and will not target UI5 versions older than 1.96.0. The server takes no command-line arguments; every setting is an environment variable. Clients that do not support MCP resources (the README names Cursor and Gemini CLI) need UI5_MCP_SERVER_RESPONSE_NO_RESOURCES set.
Who it suits
It suits developers building SAPUI5 or OpenUI5 freestyle apps or Integration Cards who want their assistant to scaffold projects, lint code and look up the framework's API without leaving the editor. It is published by the UI5 team at SAP and runs entirely on your machine. It is not the server for UI5 Web Components: SAP keeps separate servers for those (webcomponents-mcp-server and the UI5 Web Components for React MCP server), which we also list. Outside UI5 work it has nothing to offer.
Tools 10
create_ui5_app- Generates a new UI5 app from templates, optionally bound to an OData V4 service, then runs npm install and git init by default
create_integration_card- Generates a new UI Integration Card project
get_api_reference- Fetches and formats the API documentation for a UI5 class or control from the CDN
get_guidelines- Returns SAP's coding guidelines and best practices for UI5
get_integration_cards_guidelines- Returns guidelines for building UI Integration Cards
get_project_info- Reads a UI5 project's configuration and metadata, such as framework and version
get_typescript_conversion_guidelines- Returns guidance for moving UI5 apps and controls from JavaScript to TypeScript
get_version_info- Gives release and version details for the UI5 framework
run_manifest_validation- Checks a manifest.json against the UI5 manifest schema
run_ui5_linter- Runs @ui5/linter over a project and reports UI5-specific problems