Skip to content

Commit 6b537a9

Browse files
authored
fix(mcp): shorten mcp-server description & adjust README (#8455)
1 parent 22c8a65 commit 6b537a9

3 files changed

Lines changed: 28 additions & 9 deletions

File tree

packages/mcp-server/README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UI5 Web Components for React MCP Server
22

3-
Model Context Protocol (MCP) server providing development assistance and API documentation for developers using `@ui5/webcomponents-react`.
3+
MCP server providing development assistance and API documentation for [UI5 Web Components for React](https://github.com/UI5/webcomponents-react).
44

55
## What is this?
66

@@ -31,7 +31,7 @@ This MCP server gives AI assistants direct access to UI5 Web Components for Reac
3131

3232
4. **`get_documentation`** - Documentation, guides, and knowledge base
3333
- Browse by section name or search by keyword across all docs
34-
- Getting Started, Knowledge Base (styling, i18n, SSR, slots, FAQ, accessibility), project templates
34+
- Getting Started, Knowledge Base (styling, i18n, SSR, slots, FAQ, accessibility, and more), project templates
3535
- Full content read from bundled local files (no network required)
3636
- Line-range support (`startLine`/`endLine`) for large documents
3737

@@ -47,7 +47,28 @@ This MCP server gives AI assistants direct access to UI5 Web Components for Reac
4747

4848
## Setup
4949

50-
> **Note:** This package is not yet published to npm. See [Local Development with Claude Code](#local-development-with-claude-code) for how to use it locally.
50+
This server is available in the [MCP Registry](https://registry.modelcontextprotocol.io/servers/io.github.UI5/webcomponents-react-mcp-server), which allows compatible clients to install it directly.
51+
52+
### Claude Code
53+
54+
```bash
55+
claude mcp add ui5-wcr -- npx @ui5/webcomponents-react-mcp
56+
```
57+
58+
### VS Code / Cursor
59+
60+
Add to `.vscode/mcp.json`:
61+
62+
```json
63+
{
64+
"servers": {
65+
"ui5-wcr": {
66+
"command": "npx",
67+
"args": ["@ui5/webcomponents-react-mcp"]
68+
}
69+
}
70+
}
71+
```
5172

5273
## Usage
5374

@@ -60,18 +81,16 @@ Once configured, your AI assistant will have access to the tools. You can ask qu
6081

6182
**Documentation:**
6283

63-
- "Show me the FAQ"
64-
- "How do I get started with UI5 Web Components for React?"
6584
- "How do I style components?"
66-
- "How do I migrate from v1 to v2?"
85+
- "How do slots work?"
6786

6887
**Components:**
6988

7089
- "List all available components"
7190
- "Show me chart components"
7291
- "What layout components are available?"
7392
- "Show me the API for AnalyticalTable"
74-
- "How do I use the Button component?"
93+
- "How do I use the DynamicPage component?"
7594

7695
## Development
7796

packages/mcp-server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@ui5/webcomponents-react-mcp",
3-
"description": "Model Context Protocol server for UI5 Web Components for React - Developer documentation and API assistance",
3+
"description": "MCP server for UI5 Web Components for React - Developer documentation and API assistance",
44
"author": "SAP SE (https://www.sap.com)",
55
"license": "Apache-2.0",
66
"version": "2.21.0",

packages/mcp-server/server.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
33
"name": "io.github.UI5/webcomponents-react-mcp-server",
4-
"description": "Model Context Protocol server for UI5 Web Components for React - Developer documentation and API assistance",
4+
"description": "MCP server for UI5 Web Components for React - Developer documentation and API assistance",
55
"repository": {
66
"url": "https://github.com/UI5/webcomponents-react",
77
"source": "github",

0 commit comments

Comments
 (0)