io.github.UI5/webcomponents-mcp-server MCP Server
io.github.UI5/webcomponents-mcp-server
MCP server for UI5 Web Components API documentation and integration guides.
What this kind of tool is for
- Scaffold, lint, or restyle a component your agent is already editing.
- Run accessibility, link, or screenshot checks against a local build.
- Turn a design constraint into generated markup the agent can iterate on.
How to compare servers like this
- Framework fit:
- Check the tool targets your stack (React, Vue, plain HTML) before installing it.
- Runtime needs:
- Some browser-driving tools need a local browser or display; read the setup notes first.
- Maintenance signal:
- Frontend tooling churns quickly; recent commits are a good filter.
- Output quality:
- Prefer tools whose generated code you would accept into the repo as-is.
This page carries your copy-paste config: pick your MCP client in the install section on this page and use the copy button.
What is the io.github.UI5/webcomponents-mcp-server MCP server?
The UI5 Web Components MCP Server is a Model Context Protocol server that provides AI assistants with access to UI5 Web Components documentation, APIs, and integration guides. It enables developers to query component specifications, theming information, and framework-specific usage examples for React, Angular, and vanilla JavaScript.
This server integrates UI5 Web Components documentation into your AI assistant, allowing you to quickly look up component APIs, retrieve integration guides for different frameworks, and browse available documentation. It's useful for developers building applications with UI5 Web Components who want AI-assisted development with accurate, up-to-date component information.
How to install io.github.UI5/webcomponents-mcp-server
Copy-paste configuration for popular MCP clients.
{
"mcpServers": {
"webcomponents-mcp-server": {
"command": "npx",
"args": [
"-y",
"@ui5/webcomponents-mcp-server"
]
}
}
}Tools & capabilities
Tools this server exposes to the agent.
get_component_api— Fetch API documentation for any UI5 Web Component including properties, slots, events, and methods across @ui5/webcomponents, @ui5/webcomponents-fiori, and @ui5/webcomponents-ai packages.get_guidelines— Get integration guides for React, Angular, or native JavaScript including 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.
Use cases
- Look up the API documentation and available properties for a specific UI5 Web Component like ui5-button
- Get React or Angular integration examples and best practices for using UI5 Web Components
- Browse available UI5 Web Components documentation to discover components and their capabilities
- Retrieve theming documentation to customize UI5 Web Components appearance
- Find usage examples and method signatures for UI5 Web Component events and slots
io.github.UI5/webcomponents-mcp-server MCP server FAQ
It's an MCP server that provides AI assistants with access to UI5 Web Components documentation, APIs, and integration guides for React, Angular, and JavaScript.
Yes, it is open source and available on npm as @ui5/webcomponents-mcp-server.
Run: code --add-mcp '{"name":"@ui5/webcomponents-mcp-server","type":"stdio","command":"npx","args":["-y","@ui5/webcomponents-mcp-server"]}'
Run: claude mcp add --transport stdio --scope user ui5-webc-mcp-server -- npx -y @ui5/webcomponents-mcp-server
Node.js v20.17.0, v22.9.0 or higher, npm v8.0.0 or higher, and an MCP-compatible client like VS Code, Claude Code, or Codex.
No authentication is required. It fetches documentation from the UI5 Web Components packages.
README (reference)
Source of truth, from the repository.
UI5 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"]
}
}
}
<details>
<summary><i>Special configuration for native Windows</i></summary>
On native Windows (not WSL), you might need to prefix npx with `cmd /c`:
{
"mcpServers": {
"@ui5/webcomponents-mcp-server": {
"type": "stdio",
"command": "cmd",
"args": ["/c", "npx -y @ui5/webcomponents-mcp-server"]
}
}
}
</details>
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.
Related MCP servers
MCP server for UI5 Web Components for React - API documentation and developer assistance

io.github.UI5/mcp-server
MCP server for SAPUI5/OpenUI5 development with AI-assisted project scaffolding, linting, and API reference tools.

Screenshot, extract content, and render web pages. PNG/JPEG/WebP/PDF, batch, signed URLs.
Generate, validate, and optimize Adaptive Cards for Teams, Outlook, and Copilot with AI assistance.

PicoBerry
An AI 3D workspace for games, VR, and beyond. Generate, remesh, texture, and animate 3D assets.

Your agent opens a real merchant account (go_live) and takes payments the same day. 3.9% flat.
