MCP Server

🚀 UI5 MCP Server

A Model Context Protocol server for UI5 application development, enhancing the developer experience when collaborating with agentic AI tools.

🚀 Quick Start

The UI5 Model Context Protocol server offers a suite of tools to streamline UI5 application development when working with agentic AI tools. It simplifies project creation, aids in error detection and correction, and provides AI tools with UI5 - specific information.

✨ Features

• Project Creation: Facilitates the creation of new UI5 projects when collaborating with agentic AI tools.
• Error Handling: Assists developers in detecting and fixing UI5 - specific errors in the code.
• AI Support: Supplies additional UI5 - specific information for agentic AI tools.

💡 Usage Tip

Make sure to also check out our announcement blog post in the SAP Community!

📦 Installation

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

Standard Configuration for Most Clients

This configuration is suitable for most MCP clients:

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

Configuration

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

Custom Configuration Example:

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

Specific MCP Clients

VS Code

Follow the MCP installation [guide](https://code.visualstudio.com/docs/copilot/chat/mcp - servers#_add - an - mcp - server) using the above configuration.

Or use the VS Code CLI:

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

💻 Usage Examples

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.

📚 Documentation

Rules

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

## 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).

📄 License

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](https://api.reuse.software/info/github.com/UI5/mcp - server).

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/UI5/mcp - server/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](https://ui5 - slack - invite.cfapps.eu10.hana.ondemand.com/). For public Q&A, use the [ui5 - tooling tag on Stack Overflow](https://stackoverflow.com/questions/tagged/ui5 - tooling).

Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/UI5/mcp - server/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](https://github.com/UI5/mcp - server?tab=coc - ov - file#readme) at all times.