Scaffolds UI5 apps and integration cards, fetches API docs, validates manifests, and runs the UI5 linter for agentic AI clients.
Also known as UI5/mcp-server, @ui5/mcp-server
- Stars
- 108
- Tools
- 10
- Downloads, 30 days
- —
- Latest version
- 0.3.3
- Last commit
- Nov 10, 2026
- License
- Apache-2.0
What is UI5 MCP?
UI5 scaffolds UI5 apps and integration cards, fetches API docs, validates manifests, and runs the UI5 linter for agentic AI clients. It exposes 10 tools, such as create_integration_card, create_ui5_app, get_api_reference.
Summary generated from the project's README
About UI5 MCP server
Scaffolding UI5 applications and integration cards through agentic AI is what this server enables for developers. It provides a specialized toolkit for AI clients like Claude Code, Cline, or VS Code to interact directly with the UI5 framework. By integrating with the Model Context Protocol, it allows an AI agent to perform complex development tasks such as validating manifests against schemas, running the UI5 linter to find code issues, and fetching formatted API documentation.
Users set up the server via npx using a standard configuration in their MCP client. It requires Node.js version 20.17.0 or 22.9.0 and higher, along with npm. The server can be customized through environment variables to manage allowed domains, override CDN URLs for SAPUI5 or OpenUI5 resources, and control logging levels. It is designed to bridge the gap between large language models and the specific requirements of UI5 project structures and best practices.
Written from the project's README. Every use case is checked against a quote from it.
How to install UI5 MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall UI5 MCP in Claude Code
$ claude mcp add mcp-server -- npx -y @ui5/mcp-serverInstall UI5 MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}Install UI5 MCP in VS Code
.vscode/mcp.json
{
"servers": {
"mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}Install UI5 MCP in VS Code CLI
$ code --add-mcp '{"name":"mcp-server","type":"stdio","command":"npx","args":["-y","@ui5/mcp-server"]}'Install UI5 MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}Install UI5 MCP in Codex
$ codex mcp add mcp-server -- npx -y @ui5/mcp-serverInstall UI5 MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.mcp-server] command = "npx" args = ["-y", "@ui5/mcp-server"]
Install UI5 MCP in Gemini CLI
$ gemini mcp add -s user mcp-server npx -- -y @ui5/mcp-serverInstall UI5 MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}UI5 MCP tools 10
Detected from the READMEcreate_integration_cardcreate_ui5_appget_api_referenceget_guidelinesget_integration_cards_guidelinesget_project_infoget_typescript_conversion_guidelinesget_version_inforun_manifest_validationrun_ui5_linter
| create_integration_card | — | |
| create_ui5_app | — | |
| get_api_reference | — | |
| get_guidelines | — | |
| get_integration_cards_guidelines | — | |
| get_project_info | — | |
| get_typescript_conversion_guidelines | — | |
| get_version_info | — | |
| run_manifest_validation | — | |
| run_ui5_linter | — |
Configuration
UI5_DATA_DIRDirectory where the MCP server stores its data, such as cached API references. Defaults to the '.ui5' directory in the user's home directory.
UI5_LOG_LVLInternal log level (https://ui5.github.io/cli/stable/pages/Troubleshooting/#changing-the-log-level): 'silent', 'error', 'warn', 'info', 'perf', 'verbose' or 'silly'
UI5_MCP_SERVER_ALLOWED_DOMAINSA comma-separated list of domains that are allowed to be used in various tools, for example: 'localhost, example.com, sub.example.com'. Set to an empty string to allow any domains. For wildcard subdomains, prefix the domain with a dot: '.example.com'. This will match 'www.example.com' but not 'example.com'.
UI5_MCP_SERVER_RESPONSE_NO_RESOURCESSet to any value to disable resources in the MCP server responses, see https://modelcontextprotocol.io/specification/2025-06-18/server/resource. This is useful for clients that do not support resources, see https://modelcontextprotocol.io/clients, such as Cursor or the Gemini CLI.
UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENTSet to any value to disable structured content in the MCP server responses.
| Name | Description | |
|---|---|---|
| UI5_DATA_DIR | Directory where the MCP server stores its data, such as cached API references. Defaults to the '.ui5' directory in the user's home directory. | |
| UI5_LOG_LVL | Internal log level (https://ui5.github.io/cli/stable/pages/Troubleshooting/#changing-the-log-level): 'silent', 'error', 'warn', 'info', 'perf', 'verbose' or 'silly' | |
| UI5_MCP_SERVER_ALLOWED_DOMAINS | A comma-separated list of domains that are allowed to be used in various tools, for example: 'localhost, example.com, sub.example.com'. Set to an empty string to allow any domains. For wildcard subdomains, prefix the domain with a dot: '.example.com'. This will match 'www.example.com' but not 'example.com'. | |
| UI5_MCP_SERVER_RESPONSE_NO_RESOURCES | Set to any value to disable resources in the MCP server responses, see https://modelcontextprotocol.io/specification/2025-06-18/server/resource. This is useful for clients that do not support resources, see https://modelcontextprotocol.io/clients, such as Cursor or the Gemini CLI. | |
| UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT | Set to any value to disable structured content in the MCP server responses. |
Automated checks
Ran Nov 12, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablePass
- Open source license (OSI)Pass
- Commit or release in the last yearPass
- Package name not close to a popular packagePass
- Remote endpoint uses HTTPSNot checked
- Destructive tools are labelledPass
- No hidden instructions to the modelPass
- No critical advisory in the package or its dependenciesPass
README
View on GitHubUI5 MCP Server
A Model Context Protocol server for UI5 application development.
Description
The UI5 Model Context Protocol server offers tools to improve the developer experience when working with agentic AI tools.
Key Features
- Helps with the creation of new UI5 projects when working with agentic AI tools
- Supports the developer to detect and fix UI5-specific errors in the code
- Provides additional UI5-specific information for agentic AI tools
[!TIP] Make sure to also check out our announcement blog post in the SAP Community!
Available Tools
create_integration_card: Scaffolds a new UI Integration Card.create_ui5_app: Scaffolds a new UI5 application based on a set of templates.get_api_reference: Fetches and formats UI5 API documentation.get_guidelines: Provides access to UI5 development best practices.get_integration_cards_guidelines: Provides access to UI Integration Cards development best practices.get_project_info: Extracts metadata and configuration from a UI5 project.get_typescript_conversion_guidelines: Provides guidelines for converting UI5 applications and controls from JavaScript to TypeScript.get_version_info: Retrieves version information for the UI5 framework.run_manifest_validation: Validates the manifest against the UI5 Manifest schema.run_ui5_linter: Integrates with@ui5/linterto analyze and report issues in the UI5 code.
Requirements
- Node.js Version v20.17.0, v22.9.0 or higher
- npm Version v8.0.0 or higher
- An MCP client, such as VS Code (GitHub Copilot), Cline, Claude Code, Codex, or any other MCP-compatible client
Setup
Standard Configuration for Most Clients
This configuration works for most MCP clients:
{
"mcpServers": {
"@ui5/mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@ui5/mcp-server"
]
}
}
}
{
"mcpServers": {
"@ui5/mcp-server": {
"type": "stdio",
"command": "cmd",
"args": [
"/c",
"npx -y @ui5/mcp-server"
]
}
}
}
Specific MCP Clients
Besides the general configuration outlined above, some MCP clients offer shortcuts for installing MCP servers. Below are instructions for some popular clients, but you can also refer to your specific client's documentation for more details.
VS Code
Preferred: Install from the GitHub MCP server registry
Alternatively you can use the VS Code CLI:
# Using VS Code CLI
code --add-mcp '{"name":"@ui5/mcp-server","type": "stdio","command":"npx","args":["-y", "@ui5/mcp-server"]}'
Cline
- Open the Cline panel in VSCode.
- Click on the "MCP Servers" icon at the top, next to the "plus" symbol
- Change to the "Configure" tab, then click "Configure MCP servers"
- In the editor that opens, insert the above Standard Configuration for Most Clients
See docs.cline.bot/mcp/adding-and-configuring-servers for details.
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
Adding Rules to your Project
The following rules guide large language models (LLMs) in using the UI5 MCP server correctly. Add these rules to your existing global or project-specific AGENTS.md file. The exact location may vary depending on the MCP client. For example, Claude Code uses a CLAUDE.md file instead of 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.
Configuration
The UI5 MCP server can be configured using the following environment variables. It does not accept any command-line arguments.
Configuration Options:
UI5_MCP_SERVER_ALLOWED_DOMAINS:- Default Value:
localhost, services.odata.org - Description: A comma-separated list of domains that are allowed to be used in various tools, for example:
localhost, example.com, sub.example.com. Set to an empty string to allow any domains. For wildcard subdomains, prefix the domain with a dot:.example.com. This will matchwww.example.combut notexample.com.
- Default Value:
UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT:- Description: Set to any value to disable structured content in the MCP server responses.
UI5_MCP_SERVER_RESPONSE_NO_RESOURCES:- Description: Set to any value to disable resources in the MCP server responses. This is useful for clients that do not support resources, such as Cursor or the Gemini CLI.
UI5_MCP_SERVER_CDN_URL:- Default Value:
https://sdk.openui5.orgfor OpenUI5 andhttps://ui5.sap.comfor SAPUI5 - Description: Override the base URL used for fetching UI5 resources from the CDN. For example:
https://example.com. When set, this URL is used for both OpenUI5 and SAPUI5 resources. The value must be a valid URL. Note that the project's version will appended to the URL automatically. This means that at runtime, the URL might look like this:https://example.com/1.120.0/resources/[...].
- Default Value:
UI5_LOG_LVL:- Default Value:
info - Description: Internal log level:
silent,error,warn,info,perf,verbose,silly
- Default Value:
UI5_DATA_DIR:- Default Value: The
.ui5directory in the user's home directory - Description: Directory where the MCP server stores its data, such as cached API references.
- Default Value: The
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
You can also chat with us in the #tooling channel of the OpenUI5 Community Slack. For public Q&A, use the ui5-tooling tag on Stack Overflow.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright 2026 SAP SE or an SAP affiliate company and UI5 MCP server contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
UI5 MCP questions
How do I add UI5 MCP to Claude Code?
Run claude mcp add mcp-server -- npx -y @ui5/mcp-server in your terminal. Add --scope user to make it available in every project.
How do I add UI5 MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What tools does UI5 MCP provide?
It exposes 10 tools, including create_integration_card, create_ui5_app, get_api_reference, get_guidelines, get_integration_cards_guidelines.
What tools does the UI5 MCP server provide?
It provides tools to scaffold UI5 apps and integration cards, fetch API references, get development guidelines, extract project info, validate manifests, and run the UI5 linter.
What are the requirements for running the UI5 MCP server?
You need Node.js v20.17.0, v22.9.0 or higher, npm v8.0.0 or higher, and an MCP-compatible client.
How do I install the UI5 MCP server?
Run it via npx as a stdio server in your MCP client configuration.
Does the UI5 MCP server require authentication?
No; setup uses a stdio command with npx and no credentials are mentioned.
Can I restrict which domains the UI5 MCP server accesses?
Yes, set the UI5_MCP_SERVER_ALLOWED_DOMAINS environment variable to a comma-separated list of allowed domains.