mcp

The UI5 MCP Server exposes a set of tools to assist UI5 development and AI-assisted code generation. It provides commands to scaffold UI5 projects and integration cards, fetch UI5 API references, generate guidelines, and validate manifests. Tools like create_ui5_app, create_integration_card, get_api_reference, run_manifest_validation, and run_ui5_linter can be invoked via an MCP client that supports stdio transport. The server integrates with the UI5 tooling ecosystem to help agents understand UI5 projects, catch common UI5 mistakes, and provide context-aware suggestions to AI copilots. To get started, run the MCP server using the standard npx configuration, then connect your MCP client to access the listed tools and their capabilities. The tools are designed to streamline UI5 project setup, code analysis, and adherence to UI5 best practices within AI-assisted workflows.

Prerequisites:

• Node.js (version v20.17.0, v22.9.0 or higher) installed on your system
• npm (version v8.0.0 or higher)

Installation steps:

1. Ensure Node.js and npm are available in your shell: node -v npm -v

2. Install or access the MCP server via npx (no global install required): npx -y @ui5/mcp-server

3. Alternatively, install the package globally if you prefer: npm install -g @ui5/mcp-server Then you can run the server with: mcp-server

4. If you use a container or a custom runtime, configure the mcp_config accordingly (see the JSON example in this document). Ensure environment variables listed in the Configuration section are set if you need to override defaults.

Note: The standard configuration shown in the README uses the npx approach by default, which is compatible with most MCP clients that support stdio transport.

Tips and common considerations:

• The default environment allows localhost and services.odata.org; adjust UI5_MCP_SERVER_ALLOWED_DOMAINS to fit your network topology.
• UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT and UI5_MCP_SERVER_RESPONSE_NO_RESOURCES can help with clients that have limited support for resources or structured content.
• UI5_LOG_LVL controls the verbosity of logs emitted by the MCP server. Set to a lower level (e.g., error) in CI environments to reduce noise.
• UI5_DATA_DIR stores cached references and data; ensure the process has write access to this directory.
• If you are on native Windows, you may need to prefix the command with cmd /c when using npx, as shown in the Windows-specific example in the README.
• The tools offered include scaffolding UI5 apps and integration cards, retrieving API references, guidelines, and manifest/linters integration, which can greatly speed up AI-assisted UI5 development.