SAPUI5 MCP Server
UI5 MCP server that helps AI coding agents scaffold, validate, and document SAPUI5 and OpenUI5 applications.
The UI5 MCP Server is an open-source Model Context Protocol server maintained by the UI5 organization (the team behind SAPUI5 and OpenUI5). It exposes UI5-aware tools to AI coding assistants so they can scaffold new UI5 applications, generate UI Integration Cards, look up API references, validate manifest files, and lint code using the official @ui5/linter. The goal is to give agents accurate, framework-specific context instead of relying on generalized model knowledge.
The server runs locally over stdio via npx @ui5/mcp-server and works with VS Code (GitHub Copilot), Cline, Claude Code, Codex, and other MCP-compatible clients. It bundles project introspection helpers (get_project_info, get_version_info), guideline retrieval (get_guidelines, get_typescript_conversion_guidelines, get_integration_cards_guidelines), and quality tooling (run_manifest_validation, run_ui5_linter).
Licensed Apache-2.0 and published as the @ui5/mcp-server npm package, it is the canonical MCP integration for SAP Fiori and SAPUI5 developer workflows. No API keys or authentication are required, since it operates locally against your UI5 project and the public UI5 CDN.
Tools
| Tool | Description |
|---|---|
create_ui5_app |
Scaffolds a new UI5 application from official templates. |
create_integration_card |
Scaffolds a new UI Integration Card project. |
get_api_reference |
Returns formatted UI5 API documentation for a given control or namespace. |
get_guidelines |
Delivers UI5 development best practices and guidelines. |
get_integration_cards_guidelines |
Returns UI Integration Cards development standards. |
get_project_info |
Extracts metadata and configuration from a UI5 project on disk. |
get_typescript_conversion_guidelines |
Provides guidance for migrating UI5 projects from JavaScript to TypeScript. |
get_version_info |
Retrieves UI5 framework version information. |
run_manifest_validation |
Validates a UI5 manifest.json file against its schema. |
run_ui5_linter |
Runs @ui5/linter against project sources to surface UI5-specific issues. |
Prerequisites
- Node.js v20.17.0, v22.9.0, or higher
- npm v8.0.0+
- An MCP-compatible client (VS Code with Copilot, Cline, Claude Code, Codex, etc.)
Install and run
The server is published to npm and runs over stdio. No global install is needed; npx will fetch it on demand:
npx -y @ui5/mcp-server
MCP client configuration
Add the following to your MCP client config (for example claude_desktop_config.json or .vscode/mcp.json):
{
"mcpServers": {
"@ui5/mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@ui5/mcp-server"]
}
}
}
Optional environment variables
UI5_MCP_SERVER_ALLOWED_DOMAINS: comma-separated allow list for outbound HTTP (defaults includelocalhostandservices.odata.org)UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT: disable structured tool responsesUI5_MCP_SERVER_RESPONSE_NO_RESOURCES: disable MCP resourcesUI5_MCP_SERVER_CDN_URL: override the UI5 CDN base URLUI5_LOG_LVL: log verbosityUI5_DATA_DIR: cache directory location
No API keys or authentication are required.
- Scaffold a new SAPUI5 or OpenUI5 application from an approved template directly through an AI assistant, without leaving the editor.
- Generate a UI Integration Card project and have the agent fill in the manifest based on UI5 guidelines.
- Lint an existing UI5 codebase with
@ui5/linterand let the agent auto-fix flagged issues using framework-aware suggestions. - Validate
manifest.jsonagainst the UI5 schema during refactors or version upgrades. - Migrate a JavaScript UI5 project to TypeScript using the bundled conversion guidelines and API reference lookups.
- "Create a new SAPUI5 freestyle app called
sales-dashboardin this folder." - "Run the UI5 linter on the
webapp/directory and fix the reported issues." - "Validate the
manifest.jsonin this project and explain any schema errors." - "Show me the API reference for
sap.m.Tableand suggest how to add a search field." - "Walk me through converting this UI5 app from JavaScript to TypeScript using the official guidelines."
- Maintained by the UI5 organization, the same group that ships SAPUI5 and OpenUI5, so guidance matches the framework's official direction.
- Comprehensive tool surface covering scaffolding, linting, manifest validation, and API documentation in a single server.
- Zero authentication and pure stdio transport make local setup trivial via
npx. - Apache-2.0 licensed and published as the
@ui5/mcp-servernpm package with active releases.
- Focused on UI5 client-side development; it does not cover SAP CAP, ABAP, or BTP service management.
- Requires a fairly recent Node.js runtime (v20.17.0 or v22.9.0+), which may force upgrades in older SAP shops.
- Tools operate on local projects only; there is no built-in deployment or BTP integration.
- UI5 Web Components MCP Server for the UI5 Web Components framework rather than SAPUI5/OpenUI5.
- mcp-sap-docs for unified BM25 search across SAPUI5, CAP, OpenUI5, and wdi5 documentation.
- SAP-samples/ui5con-2026-fiori-mcp-server for SAP Fiori elements focused workflows.