@sit-onyx/modelcontextprotocol 0.0.0 → 0.1.0-dev-20260409084453

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sit-onyx/modelcontextprotocol",
-  "version": "0.0.0",
+  "version": "0.1.0-dev-20260409084453",
   "description": "MCP (Model Context Protocol) Server that provide onyx specific tools and resources.",
   "homepage": "https://onyx.schwarz",
   "bugs": {
@@ -9,12 +9,13 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/SchwarzIT/onyx",
-    "directory": "apps/modelcontextprotocol"
+    "directory": "packages/modelcontextprotocol"
   },
   "license": "Apache-2.0",
   "author": "Schwarz IT KG",
   "type": "module",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "bin": {
     "onyx-mcp": "./dist/index.js"
   },
@@ -27,18 +28,21 @@
   "devDependencies": {
     "@types/node": "24.12.0",
     "@types/tar-stream": "^3.1.4",
-    "pacote": "^21.5.0",
     "query-registry": "^4.3.0",
     "tar-stream": "^3.1.8",
     "typescript": "5.9.3",
-    "url-join": "^5.0.0",
-    "vue-component-meta": "^3.2.6"
+    "vite": "8.0.3",
+    "vite-plugin-dts": "^4.5.4",
+    "vue-component-meta": "^3.2.6",
+    "@sit-onyx/shared": "^0.1.0"
   },
   "engines": {
     "node": ">=20"
   },
   "scripts": {
-    "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev": "pnpm run \"/build-dev|inspect-mcp/\"",
+    "build-dev": "vite build --ssr -w",
+    "inspect-mcp": "pnpm dlx @modelcontextprotocol/inspector node ./dist/index.js",
+    "build": "vite build --ssr"
   }
 }

package/dist/config.d.ts

@@ -1,4 +0,0 @@
-export declare const USER_AGENT: string;
-export declare const REGISTRY_URL: string;
-export declare const SIT_ONYX_MIN_VERSION = "1.0.0";
-export declare const SIT_ONYX_COMPONENT_META_FILE = "package/dist/component-meta.json";

package/dist/config.js

@@ -1,6 +0,0 @@
-import packageJson from "../package.json" with { type: "json" };
-const { version } = packageJson;
-export const USER_AGENT = `onyx-mcp/${version}`;
-export const REGISTRY_URL = process.env.REGISTRY_URL ?? "https://registry.npmjs.org";
-export const SIT_ONYX_MIN_VERSION = "1.0.0";
-export const SIT_ONYX_COMPONENT_META_FILE = "package/dist/component-meta.json";

package/dist/resources/get-component-api.d.ts

@@ -1,2 +0,0 @@
-import type { RegisterableResource } from "../types.js";
-export declare const getComponentApi: RegisterableResource;

package/dist/resources/get-component-api.js

@@ -1,92 +0,0 @@
-import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { retrieveComponentMetaJsonFile } from "../util/component-meta-json.js";
-/**
- * Returns true if both parameters are defined and equal (ignoring surrounding whitespaces and case)
- */
-const compareDefined = (a, b) => a && b && a.trim().toLowerCase() === b.trim().toLowerCase();
-const tagsToList = (tags) => tags
-    .filter(({ name }) => !!name)
-    .map(({ text, name }) => `- ${name}: ${text}`)
-    .join("\n");
-export const getComponentApi = [
-    "get-component-api",
-    new ResourceTemplate("components://sit-onyx/{version}/{component}", {
-        list: undefined,
-    }),
-    {
-        title: "Get Component API",
-        description: "Get the component api for a specific component and version of onyx",
-        mimeType: "text/markdown",
-    },
-    async (uri, { version: _version, component: _component }) => {
-        const version = Array.isArray(_version) ? _version[0] : _version;
-        const component = Array.isArray(_component) ? _component[0] : _component;
-        const componentMetaJson = await retrieveComponentMetaJsonFile(version);
-        const componentMeta = componentMetaJson.find(({ displayName, name }) => compareDefined(displayName, name) || compareDefined(name, component));
-        if (!componentMeta) {
-            throw new Error(`Component ${component} not found for version ${version}`);
-        }
-        // TODO: improve code readability through use of better templating
-        const propsText = componentMeta.props
-            .map((prop) => `### ${prop.name}
-
-- required: ${prop.required}
-- type: ${prop.type}
-${tagsToList(prop.tags)}
-
-${prop.description}`)
-            .join("\n\n");
-        const slotsText = componentMeta.slots
-            .map((slot) => `### ${slot.name}
-
-${tagsToList(slot.tags)}
-
-${slot.description}`)
-            .join("\n\n");
-        const eventsText = componentMeta.events
-            .map((event) => `### ${event.name}
-
-- type: ${event.type}
-${tagsToList(event.tags)}
-
-${event.description}`)
-            .join("\n\n");
-        const exposedText = componentMeta.exposed
-            .map((exposed) => `### ${exposed.name}
-
-- type: ${exposed.type}
-${tagsToList(exposed.tags)}
-
-${exposed.description}`)
-            .join("\n\n");
-        const text = `# Component API of \`${componentMeta.displayName}\`
-
-*Version: \`sit-onyx@${version}\`*
-
-## Props
-
-${propsText}
-
-## Slots
-
-${slotsText}
-
-## Events
-
-${eventsText}
-
-## Exposed
-
-${exposedText}
-`;
-        return {
-            contents: [
-                {
-                    uri: uri.href,
-                    text,
-                    mimeType: "text/markdown",
-                },
-            ],
-        };
-    },
-];

package/dist/resources/list-components.d.ts

@@ -1,2 +0,0 @@
-import type { RegisterableResource } from "../types.js";
-export declare const listComponents: RegisterableResource;

package/dist/resources/list-components.js

@@ -1,41 +0,0 @@
-import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { getAbbreviatedPackument } from "query-registry";
-import { REGISTRY_URL, SIT_ONYX_MIN_VERSION } from "../config.js";
-import { retrieveComponentMetaJsonFile } from "../util/component-meta-json.js";
-export const listComponents = [
-    "list-components",
-    new ResourceTemplate("components://sit-onyx/{version}", {
-        list: async () => {
-            const { versions } = await getAbbreviatedPackument("sit-onyx", REGISTRY_URL);
-            const relevantVersions = Object.keys(versions).filter((version) => version.split("-").at(0) ?? "" >= SIT_ONYX_MIN_VERSION);
-            const resources = relevantVersions.map((version) => ({
-                uri: `components://sit-onyx/${version}`,
-                name: version,
-            }));
-            return { resources };
-        },
-    }),
-    {
-        title: "Component Overview",
-        description: "Lists all components for a specific version of onyx",
-        mimeType: "text/markdown",
-    },
-    async (uri, { version: _version }) => {
-        const version = Array.isArray(_version) ? _version[0] : _version;
-        const componentMetaJson = await retrieveComponentMetaJsonFile(version);
-        const componentsText = componentMetaJson
-            .toSorted((a, b) => a.displayName.localeCompare(b.displayName))
-            .map(({ displayName, description }) => `## ${displayName}\n\n${description ?? ""}\n`)
-            .join("\n");
-        const text = `# Components for \`sit-onyx@${version}\`\n\n${componentsText}`;
-        return {
-            contents: [
-                {
-                    uri: uri.href,
-                    text,
-                    mimeType: "text/markdown",
-                },
-            ],
-        };
-    },
-];

package/dist/resources/list-icons.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/resources/list-icons.js

@@ -1,118 +0,0 @@
-export {};
-/* import { ResourceTemplate } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { RegisterableResource } from "../types.js";
-import { retrieveComponentMetaJsonFile } from "../util/component-meta-json.js";
-
-const compareDefined = (a: string | undefined | null, b: string | undefined | null) =>
-  a && b && a.trim().toLowerCase() === b.trim().toLowerCase();
-
-type Tag = {
-  name?: string;
-  text?: string;
-};
-
-const tagsToList = (tags: Tag[]) =>
-  tags
-    .filter(({ name }) => !!name)
-    .map(({ text, name }) => `- ${name}: ${text}`)
-    .join("\n");
-
-export const listIcons: RegisterableResource = [
-  "list-icons",
-  new ResourceTemplate("icons://sit-onyx/{version}", {
-    list: undefined,
-  }),
-  {
-    title: "List @sit-onyx/icons icons",
-    description: "List all icons available in a specific version of @sit-onyx/icons",
-    mimeType: "text/markdown",
-  },
-  async (uri, { version: _version }) => {
-    const version = Array.isArray(_version) ? _version[0] : _version;
-    const componentMetaJson = await retrieveComponentMetaJsonFile(version);
-    const componentMeta = componentMetaJson.find(
-      ({ displayName, name }) =>
-        compareDefined(displayName, name) || compareDefined(name, component),
-    );
-
-    if (!componentMeta) {
-      throw new Error(`Component ${component} not found for version ${version}`);
-    }
-
-    const propsText = componentMeta.props
-      .map(
-        (prop) => `### ${prop.name}
-
-- required: ${prop.required}
-- type: ${prop.type}
-${tagsToList(prop.tags)}
-
-${prop.description}`,
-      )
-      .join("\n\n");
-
-    const slotsText = componentMeta.slots
-      .map(
-        (slot) => `### ${slot.name}
-
-${tagsToList(slot.tags)}
-
-${slot.description}`,
-      )
-      .join("\n\n");
-
-    const eventsText = componentMeta.events
-      .map(
-        (event) => `### ${event.name}
-
-- type: ${event.type}
-${tagsToList(event.tags)}
-
-${event.description}`,
-      )
-      .join("\n\n");
-
-    const exposedText = componentMeta.exposed
-      .map(
-        (exposed) => `### ${exposed.name}
-
-- type: ${exposed.type}
-${tagsToList(exposed.tags)}
-
-${exposed.description}`,
-      )
-      .join("\n\n");
-
-    const text = `# Component API of \`${componentMeta.displayName}\`
-
-*Version: \`sit-onyx@${version}\`*
-
-## Props
-
-${propsText}
-
-## Slots
-
-${slotsText}
-
-## Events
-
-${eventsText}
-
-## Exposed
-
-${exposedText}
-`;
-
-    return {
-      contents: [
-        {
-          uri: uri.href,
-          text,
-          mimeType: "text/markdown",
-        },
-      ],
-    };
-  },
-];
- */ 

package/dist/server/http.d.ts

@@ -1,5 +0,0 @@
-/**
- * MCP server running as a http server.
- * `HOST` and `PORT` environment variable can be used to change the server settings.
- */
-export declare const run: () => Promise<void>;

package/dist/server/http.js

@@ -1,20 +0,0 @@
-import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
-import { randomUUID } from "node:crypto";
-import { createServer } from "node:http";
-import { server } from "./server.js";
-import { error } from "node:console";
-/**
- * MCP server running as a http server.
- * `HOST` and `PORT` environment variable can be used to change the server settings.
- */
-export const run = async () => {
-    const transport = new StreamableHTTPServerTransport({
-        sessionIdGenerator: () => randomUUID(),
-    });
-    await server.connect(transport);
-    const httpServer = createServer(transport.handleRequest);
-    const PORT = Number.parseInt(process.env["PORT"] ?? "3000");
-    const HOST = process.env["HOST"] ?? "0.0.0.0";
-    httpServer.listen(PORT, HOST);
-    error(`MCP http server listening on ${HOST}:${PORT}.`);
-};

package/dist/server/server.d.ts

@@ -1,6 +0,0 @@
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-/**
- * Internal McpServer, which provides the MCP resources.
- */
-declare const server: McpServer;
-export { server };

package/dist/server/server.js

@@ -1,17 +0,0 @@
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import packageJson from "../../package.json" with { type: "json" };
-import { getComponentApi } from "../resources/get-component-api.js";
-import { listComponents } from "../resources/list-components.js";
-const { name, version, description } = packageJson;
-/**
- * Internal McpServer, which provides the MCP resources.
- */
-const server = new McpServer({
-    name,
-    version,
-    description,
-    websiteUrl: "https://onyx.schwarz",
-});
-server.registerResource(...listComponents);
-server.registerResource(...getComponentApi);
-export { server };

package/dist/server/stdio.d.ts

@@ -1,5 +0,0 @@
-/**
- * MCP server running via stdio.
- * All logging has to use stderr, otherwise the logging to stdio will break the transport.
- */
-export declare const run: () => Promise<void>;

package/dist/server/stdio.js

@@ -1,12 +0,0 @@
-import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { error } from "node:console";
-import { server } from "./server.js";
-/**
- * MCP server running via stdio.
- * All logging has to use stderr, otherwise the logging to stdio will break the transport.
- */
-export const run = async () => {
-    const transport = new StdioServerTransport();
-    await server.connect(transport);
-    error("MCP Server running on stdio.");
-};

package/dist/server/web.js

@@ -1,10 +0,0 @@
-import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
-import { randomUUID } from "node:crypto";
-import { server } from "./server.js";
-export const run = async () => {
-    const transport = new StreamableHTTPServerTransport({
-        sessionIdGenerator: () => randomUUID(),
-    });
-    await server.connect(transport);
-    console.error("Weather MCP Server running on stdio");
-};

package/dist/types.d.ts

@@ -1,7 +0,0 @@
-import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import { type ComponentMeta, type MetaCheckerOptions } from "vue-component-meta";
-export type RegisterableResource = Parameters<InstanceType<typeof McpServer>["registerResource"]>;
-export type MetaSource = {
-    exportName: string;
-    displayName: string;
-} & ComponentMeta & Exclude<MetaCheckerOptions["schema"], boolean>;

package/dist/types.js

@@ -1 +0,0 @@
-export {};

package/dist/util/component-meta-json.d.ts

@@ -1,2 +0,0 @@
-import type { MetaSource } from "../types.js";
-export declare function retrieveComponentMetaJsonFile(version: string): Promise<MetaSource[]>;

package/dist/util/component-meta-json.js

@@ -1,64 +0,0 @@
-import { Readable } from "node:stream";
-import { buffer } from "node:stream/consumers";
-import { pipeline } from "node:stream/promises";
-import { createGunzip } from "node:zlib";
-import { getPackageManifest } from "query-registry";
-import tarStream from "tar-stream";
-import { REGISTRY_URL, SIT_ONYX_COMPONENT_META_FILE } from "../config.js";
-class SuccessfulAbort {
-    data;
-    constructor(data) {
-        this.data = data;
-    }
-}
-// TODO: It's quite fast, but we should add caching nevertheless.
-export async function retrieveComponentMetaJsonFile(version) {
-    const { dist } = await getPackageManifest("sit-onyx", version, REGISTRY_URL);
-    const { body } = await fetch(dist.tarball);
-    if (!body) {
-        throw new Error(`No body in response for tarball request to "${dist.tarball}"!`);
-    }
-    /**
-     * Allows us to stop the stream pipeline at any time.
-     * We also use the abort reason to emit the result.
-     */
-    const abortController = new AbortController();
-    const archiveDownload = Readable.fromWeb(body); // Incorrect typing, see: https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/65542#discussioncomment-6071004
-    const decompress = createGunzip();
-    const fileSearcher = createTarFileSearcher(abortController);
-    try {
-        await pipeline(archiveDownload, decompress, fileSearcher, { signal: abortController.signal });
-        throw new Error("No 'component-meta.json' found!");
-    }
-    catch (error) {
-        if (error instanceof Error &&
-            error.name === "AbortError" &&
-            error.cause instanceof SuccessfulAbort) {
-            // Return the found data as parsed JSON
-            const { data } = error.cause;
-            return JSON.parse(data.toString("utf-8"));
-        }
-        // Re-throw any other error
-        throw error;
-    }
-}
-/**
- * Returns a writable stream, which searches a file in a tar archive by filename/filepath.
- * If found, will call the AbortController with the file content as reason.
- */
-function createTarFileSearcher(abortController) {
-    const searchFile = tarStream.extract();
-    searchFile.on("entry", async (headers, stream, next) => {
-        if (headers.name === SIT_ONYX_COMPONENT_META_FILE) {
-            const data = await buffer(stream);
-            // found the relevant file, stop further processing
-            abortController.abort(new SuccessfulAbort(data));
-        }
-        else {
-            // continue searching
-            stream.resume();
-            next();
-        }
-    });
-    return searchFile;
-}

package/dist/util/icons-meta-json.d.ts

@@ -1,2 +0,0 @@
-import type { MetaSource } from "../types.js";
-export declare function retrieveComponentMetaJsonFile(version: string): Promise<MetaSource[]>;

package/dist/util/icons-meta-json.js

@@ -1,63 +0,0 @@
-import { Readable } from "node:stream";
-import { buffer } from "node:stream/consumers";
-import { pipeline } from "node:stream/promises";
-import { createGunzip } from "node:zlib";
-import { getPackageManifest } from "query-registry";
-import tarStream from "tar-stream";
-import { REGISTRY_URL, SIT_ONYX_COMPONENT_META_FILE } from "../config.js";
-class SuccessfulAbort {
-    data;
-    constructor(data) {
-        this.data = data;
-    }
-}
-export async function retrieveComponentMetaJsonFile(version) {
-    const { dist } = await getPackageManifest("@sit-onyx/icons", version, REGISTRY_URL);
-    const { body } = await fetch(dist.tarball);
-    if (!body) {
-        throw new Error(`No body in response for tarball request to "${dist.tarball}"!`);
-    }
-    /**
-     * Allows us to stop the stream pipeline at any time.
-     * We also use the abort reason to emit the result.
-     */
-    const abortController = new AbortController();
-    const archiveDownload = Readable.fromWeb(body); // Incorrect typing, see: https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/65542#discussioncomment-6071004
-    const decompress = createGunzip();
-    const fileSearcher = createTarFileSearcher(abortController);
-    try {
-        await pipeline(archiveDownload, decompress, fileSearcher, { signal: abortController.signal });
-        throw new Error("No 'component-meta.json' found!");
-    }
-    catch (error) {
-        if (error instanceof Error &&
-            error.name === "AbortError" &&
-            error.cause instanceof SuccessfulAbort) {
-            // Return the found data as parsed JSON
-            const { data } = error.cause;
-            return JSON.parse(data.toString("utf-8"));
-        }
-        // Re-throw any other error
-        throw error;
-    }
-}
-/**
- * Returns a writable stream, which searches a file in a tar archive by filename/filepath.
- * If found, will call the AbortController with the file content as reason.
- */
-function createTarFileSearcher(abortController) {
-    const searchFile = tarStream.extract();
-    searchFile.on("entry", async (headers, stream, next) => {
-        if (headers.name === SIT_ONYX_COMPONENT_META_FILE) {
-            const data = await buffer(stream);
-            // found the relevant file, stop further processing
-            abortController.abort(new SuccessfulAbort(data));
-        }
-        else {
-            // continue searching
-            stream.resume();
-            next();
-        }
-    });
-    return searchFile;
-}