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

<details> <summary><i>Special configuration for native Windows</i></summary> 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"
            ]
        }
    }
}

</details>

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

1. Open the Cline panel in VSCod