mcp-server · ui5 — Claude Code MCP server: what it does, how to install
Connects SAPUI5 and OpenUI5 developer tooling to AI assistants. Helps scaffold apps, inspect manifest schemas, and run linters directly in chat.
claude mcp add --env UI5_MCP_SERVER_ALLOWED_DOMAINS=<UI5_MCP_SERVER_ALLOWED_DOMAINS> --env UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT=<UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT> --env UI5_MCP_SERVER_RESPONSE_NO_RESOURCES=<UI5_MCP_SERVER_RESPONSE_NO_RESOURCES> --env UI5_LOG_LVL=<UI5_LOG_LVL> --env UI5_DATA_DIR=<UI5_DATA_DIR> --transport stdio ui5-mcp-server -- npx -y @ui5/mcp-serverWhat mcp-server does
This server equips AI coding agents with OpenUI5 and SAPUI5 utilities. It provides tools to generate starter projects from templates and scaffold UI Integration Cards. Assistants can also pull API documentation on demand or review guidelines for migrating JavaScript components to TypeScript.
Quality checks rely on @ui5/linter and schema validation for manifest.json. The agent reads project metadata to spot framework-specific bugs and recommend fixes. You need Node.js. Compatible versions are v20.17.0, v22.9.0 or higher with npm v8.0.0 or newer.
Native Windows systems outside WSL require prefixing npx with cmd /c in the client configuration. For clients without MCP resource support such as Cursor, set the UI5_MCP_SERVER_RESPONSE_NO_RESOURCES environment variable to disable resources in server responses.
What it helps with
- scaffold a new SAPUI5 or OpenUI5 application from templates
- generate a UI Integration Card starter
- validate manifest.json against the UI5 schema
- run @ui5/linter to catch framework-specific code issues
- retrieve guidelines for converting UI5 code to TypeScript
Example prompts for the agent
- Scaffold a new OpenUI5 application using the default template
- Validate the project manifest.json against the UI5 schema
- Run @ui5/linter on this project and fix any detected errors
How to install mcp-server
Platform CLI
claude mcp add --env UI5_MCP_SERVER_ALLOWED_DOMAINS=<UI5_MCP_SERVER_ALLOWED_DOMAINS> --env UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT=<UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT> --env UI5_MCP_SERVER_RESPONSE_NO_RESOURCES=<UI5_MCP_SERVER_RESPONSE_NO_RESOURCES> --env UI5_LOG_LVL=<UI5_LOG_LVL> --env UI5_DATA_DIR=<UI5_DATA_DIR> --transport stdio ui5-mcp-server -- npx -y @ui5/mcp-serverReplace <…> with your own values
Platform CLI
codex mcp add ui5-mcp-server --env UI5_MCP_SERVER_ALLOWED_DOMAINS=<UI5_MCP_SERVER_ALLOWED_DOMAINS> --env UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT=<UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT> --env UI5_MCP_SERVER_RESPONSE_NO_RESOURCES=<UI5_MCP_SERVER_RESPONSE_NO_RESOURCES> --env UI5_LOG_LVL=<UI5_LOG_LVL> --env UI5_DATA_DIR=<UI5_DATA_DIR> -- npx -y @ui5/mcp-serverReplace <…> with your own values
Config file
{
"mcpServers": {
"ui5-mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
],
"env": {
"UI5_MCP_SERVER_ALLOWED_DOMAINS": "<UI5_MCP_SERVER_ALLOWED_DOMAINS>",
"UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT": "<UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT>",
"UI5_MCP_SERVER_RESPONSE_NO_RESOURCES": "<UI5_MCP_SERVER_RESPONSE_NO_RESOURCES>",
"UI5_LOG_LVL": "<UI5_LOG_LVL>",
"UI5_DATA_DIR": "<UI5_DATA_DIR>"
}
}
}
}Replace <…> with your own values
Config file
{
"servers": {
"ui5-mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
],
"env": {
"UI5_MCP_SERVER_ALLOWED_DOMAINS": "<UI5_MCP_SERVER_ALLOWED_DOMAINS>",
"UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT": "<UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT>",
"UI5_MCP_SERVER_RESPONSE_NO_RESOURCES": "<UI5_MCP_SERVER_RESPONSE_NO_RESOURCES>",
"UI5_LOG_LVL": "<UI5_LOG_LVL>",
"UI5_DATA_DIR": "<UI5_DATA_DIR>"
}
}
}
}Replace <…> with your own values
Platform CLI
gemini mcp add -e UI5_MCP_SERVER_ALLOWED_DOMAINS=<UI5_MCP_SERVER_ALLOWED_DOMAINS> -e UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT=<UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT> -e UI5_MCP_SERVER_RESPONSE_NO_RESOURCES=<UI5_MCP_SERVER_RESPONSE_NO_RESOURCES> -e UI5_LOG_LVL=<UI5_LOG_LVL> -e UI5_DATA_DIR=<UI5_DATA_DIR> ui5-mcp-server npx -y @ui5/mcp-serverReplace <…> with your own values
Step by step, with commands for each platform: How to add an MCP server to Claude Code, Codex, Cursor, VS Code, Gemini CLI and more
Questions about mcp-server
How do I install mcp-server in Claude Code?
Run claude mcp add mcp-server -- npx -y @ui5/mcp-server in your terminal to register the server.
What does mcp-server do?
It provides tools for AI assistants to scaffold OpenUI5 and SAPUI5 apps, check manifest schemas, run @ui5/linter, and fetch framework API reference documentation.
How should I configure the server for Windows or Cursor?
On native Windows without WSL, prefix the npx command with cmd /c. For clients like Cursor that lack MCP resource support, define the UI5_MCP_SERVER_RESPONSE_NO_RESOURCES environment variable.
Similar MCP servers
Everything for Frontend and UI →mcp-server by other authors comes first.
