UI5 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/linter to 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"
]
}
}
}
Special configuration for native Windows
On native Windows (not WSL), you might need to prefix npx with `cmd /c`:
{
"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 match www.example.com but not example.com.
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:
UI5_MCP_SERVER_CDN_URL:
- Default Value:
https://sdk.openui5.org for OpenUI5 and https://ui5.sap.com for 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/[...].
UI5_LOG_LVL:
- Default Value:
info
- Description: Internal log level:
silent, error, warn, info, perf, verbose, silly
UI5_DATA_DIR:
- Default Value: The
.ui5 directory in the user's home directory
- Description: Directory where the MCP server stores its data, such as cached API references.
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.
