Skip to main content
Glama
UI5

@ui5/webcomponents-mcp-server

by UI5
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Remote

REUSE status npm Package Version

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

Related MCP server: Dedalus MCP Documentation Server

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.

Available Tools

4 tools
get_component_apiA

Get API documentation for a specific UI5 Web Component from @ui5/webcomponents, @ui5/webcomponents-fiori, @ui5/webcomponents-ai

ParametersJSON Schema
NameRequiredDescriptionDefault
componentNameYesComponent name (e.g., 'ui5-button', 'ui5-input', 'ui5-shellbar')
versionNoVersion of the UI5 Web Components packages (e.g., "2.12.0"). If not provided, the latest version will be used.latest

TDQS

A3.5/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Without annotations, the description carries full burden but only states the action. It does not disclose behavior such as read-only nature, network dependency, output format, or any side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence with no wasted words, includes essential context (package list) and is front-loaded with action and resource.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple 2-param tool without output schema, the description is adequate but missing details on return format or possible errors. Could be improved with expected output type.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so both parameters are already described in the schema. The description adds no additional meaning beyond the schema, meeting baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get API documentation', specifies the resource (UI5 Web Component), and lists the relevant packages, making the purpose distinct from sibling tools like get_doc or list_docs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies use when retrieving component API documentation, but does not explicitly contrast with siblings or specify when not to use. No exclusions or alternative tool mentions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_docA

Get full content of UI5 Web Components documentation file(s). Supports reading multiple documents and specific line ranges.

ParametersJSON Schema
NameRequiredDescriptionDefault
docsYesArray of documents to read. Each can specify path and optional line range.

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must disclose behavior. It only states the function (get content) but does not mention safety (e.g., read-only), auth needs, rate limits, or response format. The lack of behavioral context is a gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two concise sentences with no wasted words. The key points (purpose and features) are front-loaded and efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity and full schema coverage, the description is nearly complete. However, no output schema exists and the description does not explain the response format, leaving a minor gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% with detailed descriptions for each parameter. The description adds little beyond restating the schema's capabilities (supports multiple docs and line ranges). Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states the verb 'Get', the resource 'documentation file(s)', and specifics like full content, multiple documents, and line ranges. It also implicitly distinguishes from sibling tools like get_component_api and get_guidelines.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for reading documentation files but does not explicitly differentiate from sibling tools or provide when/when-not guidance. No alternatives or exclusions are mentioned.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_guidelinesA

Get UI5 Web Components development guide. This tool MUST be used before starting development.

ParametersJSON Schema
NameRequiredDescriptionDefault
frameworkYesTarget framework for integration

TDQS

A3.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, and the description only states what the tool does without disclosing behavioral traits such as idempotency, side effects, or output format. It is insufficient for understanding the tool's behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences long, front-loads the purpose, and includes a critical usage directive. Every sentence earns its place without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description is adequate for a simple one-parameter tool, but it lacks any description of the output. Without an output schema, the agent needs to know what format or content to expect, which is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already describes the parameter 'framework' with an enum and description. The tool description adds no additional meaning beyond what the schema provides, so the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Get') and the resource ('UI5 Web Components development guide'). It distinguishes itself from siblings like 'get_component_api' or 'get_doc' by specifying it's a development guide, and includes a mandatory usage hint.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'This tool MUST be used before starting development,' providing clear usage context. However, it does not mention when not to use it or compare with sibling tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_docsA

List all available UI5 Web Components documentation with summaries

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided; description only says it lists docs without disclosing behavioral traits like read-only nature, pagination, or response format.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence, direct and concise with no unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Adequate for a parameterless list tool; covers basic purpose but could mention summary content or output structure.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters exist; schema coverage is 100%, so description adds no additional param info, but baseline for 0 params is high.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it lists all available docs with summaries, distinct from sibling tools like get_component_api (API details) and get_doc (specific doc content).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool vs siblings; no context on prerequisites or alternative scenarios.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

TDQS

A4/5.0
Disambiguation5/5

Each tool serves a distinct purpose: listing docs, retrieving full content, getting component API, and guidelines. No overlap.

Naming Consistency5/5

All tool names use snake_case with a consistent verb_noun pattern (get_*, list_*).

Tool Count5/5

With 4 tools covering documentation retrieval, the count is well-scoped for the server's purpose.

Completeness4/5

The set covers key documentation operations but lacks a search capability; otherwise complete for reading and navigation.

Maintenance

ActivityInactive
ResponsivenessSyncing

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/UI5/webcomponents-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server