UI5

The UI5 MCP Server provides a Model Context Protocol backend to assist UI5 development tools and agentic AI workflows. It offers commands to scaffold UI5 projects, fetch API references, validate manifests, lint code, and more, helping you work efficiently with UI5 projects and AI-assisted tooling.

How to use

You connect an MCP client to the UI5 MCP Server to access its tools and workflows. Start the server as a local, stdio MCP service, then configure your MCP client to communicate with it. Use the included tools to scaffold projects, fetch API references, validate manifests, lint code, and obtain guidance for converting UI5 code to TypeScript or integrating UI5 components.

How to install

Prerequisites you need before installation:

• Node.js version 20.17.0, 22.9.0, or higher

• npm version 8.0.0 or higher

• An MCP client such as VS Code, Cline, or any MCP-compatible client

Configuration and running the MCP server

The server is configured as a stdio MCP service. Use the following configuration to run it via npx. This example uses the default behavior shown for most clients.

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

Environment configuration and options

You can customize the MCP server behavior using environment variables. The following options are shown in examples to illustrate typical usage.

{
	"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"
			}
		}
	}
}

Notes for specific MCP clients

Configure your MCP client to load the UI5 MCP server using the above stdio configuration. For VS Code, you can add the MCP server as shown in the example. For other clients, use the same command and arguments to start the server.

If you need to override defaults, you can set additional environment variables such as UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT, UI5_MCP_SERVER_RESPONSE_NO_RESOURCES, UI5_LOG_LVL, and UI5_DATA_DIR as shown in the configuration example.

Security, support, and contribution

If you discover a security issue, follow the security policy for reporting. You can request features or report bugs via the project’s issue tracker. Community channels are available for open Q&A and collaboration.

Available tools

create_ui5_app

Scaffolds a new UI5 application based on templates to accelerate project setup.

get_api_reference

Fetches and formats UI5 API documentation for quick reference.

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

Runs the UI5 linter to analyze code and report issues.

get_typescript_conversion_guidelines

Offers guidelines for converting UI5 apps and controls to TypeScript.

get_integration_cards_guidelines

Provides guidelines for UI Integration Cards development.

create_integration_card

Scaffolds a new UI Integration Card.

run_manifest_validation

Validates the manifest against the UI5 Manifest schema.