一个用于 UI5 Web 组件开发的模型上下文协议服务器。

要求

• Node.js 版本 v20.17.0、v22.9.0 或更高版本
• npm 版本 v8.0.0 或更高版本
• MCP 客户端，如 VS Code（GitHub Copilot）、Claude Code、Codex 或其他兼容 MCP 的客户端

布置

大多数客户端的标准配置

该配置适用于大多数MCP客户端：

原生Windows的特殊配置 在原生Windows（非WSL）上，你可能需要在npx前加上cmd /c：

特定 MCP 客户端

除了上述通用配置外，一些MCP客户端还提供安装MCP服务器的捷径。

VS 代码

克劳德·科德

法典

用途

设置好后，可以向你的AI助手提问：

• “给我展示ui5-button的API”
• “我如何将UI5 Web Components与React一起使用？”
• “显示可用文档”
• “获取主题文档”

可用工具

get_component_api

获取任何UI5 Web 组件（属性、槽、事件、方法）的 API 文档。 搜索 @ui5/webcomponents、@ui5/webcomponents-fiori 和 @ui5/webcomponents-ai 包。

get_guidelines

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"]
    }
  }
}

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