Provides AI assistants with API documentation, integration guides, and component details for UI5 Web Components development.
Also known as UI5/webcomponents-mcp-server, @ui5/webcomponents-mcp-server
- Stars
- 20
- Tools
- —
- Downloads, 30 days
- —
- Latest version
- 0.1.2
- Last commit
- Aug 31, 2026
- License
- Apache-2.0
What is UI5 Web Components MCP?
UI5 Web Components provides AI assistants with API documentation, integration guides, and component details for UI5 Web Components development.
Summary generated from the project's README
About UI5 Web Components MCP server
Developers building user interfaces with UI5 Web Components can use this server to provide their AI assistants with direct access to technical documentation and integration details. By connecting this server to an MCP client like Claude Code, VS Code, or Codex, you enable your assistant to retrieve specific component properties, slots, events, and methods. The server runs locally via Node.js using npx, making it easy to integrate into existing development workflows.
The toolset includes specialized functions such as get_component_api to search through the @ui5/webcomponents, @ui5/webcomponents-fiori, and @ui5/webcomponents-ai packages. It also provides get_guidelines for learning how to use these components within React, Angular, or native JavaScript environments. Users can also utilize list_docs and get_doc to browse and read full documentation files directly through their AI interface.
What you can do with it
- 1Retrieve component API detailsAsk your AI assistant to find the specific properties, slots, or methods for a UI5 component like a button.
- 2Learn framework integrationRequest step-by-step instructions on how to implement UI5 Web Components within a React or Angular project.
- 3Browse available documentationHave your AI assistant list all the available documentation topics and summaries for the UI5 ecosystem.
- 4Access theming informationAsk the assistant to provide specific details regarding how to handle theming for your web components.
Written from the project's README. Every use case is checked against a quote from it.
How to install UI5 Web Components MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall UI5 Web Components MCP in Claude Code
$ claude mcp add webcomponents-mcp-server -- npx -y @ui5/webcomponents-mcp-serverInstall UI5 Web Components MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"webcomponents-mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/webcomponents-mcp-server"
]
}
}
}Install UI5 Web Components MCP in VS Code
.vscode/mcp.json
{
"servers": {
"webcomponents-mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"@ui5/webcomponents-mcp-server"
]
}
}
}Install UI5 Web Components MCP in VS Code CLI
$ code --add-mcp '{"name":"webcomponents-mcp-server","type":"stdio","command":"npx","args":["-y","@ui5/webcomponents-mcp-server"]}'Install UI5 Web Components MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"webcomponents-mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/webcomponents-mcp-server"
]
}
}
}Install UI5 Web Components MCP in Codex
$ codex mcp add webcomponents-mcp-server -- npx -y @ui5/webcomponents-mcp-serverInstall UI5 Web Components MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.webcomponents-mcp-server] command = "npx" args = ["-y", "@ui5/webcomponents-mcp-server"]
Install UI5 Web Components MCP in Gemini CLI
$ gemini mcp add -s user webcomponents-mcp-server npx -- -y @ui5/webcomponents-mcp-serverInstall UI5 Web Components MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"webcomponents-mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/webcomponents-mcp-server"
]
}
}
}Automated checks
Ran Nov 14, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachableui5/webcomponents-mcp-server is public and reachablegithub.com/ui5/webcomponents-mcp-server ↗Pass
- Package names this repository as its source@ui5/webcomponents-mcp-server names ui5/webcomponents-mcp-server as sourcenpmjs.com/package/@ui5/webcomponents-mcp-server ↗Pass
- Build provenance (Sigstore attestation)Sigstore attestation for @ui5/webcomponents-mcp-servernpmjs.com/package/@ui5/webcomponents-mcp-server/v/0.1.2#prov ↗Pass
- Open source license (OSI)Apache-2.0spdx.org/licenses/Apache-2.0.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-08-31github.com/ui5/webcomponents-mcp-server ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNo popular package one edit away from @ui5/webcomponents-mcp-serverPass
- No critical advisory in the package or its dependencies99 resolved dependencies checked; no critical advisoryosv.dev ↗Pass
- No hidden instructions to the model0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNot checked
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubUI5 Web Components MCP Server
A Model Context Protocol server for UI5 Web Components development.
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), Claude Code, Codex, or any other MCP-compatible client
Setup
Standard Configuration for Most Clients
This configuration works for most MCP clients:
{
"mcpServers": {
"@ui5/webcomponents-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@ui5/webcomponents-mcp-server"]
}
}
}
{
"mcpServers": {
"@ui5/webcomponents-mcp-server": {
"type": "stdio",
"command": "cmd",
"args": ["/c", "npx -y @ui5/webcomponents-mcp-server"]
}
}
}
Specific MCP Clients
Besides the general configuration outlined above, some MCP clients offer shortcuts for installing MCP servers.
VS Code
code --add-mcp '{"name":"@ui5/webcomponents-mcp-server","type":"stdio","command":"npx","args":["-y","@ui5/webcomponents-mcp-server"]}'
Claude Code
claude mcp add --transport stdio --scope user ui5-webc-mcp-server -- npx -y @ui5/webcomponents-mcp-server
Codex
codex mcp add --transport stdio ui5-webc-mcp-server -- npx -y @ui5/webcomponents-mcp-server
Usage
Once set up, ask your AI assistant things like:
- "Show me the API for ui5-button"
- "How do I use UI5 Web Components with React?"
- "Show me the available documentation"
- "Get the theming documentation"
Available Tools
get_component_api
Fetch API docs for any UI5 Web Component (properties, slots, events, methods).
Searches across @ui5/webcomponents, @ui5/webcomponents-fiori, and @ui5/webcomponents-ai packages.
get_guidelines
Get integration guides for React, Angular, or native JavaScript.
Includes installation, imports, and usage examples.
list_docs
List all available UI5 Web Components documentation with summaries.
get_doc
Fetch full content of specific documentation files.
Development
npm run build # Build TypeScript
npm run dev # Run locally
npm run test # Run tests
npm run inspector # Debug with MCP inspector
npm run prepare:docs # Fetch latest docs from GitHub
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.
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 2025 SAP SE or an SAP affiliate company and ui5-web-components-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.
UI5 Web Components MCP questions
How do I add UI5 Web Components MCP to Claude Code?
Run claude mcp add webcomponents-mcp-server -- npx -y @ui5/webcomponents-mcp-server in your terminal. Add --scope user to make it available in every project.
How do I add UI5 Web Components MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
What can I ask the AI assistant about UI5 Web Components?
You can ask for component APIs, integration guides for React or Angular, available documentation, and theming information.
Which frameworks can I get integration guides for?
The server provides integration guides for React, Angular, or native JavaScript.