@ui5/webcomponents-react-mcp

UI5 Web Components for React MCP Server

MCP server providing development assistance and API documentation for UI5 Web Components for React.

What is this?

This MCP server gives AI assistants direct access to UI5 Web Components for React documentation, component APIs, and utility information. It helps developers get accurate, up-to-date information about the library without leaving their IDE.

Features

Tools

• create_app - Scaffold a new application from an official template

  • Vite (TypeScript), Next.js App Router, Next.js Pages Router
  • Returns step-by-step setup instructions using degit

• list_components - Browse all available components

  • Filter by category (Data Display, Layouts & Floorplans, Inputs, Modals & Popovers, User Feedback, Charts, AI Components, Web Components)
  • Filter by package (@ui5/webcomponents-react, @ui5/webcomponents-react-charts, @ui5/webcomponents-ai-react)
  • Includes descriptions and import examples

• get_component_api - Full component API documentation

  • Props with TypeScript types, descriptions, and defaults
  • Event detail parameters (fields available on e.detail)
  • Ref methods and return types
  • CSS ::part() selectors for shadow DOM styling
  • Sub-type documentation for complex props (e.g. AnalyticalTable column definitions)
  • Upstream documentation links for components with complex behavioral logic
  • Case-insensitive component name matching
  • Returns structured JSON output

• get_documentation - Documentation, guides, and knowledge base

  • Browse by section name or search by keyword across all docs
  • Getting Started, Knowledge Base (styling, i18n, SSR, slots, FAQ, accessibility, and more), project templates
  • Full content read from bundled local files (no network required)
  • Line-range support (startLine/endLine) for large documents

• get_public_utils - Public utilities from @ui5/webcomponents-react-base

  • Device API (device detection, responsive breakpoints, resize/orientation handlers)
  • useI18nBundle hook (internationalization)
  • useViewportRange hook (responsive breakpoint detection)
  • ThemingParameters (CSS variables in JavaScript)

Resources

• llms.txt - LLM-friendly documentation index with scope, key concepts, and quick-reference links

Setup

This server is available in the MCP Registry, which allows compatible clients to install it directly.

Claude Code

claude mcp add ui5-wcr -- npx @ui5/webcomponents-react-mcp

VS Code / Cursor

Add to .vscode/mcp.json:

{
  "servers": {
    "ui5-wcr": {
      "command": "npx",
      "args": ["@ui5/webcomponents-react-mcp"]
    }
  }
}

Usage

Once configured, your AI assistant will have access to the tools. You can ask questions like:

Create:

• "Create a new Vite app with UI5 Web Components for React"
• "Scaffold a Next.js app with a simple dashboard"

Documentation:

• "How do I style components?"
• "How do slots work?"

Components:

• "List all available components"
• "Show me chart components"
• "What layout components are available?"
• "Show me the API for AnalyticalTable"
• "How do I use the DynamicPage component?"

Development

Scripts

npm run compile               # Build TypeScript + copy JSON assets (fast rebuild)
npm run inspector             # Debug with MCP Inspector (opens web UI)
npm run test                  # Run tests in watch mode (AVA + tsx)
npm run test:ci               # Run tests once (CI)
npm run extract:descriptions  # Regenerate component metadata from monorepo sources
npm run bundle:docs           # Copy documentation files from monorepo into docs/
npm run fetch:skills          # Fetch upstream documentation (e.g. accessibility skill)
npm run update                # Full pipeline: fetch:skills + extract:descriptions + bundle:docs + compile
npm run clean                 # Remove dist/, build cache, and all generated files

Updating After a Version Bump

When @ui5/webcomponents-react packages are updated, regenerate all data:

npm run update

This runs the full pipeline:

• Fetch upstream skills (accessibility docs from UI5 Web Components)
• Extract component descriptions and API data from monorepo TypeScript sources
• Bundle documentation files (copy MDX/MD from monorepo into docs/)
• Build the TypeScript server and copy JSON assets to dist/

Debug Logging

Enable debug logging by setting the DEBUG environment variable:

DEBUG=true npm run dev

Testing with MCP Inspector

The MCP Inspector provides a web-based UI for testing your MCP server:

npm run inspector

Architecture

Overview

The MCP server is a stdio-based Node.js process that communicates with AI clients via the Model Context Protocol. All data is pre-processed at build time and bundled with the server — no network access is required at runtime.

┌─────────────────────────────────────────────────────────────────────┐
│ Build Time (npm run update)                                         │
│                                                                     │
│  monorepo sources ──► extract-component-descriptions.ts             │
│    (TypeScript,        ├─► descriptions.json (component summaries)  │
│     JSDoc, CEM)        └─► component-apis.json (full prop/method    │
│                              data, event details, CSS parts)        │
│                                                                     │
│  monorepo docs ──────► bundle-docs.ts                               │
│    (MDX, MD files)     └─► docs/ (local copies for offline access)  │
│                                                                     │
│  upstream skills ────► fetch-upstream-skills.ts                      │
│    (GitHub raw)        └─► docs/upstream--accessibility.mdx          │
└─────────────────────────────────────────────────────────────────────┘

┌─────────────────────────────────────────────────────────────────────┐
│ Runtime (stdio)                                                     │
│                                                                     │
│  AI Client ◄──► MCP Server (index.ts)                               │
│                   ├─ create_app        reads project-templates.json  │
│                   ├─ list_components   reads descriptions.json       │
│                   ├─ get_component_api reads component-apis.json     │
│                   ├─ get_documentation reads docs/ + sections.json   │
│                   ├─ get_public_utils  hardcoded documentation       │
│                   └─ llms.txt resource reads resources/llms.txt      │
└─────────────────────────────────────────────────────────────────────┘

Build Pipeline

npm run update runs these steps in order:

• fetch:skills — Downloads upstream skill documents (e.g. accessibility) from GitHub, adapts HTML examples to React JSX, writes to docs/
• extract:descriptions — Uses react-docgen-typescript to parse component sources and Custom Elements Manifests (CEM). Outputs descriptions.json and component-apis.json. Also attaches subTypeDocs (markdown for complex prop types) and docUrl (upstream doc links) from component-config.ts
• bundle:docs — Copies MDX/MD documentation files from the monorepo into docs/. For JSON data sources (e.g. project templates), generates LLM-friendly markdown. Updates localPath fields in documentation_sections.json
• compile — Compiles TypeScript, then post-build.ts copies JSON files from src/ to dist/ and makes the entry point executable

Updating Component Data

When components are added or removed, update src/utils/component-config.ts:

• Categories — Add new components to their category. Uncategorized components trigger a warning during npm run extract:descriptions.
• SUB_TYPE_DOCS — Add markdown paths for complex prop types (e.g. AnalyticalTable column definitions)
• UPSTREAM_DOC_URLS — Add links for components with complex behavioral logic not captured in props (e.g. Form layout)

Adding a New Tool

• Create src/tools/<tool_name>/<tool_name>.ts following the existing pattern (name, title, annotations, description, inputSchema, handler)
• Export it from src/tools/index.ts — it will be auto-registered by index.ts

Local Development with Claude Code

Generate all data files (only needed once, or after version bumps):

npm run update

Then add the server to any project using the absolute path to the built entry point:

claude mcp add --scope project ui5-wcr -- node /path/to/ui5-webcomponents-react/packages/mcp-server/dist/index.js

After code changes, npm run compile is enough.