fix(mcp-server): fix missing data files in published package (#8462)

Author: Lukas742

.github/workflows/release.yml

@@ -129,6 +129,9 @@ jobs:
       - name: build
         run: yarn build
 
+      - name: build mcp-server data
+        run: yarn build:mcp
+
       - name: publish to npm
         run: |
           ${GITHUB_WORKSPACE}/node_modules/.bin/lerna publish from-git ${{ (github.event.inputs.snapshot == 'true' && '--pre-dist-tag dev') || '' }}

.github/workflows/test.yml

@@ -9,6 +9,27 @@ on:
         required: false
 
 jobs:
+  mcp-server:
+    name: MCP Server
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - name: Install
+        run: yarn install --immutable
+
+      - name: Generate MCP data
+        run: yarn build:mcp
+
+      - name: Run MCP server tests
+        run: yarn test:mcp:ci
+
   playwright:
     name: Playwright
     runs-on: ubuntu-latest

package.json

@@ -37,7 +37,8 @@
     "sb:prepare-cem": "node packages/cli/dist/bin/index.js resolve-cem --packageName @ui5/webcomponents --out ./.storybook/custom-element-manifests/main.json && node packages/cli/dist/bin/index.js resolve-cem --packageName @ui5/webcomponents-fiori --out ./.storybook/custom-element-manifests/fiori.json && node packages/cli/dist/bin/index.js resolve-cem --packageName @ui5/webcomponents-ai --out ./.storybook/custom-element-manifests/ai.json",
     "create-theming-parameters": "node scripts/generate-theming-parameters.js",
     "create-exports": "node --experimental-strip-types scripts/create-export-paths.ts",
-    "build:mcp": "yarn workspace @ui5/webcomponents-react-mcp update"
+    "build:mcp": "yarn workspace @ui5/webcomponents-react-mcp update",
+    "test:mcp:ci": "yarn workspace @ui5/webcomponents-react-mcp test:ci"
   },
   "dependencies": {
     "@stackblitz/sdk": "1.11.0",

packages/mcp-server/README.md

@@ -47,7 +47,7 @@ This MCP server gives AI assistants direct access to UI5 Web Components for Reac
 
 ## Setup
 
-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.
+This server is available in the [MCP Registry](https://registry.modelcontextprotocol.io), which allows compatible clients to install it directly.
 
 ### Claude Code
 
@@ -97,14 +97,14 @@ Once configured, your AI assistant will have access to the tools. You can ask qu
 ### Scripts
 
 ```bash
-npm run build                 # Build TypeScript + copy JSON assets
-npm run dev                   # Build and run locally
+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 + build
+npm run update                # Full pipeline: fetch:skills + extract:descriptions + bundle:docs + compile
 npm run clean                 # Remove dist/, build cache, and all generated files
 ```
 
@@ -181,7 +181,7 @@ The MCP server is a **stdio-based** Node.js process that communicates with AI cl
 1. **`fetch:skills`** — Downloads upstream skill documents (e.g. accessibility) from GitHub, adapts HTML examples to React JSX, writes to `docs/`
 2. **`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`
 3. **`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`
-4. **`build`** — Compiles TypeScript, then `post-build.ts` copies JSON files from `src/` to `dist/` and makes the entry point executable
+4. **`compile`** — Compiles TypeScript, then `post-build.ts` copies JSON files from `src/` to `dist/` and makes the entry point executable
 
 ### Updating Component Data
 
@@ -210,4 +210,4 @@ Then add the server to any project using the absolute path to the built entry po
 claude mcp add --scope project ui5-wcr -- node /path/to/ui5-webcomponents-react/packages/mcp-server/dist/index.js
 ```
 
-After code changes, `npm run build` is enough.
+After code changes, `npm run compile` is enough.

packages/mcp-server/package.json

@@ -26,13 +26,13 @@
   "scripts": {
     "extract:descriptions": "tsx scripts/extract-component-descriptions.ts",
     "bundle:docs": "tsx scripts/bundle-docs.ts",
-    "build": "tsc --build tsconfig.build.json && tsx scripts/post-build.ts",
     "fetch:skills": "tsx scripts/fetch-upstream-skills.ts",
-    "update": "npm run fetch:skills && npm run extract:descriptions && npm run bundle:docs && npm run build",
+    "compile": "tsc --build tsconfig.build.json && tsx scripts/post-build.ts",
+    "update": "npm run fetch:skills && npm run extract:descriptions && npm run bundle:docs && npm run compile",
     "clean": "rimraf dist tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo src/tools/get_component_api/component-apis.json src/tools/list_components/descriptions.json docs/",
-    "dev": "npm run build && node dist/index.js",
     "inspector": "npx @modelcontextprotocol/inspector node ./dist/index.js",
     "test": "ava --watch",
+    "test:ci": "ava",
     "version": "tsx scripts/sync-server-version.ts && git add server.json"
   },
   "publishConfig": {

packages/mcp-server/src/tools/get_component_api/get_component_api.test.ts

@@ -1,7 +1,9 @@
-import test from 'ava';
+import test, { type ExecutionContext } from 'ava';
+import { z } from 'zod';
 import { getComponentApiTool } from './get_component_api.js';
 
 const handler = getComponentApiTool.handler;
+const outputSchema = z.object(getComponentApiTool.outputSchema);
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function getStructured(response: ReturnType<typeof handler>): any {
@@ -11,6 +13,15 @@ function getStructured(response: ReturnType<typeof handler>): any {
   return response.structuredContent;
 }
 
+function assertMatchesOutputSchema(t: ExecutionContext, data: unknown) {
+  const result = outputSchema.safeParse(data);
+  if (!result.success) {
+    t.fail(
+      `Output schema validation failed:\n${result.error.issues.map((i) => `  ${i.path.join('.')}: ${i.message}`).join('\n')}`,
+    );
+  }
+}
+
 test('handler: finds component case-insensitively from generated component-apis.json', (t) => {
   // component-apis.json is gitignored (generated by extract:descriptions)
   // Also verifies findComponent() toLowerCase logic
@@ -31,3 +42,15 @@ test('handler: not-found returns error with available components list', (t) => {
   t.is(result.errorType, 'not_found');
   t.true(result.availableComponents.length > 0);
 });
+
+test('handler: AnalyticalTable response passes outputSchema validation', (t) => {
+  const result = getStructured(handler({ componentName: 'AnalyticalTable' }));
+  assertMatchesOutputSchema(t, result);
+  t.pass();
+});
+
+test('handler: not-found response passes outputSchema validation', (t) => {
+  const result = getStructured(handler({ componentName: 'FakeWidget' }));
+  assertMatchesOutputSchema(t, result);
+  t.pass();
+});

packages/mcp-server/src/tools/get_component_api/get_component_api.ts

@@ -126,10 +126,13 @@ EXAMPLE INPUT: { "componentName": "Dialog" }
       ),
   },
   outputSchema: {
-    package: z.string().describe('NPM package name'),
-    description: z.string().describe('Full component description'),
-    props: z.record(z.string(), z.any()).describe('Component props with types, descriptions, and eventDetail'),
-    methods: z.array(z.any()).describe('Imperative methods accessible via ref'),
+    package: z.string().optional().describe('NPM package name'),
+    description: z.string().optional().describe('Full component description'),
+    props: z
+      .record(z.string(), z.any())
+      .optional()
+      .describe('Component props with types, descriptions, and eventDetail'),
+    methods: z.array(z.any()).optional().describe('Imperative methods accessible via ref'),
     cssParts: z
       .array(z.object({ name: z.string(), description: z.string() }))
       .optional()
@@ -142,10 +145,12 @@ EXAMPLE INPUT: { "componentName": "Dialog" }
       .string()
       .optional()
       .describe('Link to upstream documentation for complex behavioral concepts (e.g. layout algorithms)'),
-    _meta: z.object({
-      apiVersion: z.string(),
-      extractedAt: z.string().optional(),
-    }),
+    _meta: z
+      .object({
+        apiVersion: z.string(),
+        extractedAt: z.string().optional(),
+      })
+      .optional(),
     error: z.string().optional().describe('Error message if component not found'),
     errorType: z
       .enum(['not_found', 'invalid_input'])