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_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_project_info: Extracts metadata and configuration from a UI5 project.
- get_version_info: Retrieves version information for the UI5 framework.
- run_ui5_linter: Integrates with @ui5/linter to analyze and report issues in UI5 code.
- get_typescript_conversion_guidelines: Provides guidelines for converting UI5 applications and controls from JavaScript to TypeScript.
- get_integration_cards_guidelines: Provides access to UI Integration Cards development best practices.
- create_integration_card: Scaffolds a new UI Integration Card.
- run_manifest_validation: Validates the manifest against the UI5 Manifest schema.

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, Cline, or any other MCP-compatible client

Setup

$3

This configuration works for most MCP clients:

``json
{
"mcpServers": {
"@ui5/mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"@ui5/mcp-server"
]
}
}
}
`

$3

The UI5 MCP server can be configured using the following environment variables. It does not accept any command-line arguments.

Custom Configuration Example:

`json
{
"mcpServers": {
"@ui5/mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"@ui5/mcp-server"
],
"env": {
"UI5_MCP_SERVER_ALLOWED_ODATA_DOMAINS": "localhost, services.odata.org",
"UI5_LOG_LVL": "verbose",
"UI5_DATA_DIR": "/change-me/to/some/other/path",
}
}
}
}
`

Configuration Options:

* UI5_MCP_SERVER_ALLOWED_ODATA_DOMAINS:
* Default Value: localhost, services.odata.org
* Description: A comma-separated list of domains that are allowed to be used in the oDataV4Url parameter of the create_ui5_app tool, 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:
* 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_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




$3

#### VS Code

Follow the MCP installation guide using the above configuration.

Or use the VS Code CLI:

`bash


Using VS Code CLI


code --add-mcp '{"name":"@ui5/mcp-server","type": "stdio","command":"npx","args":["@ui5/mcp-server"]}'
`

#### Cline

1. Open the Cline panel in VSCode.
2. Below the prompt/task input field, click on the "Manage MCP servers" icon and select the gear button in the popup.
3. Click "Configure MCP servers" and add the above configuration.

Rules

The following rules help guide the LLM to use the server correctly:

`markdown


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.
`

Add these rules to your existing global or project-specific AGENTS.md (specifics may vary based on respective MCP client).

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 2025 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.