# UI5 MCP server

> Scaffolds UI5 apps and integration cards, fetches API docs, validates manifests, and runs the UI5 linter for agentic AI clients.

- Repository: https://github.com/UI5/mcp-server
- Page: https://hostedmcp.org/servers/ui5/mcp-server
- Official: yes
- Transport: stdio
- Stars: 108
- License: Apache-2.0
- Latest version: 0.3.3

## Install

### Claude Code

```sh
claude mcp add mcp-server -- npx -y @ui5/mcp-server
```

### Cursor (`~/.cursor/mcp.json`)

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

### VS Code (`.vscode/mcp.json`)

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

### VS Code CLI

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

### Claude Desktop (`claude_desktop_config.json`)

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

### Codex

```sh
codex mcp add mcp-server -- npx -y @ui5/mcp-server
```

### Codex config.toml (`~/.codex/config.toml`)

```toml
[mcp_servers.mcp-server]
command = "npx"
args = ["-y", "@ui5/mcp-server"]
```

### Gemini CLI

```sh
gemini mcp add -s user mcp-server npx -- -y @ui5/mcp-server
```

### Gemini settings.json (`~/.gemini/settings.json`)

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

## Environment variables

| Name | Required | Secret | Description |
|---|---|---|---|
| `UI5_DATA_DIR` | no | no | Directory where the MCP server stores its data, such as cached API references. Defaults to the '.ui5' directory in the user's home directory. |
| `UI5_LOG_LVL` | no | no | Internal log level (https://ui5.github.io/cli/stable/pages/Troubleshooting/#changing-the-log-level): 'silent', 'error', 'warn', 'info', 'perf', 'verbose' or 'silly' |
| `UI5_MCP_SERVER_ALLOWED_DOMAINS` | no | no | A comma-separated list of domains that are allowed to be used in various tools, 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_RESOURCES` | no | no | Set to any value to disable resources in the MCP server responses, see https://modelcontextprotocol.io/specification/2025-06-18/server/resource. This is useful for clients that do not support resources, see https://modelcontextprotocol.io/clients, such as Cursor or the Gemini CLI. |
| `UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT` | no | no | Set to any value to disable structured content in the MCP server responses. |

## Tools (10)

- `create_integration_card`
- `create_ui5_app`
- `get_api_reference`
- `get_guidelines`
- `get_integration_cards_guidelines`
- `get_project_info`
- `get_typescript_conversion_guidelines`
- `get_version_info`
- `run_manifest_validation`
- `run_ui5_linter`

## FAQ

### What tools does the UI5 MCP server provide?

It provides tools to scaffold UI5 apps and integration cards, fetch API references, get development guidelines, extract project info, validate manifests, and run the UI5 linter.

### What are the requirements for running the UI5 MCP server?

You need Node.js v20.17.0, v22.9.0 or higher, npm v8.0.0 or higher, and an MCP-compatible client.

### How do I install the UI5 MCP server?

Run it via npx as a stdio server in your MCP client configuration.

### Does the UI5 MCP server require authentication?

No; setup uses a stdio command with npx and no credentials are mentioned.

### Can I restrict which domains the UI5 MCP server accesses?

Yes, set the UI5_MCP_SERVER_ALLOWED_DOMAINS environment variable to a comma-separated list of allowed domains.
