@ui5/mcp-server
SAP's MCP server for UI5 development: ten tools that scaffold an app or a card, read the project in front of the agent, and run the linter and the manifest validator against it.
An agent writing UI5 knows the framework from training data and nothing about the application in the editor — which version it targets, how its manifest is shaped, whether what it just wrote passes the linter. This puts ten tools in front of it: create_ui5_app and create_integration_card scaffold from the templates, get_project_info reads the project's own metadata, get_version_info answers which framework version is in play, get_api_reference fetches and formats the API documentation, get_guidelines, get_integration_cards_guidelines and get_typescript_conversion_guidelines carry the practices, and run_ui5_linter and run_manifest_validation check the result against @ui5/linter and the manifest schema. Runs over stdio as npx -y @ui5/mcp-server, so nothing is installed into the project.
Facts
Where it sits
Who is behind it
In the atlas: maintains 8@UI5maintainerOliwerContributes to this
In the atlas: contributes to 2@1110101Andreas KunzContributes to this
In the atlas: contributes to 19@akudevYavor IvanovContributes to this
In the atlas: contributes to 17@d3xter666Petar DimovContributes to this
In the atlas: contributes to 5@dimovpetarFlorian VogtContributes to this
In the atlas: contributes to 50, wrote 2@flovogtMatthias OßwaldContributes to this
In the atlas: contributes to 29@matz3Max ReichmannContributes to this
In the atlas: contributes to 10@maxreichmannOpenUI5 BotContributes to this
In the atlas: contributes to 5@openui5botMerlin BeutlbergerContributes to this
In the atlas: contributes to 18, wrote 1@RandomByteSiyana TodorovaContributes to this
In the atlas: contributes to 4@s-todorova13 contributors
Before choosing this
Conditions
PracticalFunctional boundary
It reads a UI5 project and the framework's own documentation, not a running system or a backend: a question about the service behind the app is answered somewhere else. Node.js v20.17 or v22.9 and above.
What it declares
Every artifact
- Type
- MCP server
- Origin
- By SAP
- Runtime
- Node.js
Connections
Letting a coding agent read and act on your project or system
Writing UI5 apps and libraries in TypeScript
Forty SAP development plugins for coding agents
Twenty-two agent skills shipped with arc-1
Download
Install
npm add @ui5/mcp-serverDerived from the package name. No recipe recorded; the README has the configuration.
Learn more
- AI-assisted SAP development with MCPAI-assisted SAP development with MCPA Devtoberfest 2026 session (UI-41) that traces AI-assisted SAP development from pasting code into a chat window to coding agents with built-in connectors, and sorts the MCP servers around SAP development into SAP's own, the community's and the hosted ones, where the agent cannot change what the server allows. Four demos follow: GitHub Copilot alone explaining an ABAP report from a Git repository, @ui5/mcp-server reading an OpenUI5 sample app and converting it to TypeScript, mcp-sap-docs grounding Terraform files for a BTP subaccount the presenter had not written before, and arc-1 with Copilot in Eclipse tracing why a title longer than 40 characters is rejected and proposing the DDIC-allowed length instead. It ends on a skill that migrates an SAP Gateway project on an ECC system to RAP on S/4HANA step by step, and on a rule Marian Zeis gives for servers written for internal use: keep them read-only, because what the agent is short of is context.published 2026-10-16Marian Zeis, YouTube — SAP Developers playlists
- Beyond copilots: Agentic development with SAPUI5Beyond copilots: Agentic development with SAPUI5Devtoberfest 2026 session UI-12, from the SAPUI5 team, on the year of work behind UI5/plugins-coding-agents: what a model produces for UI5 without help — outdated concepts, framework versions a decade old, generic JavaScript rules, code that does not run — and the two ways they chose to close that gap, an MCP server in September 2025 and skills packaged as plugins once agents began reading them. Three plugins are demonstrated live in Claude Code: the everyday one scaffolds an Oktoberfest tents application in about four minutes, the TypeScript conversion plugin rewrites an existing JavaScript project and reconfigures its build with the types and the transpile task, and the modernisation plugin takes a ten-year-old application through staged migrations, applying UI5 Linter's automatic fixes where they cannot break the app and the model where they can, then running the tests. @ui5/mcp-server is still the path for the parts that need a server, and the plugins are installed from the Claude Code and GitHub Copilot marketplaces rather than a UI5-hosted one.SAP Developers, published 2026-09-25SAP Developers, YouTube — SAP Developers playlists
- Before You Upgrade S/4HANA: Static UI5 Checks with MCPBefore You Upgrade S/4HANA: Static UI5 Checks with MCPA UI5 version upgrade checked against one app by pairing two MCP servers: the ui5_version_diff tool added to mcp-sap-docs, which reads a bundle from ui5-lib-diff downloaded once at setup and filters it by version range, change type, library or query text, and @ui5/mcp-server, whose get_project_info, get_version_info, run_ui5_linter and run_manifest_validation say what the app uses and what fails. Run with a ui5-versions-upgrade.md skill on the legacy app from From SEGW and Legacy UI5 to RAP with ARC-1, from SAPUI5 1.84.59 to 1.147.2, the diff range held 985 deprecations and 961 What's New entries, and the linting and manifest validation narrowed that to findings in this app, among them jQuery.sap.require, synchronous bootstrap, the sap_belize theme, sap.m.MessagePage and an old manifest _version. The checks read the source in a local checkout and never the deployed app, so the report is a first pass: a changelog entry is not proof that a workaround can be deleted, and the app still has to be run and tested.published 2026-05-20Marian Zeis, blog.zeis.de — Marian Zeis
3 more
- From SEGW and Legacy UI5 to RAP with ARC-1From SEGW and Legacy UI5 to RAP with ARC-1Three ARC-1 skills, run in Cursor with Composer-2 against a deliberately rough demo on an S/4HANA 2023 trial system, turn the SEGW service ZDEMO_MIG_PROJECTS_SRV into a managed, draft-enabled RAP business object published as OData V4, replace its ApproveProject function import and its direct UPDATE ... COMMIT WORK with the action approve_project written in EML in local mode, and rebuild the freestyle UI5 JavaScript app once in UI5 TypeScript and once as a Fiori elements list report and object page driven by metadata extensions. What the published transcripts add is how the agent got there: it found the generated MPC class names and the custom logic in DPC_EXT only by reading the system, the skills made it print the extracted model and stop for confirmation before writing, and @ui5/mcp-server, mcp-sap-docs and @sap-ux/fiori-mcp-server each had their own job beside it. The demo is small on purpose, and the post says a productive SEGW service that calls BAPIs, carries custom authorisation logic or supports deep inserts is not solved with one prompt.published 2026-05-11Marian Zeis, blog.zeis.de — Marian Zeis
- UI5 MCP Server Got Extended for UI Integration Cards GenerationUI5 MCP Server Got Extended for UI Integration Cards GenerationVersion 0.2.1 of the UI5 MCP Server adds three tools for UI Integration Cards: get_integration_cards_guidelines feeds an agent current best practices and API versions, create_integration_card scaffolds a new card project, and run_manifest_validation checks the generated manifest against the schema. The post frames these as closing the same gaps as the server's existing tools — an LLM's outdated or wrong card API knowledge — this time for scaffolding and validating a card rather than a full app.daniel_vladinov, published 2026-01-22daniel_vladinov, SAP Community
- Give Your AI Agent Some Tools: Introducing the UI5 MCP ServerGive Your AI Agent Some Tools: Introducing the UI5 MCP ServerAnnounces @ui5/mcp-server, SAP's open-source MCP server for UI5 development, and walks through its initial six tools. get_project_info, get_api_reference and run_ui5_linter (which applies UI5 linter fixes) read the project's own version, manifest and code rather than an LLM's training data, which is what agent access to your code explains. create_ui5_app scaffolds a new JavaScript or TypeScript project, standalone or inside an existing CAP application, from templates with pre-configured OData model setups, which is generators.published 2025-09-03Merlin Beutlberger, SAP Community
README
quoted from UI5/mcp-server under Apache-2.0, readUI5 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/linterto 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"
]
}
}
}
Special configuration for native Windows
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"
]
}
}
}
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
- Open the Cline panel in VSCode.
- Click on the "MCP Servers" icon at the top, next to the "plus" symbol
- Change to the "Configure" tab, then click "Configure MCP servers"
- In the editor that opens, insert the above Standard Configuration for Most Clients
See docs.cline.bot/mcp/adding-and-configuring-servers for details.
Claude Code
claude mcp add --transport stdio --scope user ui5-mcp-server -- npx -y @ui5/mcp-server
Codex
codex mcp add --transport stdio ui5-mcp-server -- npx -y @ui5/mcp-server
Adding Rules to your Project
The following rules guide large language models (LLMs) in using the UI5 MCP server correctly. Add these rules to your existing global or project-specific AGENTS.md file. The exact location may vary depending on the MCP client. For example, Claude Code uses a CLAUDE.md file instead of AGENTS.md.
## 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.
Configuration
The UI5 MCP server can be configured using the following environment variables. It does not accept any command-line arguments.
Configuration Options:
UI5_MCP_SERVER_ALLOWED_DOMAINS:- Default Value:
localhost, services.odata.org - Description: 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 matchwww.example.combut notexample.com.
- Default Value:
UI5_MCP_SERVER_RESPONSE_NO_STRUCTURED_CONTENT:- Description: Set to any value to disable structured content in the MCP server responses.
UI5_MCP_SERVER_RESPONSE_NO_RESOURCES:- Description: Set to any value to disable resources in the MCP server responses. This is useful for clients that do not support resources, such as Cursor or the Gemini CLI.
UI5_MCP_SERVER_CDN_URL:- Default Value:
https://sdk.openui5.orgfor OpenUI5 andhttps://ui5.sap.comfor SAPUI5 - Description: Override the base URL used for fetching UI5 resources from the CDN. For example:
https://example.com. When set, this URL is used for both OpenUI5 and SAPUI5 resources. The value must be a valid URL. Note that the project's version will appended to the URL automatically. This means that at runtime, the URL might look like this:https://example.com/1.120.0/resources/[...].
- Default Value:
UI5_LOG_LVL:- Default Value:
info - Description: Internal log level:
silent,error,warn,info,perf,verbose,silly
- Default Value:
UI5_DATA_DIR:- Default Value: The
.ui5directory in the user's home directory - Description: Directory where the MCP server stores its data, such as cached API references.
- Default Value: The
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub 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. For public Q&A, use the ui5-tooling tag on Stack Overflow.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our 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 at all times.
Licensing
Copyright 2026 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.
History
Fixes 1, Dependencies 3
Notes
Breaking 1, Features 1, Dependencies 1
Dependencies 6
Notes
Dependencies 6
Notes
Dependencies
Features 1, Fixes 1, Dependencies 2
Features 1, Dependencies 3
Features 1, Fixes 1, Dependencies 7
Notes
Features
Bug Fixes
- Add UI5 icon (c6c7980)
Dependencies
- Bump @modelcontextprotocol/sdk from 1.26.0 to 1.27.0 (8388270)
- Bump @modelcontextprotocol/sdk from 1.27.0 to 1.27.1 (cc1fc8a)
- Bump @ui5/project from 4.0.10 to 4.0.11 (32ae81d)
- Bump fast-xml-parser from 5.3.6 to 5.3.7 (4ac6a44)
- Bump fast-xml-parser from 5.3.7 to 5.4.1 (c8d1bd3)
- Bump globby from 16.1.0 to 16.1.1 (e6eb79e)
- Bump make-fetch-happen from 15.0.3 to 15.0.4 (962b6f7)
Features 2, Dependencies 2
Dependencies 8
Notes
Dependencies
- Bump @modelcontextprotocol/sdk from 1.25.3 to 1.26.0 (7d3a5f3)
- Bump @ui5/linter from 1.20.8 to 1.20.9 (d20989d)
- Bump @ui5/linter from 1.20.9 to 1.20.10 (6a6538c)
- Bump ejs from 3.1.10 to 4.0.1 (4731854)
- Bump fast-xml-parser from 5.3.3 to 5.3.4 (949fb9b)
- Bump semver from 7.7.3 to 7.7.4 (ac4ed6c)
- Bump tar from 7.5.6 to 7.5.7 (298740b)
- Bump zod from 4.3.5 to 4.3.6 (ef1d703)
Features 1, Dependencies 11
Notes
Features
Dependencies
- Bump @modelcontextprotocol/sdk from 1.24.3 to 1.25.0 (10250cf)
- Bump @modelcontextprotocol/sdk from 1.25.0 to 1.25.1 (d7f8fea)
- Bump @ui5/linter from 1.20.5 to 1.20.6 (24de07d)
- Bump @ui5/linter from 1.20.6 to 1.20.7 (ed52e26)
- Bump fast-xml-parser from 5.3.2 to 5.3.3 (709b96b)
- Bump globby from 16.0.0 to 16.1.0 (af274e0)
- Bump qs from 6.14.0 to 6.14.1 (cb2871f)
- Bump zod from 4.1.13 to 4.2.0 (5888a2b)
- Bump zod from 4.2.0 to 4.2.1 (d2e746a)
- Bump zod from 4.2.1 to 4.3.2 (d34c2ef)
- Bump zod from 4.3.2 to 4.3.4 (2e61f66)
Breaking 1, Features 1, Dependencies 3
Notes
⚠ BREAKING CHANGES
- Update node engines version range: ^20.17.0 || >=22.9.0 (#156)
Features
Dependencies
Fixes 1, Dependencies 5
Notes
Bug Fixes
Dependencies
Features 4, Dependencies 11
Notes
Features
- Add rule for creating a Form (c4146e1)
- Add tool for creating Integration Cards (#84) (a456ef2)
- Add UI Integration Cards guidelines tool (#69) (731dbdd)
- docs: Add documentation resources for Test Starter (3a9dd3b)
Dependencies
- Bump @modelcontextprotocol/sdk from 1.20.0 to 1.20.1 (58eeb24)
- Bump @modelcontextprotocol/sdk from 1.20.1 to 1.20.2 (4359a2a)
- Bump @ui5/linter from 1.20.2 to 1.20.3 (44439bc)
- Bump @ui5/linter from 1.20.3 to 1.20.5 (3501b17)
- Bump @ui5/project from 4.0.6 to 4.0.7 (f636716)
- Bump @ui5/project from 4.0.7 to 4.0.8 (4748204)
- Bump fast-xml-parser from 5.3.0 to 5.3.1 (f5035db)
- Bump fast-xml-parser from 5.3.1 to 5.3.2 (cad8306)
- Bump glob to 10.5.0 / 11.1.1 (2a36fe0)
- Bump globby from 14.1.0 to 16.0.0 (c696424)
- Bump js-yaml to 4.1.1 (5e37c51)
Features 2, Dependencies 6
Notes
Features
- templates: Use manifest.json v2 (#75) (8b201ec)
- ui5_create_app: Always set "earlyRequests": true in UI5 >=1.141 (#52) (8b010ee)
Dependencies
- Bump @modelcontextprotocol/sdk from 1.18.1 to 1.18.2 (d0dd2de)
- Bump @modelcontextprotocol/sdk from 1.18.2 to 1.19.1 (da1f821)
- Bump @modelcontextprotocol/sdk from 1.19.1 to 1.20.0 (ab8def0)
- Bump @ui5/linter from 1.20.1 to 1.20.2 (a4f5c16)
- Bump fast-xml-parser from 5.2.5 to 5.3.0 (c17e08c)
- Bump semver from 7.7.2 to 7.7.3 (39692d2)
Features 1, Fixes 1, Dependencies 7
Notes
Features
Bug Fixes
Dependencies
- Bump @modelcontextprotocol/sdk from 1.17.5 to 1.18.0 (d0bf5a3)
- Bump @modelcontextprotocol/sdk from 1.18.0 to 1.18.1 (6164c52)
- Bump @ui5/linter from 1.19.0 to 1.20.0 (#30) (155f3cf)
- Bump @ui5/linter from 1.20.0 to 1.20.1 (e2bc8b0)
- Bump @ui5/logger from 4.0.1 to 4.0.2 (84a66d8)
- Bump @ui5/project from 4.0.4 to 4.0.5 (1a49b8c)
- Bump @ui5/project from 4.0.5 to 4.0.6 (d304cdb)
Others providing
- capforgecapforgeAn MCP server that scaffolds CAP and CDS for a coding agent and then holds it to cds compile — the agent does not stop until the generated code builds clean.independent, capMCP server scaffolding CAP and CDS checked by cds compile
- @cap-js/mcp-server@cap-js/mcp-serverSAP's MCP server for CAP development, run as cds-mcp: search_model searches the project's compiled CDS model, search_docs searches the CAP documentation indexed as embeddings on the developer's own machine.sap official, capMCP server for CAP development: model and docs search
- @sap-ux/fiori-mcp-server@sap-ux/fiori-mcp-serverSAP's Fiori MCP server, run as fiori-mcp, letting a coding assistant create and edit Fiori applications directly rather than describing the steps.sap official, ui5MCP server for creating and editing Fiori applications
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Flavors
“A [Model Context Protocol](https://modelcontextprotocol.io/) server for UI5 application development.” — UI5/mcp-server — README
“A [Model Context Protocol](https://modelcontextprotocol.io/) server for UI5 application development.” — UI5/mcp-server — README
Contributors
History in the atlas
- Entered from the sap-ai-mcp-servers catalogue, which is credited as the source; the description is written from the project's own README and documentation rather than from the catalogue's line about it.
- First seen.
For your agent
- Ref
artifact:ui5-mcp-server- JSON
- /artifacts/ui5-mcp-server.json
- MCP
- Connecting an agent