@synergy-design-system/mcp 2.14.1 → 3.0.0

package/dist/tools/framework-info.js

@@ -1,58 +0,0 @@
-import { z } from 'zod';
-import { getDynamicMetaDataForFramework, getStaticMetaDataForFramework, getStructuredMetaData, setupPath, } from '../utilities/index.js';
-/**
- * Simple tool to list all available components in the Synergy Design System.
- * This tool fetches the component data from the Synergy package and formats it for display.
- * @param server - The MCP server instance to register the tool on.
- */
-export const frameworkInfoTool = (server) => {
-    server.registerTool('framework-info', {
-        description: 'Get information about a specific framework package that the Synergy Design System supports',
-        inputSchema: {
-            framework: z.enum(['react', 'vue', 'angular', 'vanilla']).default('vanilla').optional().describe('The framework you want information for, e.g., "react", "vue", etc.'),
-            setupInstructions: z.boolean().default(false).optional().describe('Adds additional context to include setup instructions all synergy applications.'),
-        },
-        title: 'Synergy framework information',
-    }, async ({ framework, setupInstructions, }) => {
-        const dynamicInformation = await getDynamicMetaDataForFramework(framework);
-        const staticInformation = await getStaticMetaDataForFramework(framework);
-        // Needed framework information
-        const content = [
-            {
-                text: JSON.stringify(staticInformation, null, 2),
-                type: 'text',
-            },
-            {
-                text: JSON.stringify(dynamicInformation, null, 2),
-                type: 'text',
-            },
-        ];
-        // Provide additional context for the vanilla framework if requested
-        if (framework !== 'vanilla') {
-            const vanillaInformation = await getDynamicMetaDataForFramework('vanilla');
-            content.push({
-                text: 'Additional information about the usage of Synergy for the vanilla framework',
-                type: 'text',
-            });
-            content.push({
-                text: JSON.stringify(vanillaInformation, null, 2),
-                type: 'text',
-            });
-        }
-        // Add the optional setup instructions if requested
-        if (setupInstructions) {
-            const instructions = await getStructuredMetaData(setupPath);
-            content.push({
-                text: 'The following information applies to all Synergy applications.',
-                type: 'text',
-            });
-            content.push({
-                text: JSON.stringify(instructions, null, 2),
-                type: 'text',
-            });
-        }
-        return {
-            content,
-        };
-    });
-};

package/dist/tools/tokens.js

@@ -1,24 +0,0 @@
-import { z } from 'zod';
-import { getTokensMetaData, } from '../utilities/index.js';
-/**
- * Simple tool to list all available tokens in the Synergy Design System.
- * This tool fetches the token data from the Synergy package and formats it for display.
- * @param server - The MCP server instance to register the tool on.
- */
-export const tokenInfoTool = (server) => {
-    server.registerTool('token-info', {
-        description: 'Get information about design tokens available in the Synergy Design System',
-        inputSchema: {
-            type: z.enum(['javascript', 'css']).default('css').optional().describe('The type of token to retrieve, e.g., "javascript" for JS tokens or "css" for CSS tokens.'),
-        },
-        title: 'Token info',
-    }, async ({ type, }) => {
-        const metadata = await getTokensMetaData(type);
-        return {
-            content: [{
-                    text: JSON.stringify(metadata, null, 2),
-                    type: 'text',
-                }],
-        };
-    });
-};

package/dist/tools/version.d.ts

@@ -1,7 +0,0 @@
-import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-/**
- * Tool to get version information about the Synergy Design System MCP Server.
- * This allows LLMs to query the current version and basic information about this MCP server.
- * @param server - The MCP server instance to register the tool on.
- */
-export declare const versionTool: (server: McpServer) => void;

package/dist/tools/version.js

@@ -1,53 +0,0 @@
-import { getPackageInfo } from '../utilities/version.js';
-/**
- * Tool to get version information about the Synergy Design System MCP Server.
- * This allows LLMs to query the current version and basic information about this MCP server.
- * @param server - The MCP server instance to register the tool on.
- */
-export const versionTool = (server) => {
-    server.registerTool('version', {
-        description: 'Get version and basic information about the Synergy Design System MCP Server',
-        inputSchema: {},
-        title: 'Synergy MCP Version Information',
-    }, 
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async () => {
-        const packageJson = getPackageInfo();
-        const versionInfo = {
-            author: packageJson.author,
-            description: packageJson.description,
-            homepage: packageJson.homepage,
-            license: packageJson.license,
-            name: packageJson.name,
-            repository: packageJson.repository,
-            version: packageJson.version,
-        };
-        return {
-            content: [
-                {
-                    text: `Synergy Design System MCP Server Information:
-
-**Version:** ${versionInfo.version}
-**Name:** ${versionInfo.name}
-**Description:** ${versionInfo.description}
-
-**Author:** ${versionInfo.author?.name || 'N/A'}
-**License:** ${versionInfo.license || 'N/A'}
-**Repository:** ${versionInfo.repository?.url || 'N/A'}
-**Homepage:** ${versionInfo.homepage || 'N/A'}
-
-This MCP server provides tools to interact with the Synergy Design System, including:
-- Component information and documentation
-- Framework-specific guidance (React, Vue, Angular, Vanilla)
-- Design tokens and styling information
-- Asset and icon information
-- Migration guides from DaVinci to Synergy
-- Template and pattern information
-
-For more information about available tools, you can explore the other MCP tools provided by this server.`,
-                    type: 'text',
-                },
-            ],
-        };
-    });
-};

package/dist/utilities/assets.d.ts

@@ -1,2 +0,0 @@
-import { type Filter } from './metadata.js';
-export declare const getAssetsMetaData: (filter?: Filter) => Promise<(import("./metadata.js").MetadataFile | null)[]>;

package/dist/utilities/assets.js

@@ -1,3 +0,0 @@
-import { assetsPath, } from './config.js';
-import { getStructuredMetaData, } from './metadata.js';
-export const getAssetsMetaData = async (filter) => getStructuredMetaData(assetsPath, filter);

package/dist/utilities/checksum.d.ts

@@ -1,36 +0,0 @@
-/**
- * Options for creating a checksum from folder contents
- */
-export interface ChecksumOptions {
-    /** Array of patterns to exclude (e.g., ['.*', 'checksum.txt']) */
-    excludePatterns?: string[];
-    /** Output file path for the checksum (relative to the folder) */
-    outputFile?: string;
-    /** Hash algorithm to use */
-    algorithm?: 'md5' | 'sha1' | 'sha256';
-}
-/**
- * Creates a checksum from folder contents, replicating the behavior of:
- * find ./folder ! -name '.*' ! -name 'checksum.txt' -type f -print0 | sort -z | xargs -0 cat | md5
- *
- * @param folderPath - Path to the folder to process
- * @param options - Configuration options
- * @returns Promise<string> - The generated checksum
- */
-export declare function createFolderChecksum(folderPath: string, options?: ChecksumOptions): Promise<string>;
-/**
- * Verifies if the current folder contents match the stored checksum
- *
- * @param folderPath - Path to the folder to verify
- * @param options - Configuration options
- * @returns Promise<boolean> - True if checksum matches, false otherwise
- */
-export declare function verifyFolderChecksum(folderPath: string, options?: ChecksumOptions): Promise<boolean>;
-/**
- * Get the current checksum without writing it to a file
- *
- * @param folderPath - Path to the folder to process
- * @param options - Configuration options (outputFile will be ignored)
- * @returns Promise<string> - The generated checksum
- */
-export declare function getFolderChecksum(folderPath: string, options?: Omit<ChecksumOptions, 'outputFile'>): Promise<string>;

package/dist/utilities/checksum.js

@@ -1,94 +0,0 @@
-/* eslint-disable no-restricted-syntax */
-import { createHash } from 'node:crypto';
-import { readFile, writeFile } from 'node:fs/promises';
-import { join, relative } from 'node:path';
-import { globby } from 'globby';
-/**
- * Creates a checksum from folder contents, replicating the behavior of:
- * find ./folder ! -name '.*' ! -name 'checksum.txt' -type f -print0 | sort -z | xargs -0 cat | md5
- *
- * @param folderPath - Path to the folder to process
- * @param options - Configuration options
- * @returns Promise<string> - The generated checksum
- */
-export async function createFolderChecksum(folderPath, options = {}) {
-    const { excludePatterns = ['.*', 'checksum.txt'], algorithm = 'md5', } = options;
-    // Use default 'checksum.txt' if outputFile is not specified, but respect explicit undefined
-    const outputFile = 'outputFile' in options ? options.outputFile : 'checksum.txt';
-    try {
-        // Build glob patterns to exclude specified patterns
-        const includePattern = join(folderPath, '**', '*');
-        const excludeGlobs = excludePatterns.map(pattern => join(folderPath, '**', pattern));
-        // Find all files, excluding specified patterns
-        const files = await globby([includePattern], {
-            absolute: true,
-            ignore: excludeGlobs,
-            onlyFiles: true,
-        });
-        // Sort files by their relative paths (to match shell script behavior)
-        const sortedFiles = files.sort((a, b) => {
-            const relativeA = relative(folderPath, a);
-            const relativeB = relative(folderPath, b);
-            return relativeA.localeCompare(relativeB);
-        });
-        // Create hash instance
-        const hash = createHash(algorithm);
-        // Read and concatenate all file contents (equivalent to xargs -0 cat)
-        // Note: Sequential reading to maintain order consistency with shell script
-        for (const filePath of sortedFiles) {
-            // eslint-disable-next-line no-await-in-loop
-            const content = await readFile(filePath);
-            hash.update(content);
-        }
-        // Generate the final checksum
-        const checksum = hash.digest('hex');
-        // Write checksum to output file if specified
-        if (outputFile) {
-            const outputPath = join(folderPath, outputFile);
-            await writeFile(outputPath, `${checksum}\n`, 'utf8');
-        }
-        return checksum;
-    }
-    catch (error) {
-        throw new Error(`Failed to create folder checksum: ${error instanceof Error ? error.message : String(error)}`);
-    }
-}
-/**
- * Verifies if the current folder contents match the stored checksum
- *
- * @param folderPath - Path to the folder to verify
- * @param options - Configuration options
- * @returns Promise<boolean> - True if checksum matches, false otherwise
- */
-export async function verifyFolderChecksum(folderPath, options = {}) {
-    const { outputFile = 'checksum.txt' } = options;
-    try {
-        // Read stored checksum
-        const checksumPath = join(folderPath, outputFile);
-        const storedChecksum = (await readFile(checksumPath, 'utf8')).trim();
-        // Calculate current checksum (without writing to file)
-        const currentChecksum = await createFolderChecksum(folderPath, {
-            ...options,
-            outputFile: undefined, // Don't write to file during verification
-        });
-        return storedChecksum === currentChecksum;
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    }
-    catch (error) {
-        // If we can't read the checksum file, consider it invalid
-        return false;
-    }
-}
-/**
- * Get the current checksum without writing it to a file
- *
- * @param folderPath - Path to the folder to process
- * @param options - Configuration options (outputFile will be ignored)
- * @returns Promise<string> - The generated checksum
- */
-export async function getFolderChecksum(folderPath, options = {}) {
-    return createFolderChecksum(folderPath, {
-        ...options,
-        outputFile: undefined,
-    });
-}

package/dist/utilities/components.d.ts

@@ -1,25 +0,0 @@
-import { type Framework } from './config.js';
-/**
- * Get dynamic information about the usage of a specific framework in the Synergy Design System.
- * @param framework The framework to get information about
- * @returns List of structured metadata for the specified framework.
- */
-export declare const getDynamicMetaDataForFramework: (framework?: Framework) => Promise<(import("./metadata.js").MetadataFile | null)[]>;
-/**
- * Get additional information about the usage of a specific framework in the Synergy Design System.
- * @param framework The framework to get information about
- * @returns List of structured metadata for the specified framework.
- */
-export declare const getStaticMetaDataForFramework: (framework?: Framework) => Promise<(import("./metadata.js").MetadataFile | null)[]>;
-/**
- * Get information about the usage of a specific component in the Synergy Design System.
- * @param component The name of the component to get information about, e.g., 'syn-button'.
- * @param framework The framework to filter the component usage information by.
- * @returns The structured metadata for the specified component.
- */
-export declare const getInfoForComponent: (component: string, framework?: Framework) => Promise<(import("./metadata.js").MetadataFile | null)[]>;
-/**
- * Get a list of all available components in the Synergy Design System.
- * @returns A list of all available components in the Synergy Design System.
- */
-export declare const getAvailableComponents: () => Promise<string[]>;

package/dist/utilities/components.js

@@ -1,86 +0,0 @@
-import fs from 'node:fs/promises';
-import { angularPath, componentPath, componentStaticPath, reactPath, staticPath, vuePath, } from './config.js';
-import { getAbsolutePath } from './file.js';
-import { getStructuredMetaData, getStructuredMetaDataForComponent, } from './metadata.js';
-/**
- * Get dynamic information about the usage of a specific framework in the Synergy Design System.
- * @param framework The framework to get information about
- * @returns List of structured metadata for the specified framework.
- */
-export const getDynamicMetaDataForFramework = async (framework = 'vanilla') => {
-    let frameworkPath;
-    switch (framework) {
-        case 'angular':
-            frameworkPath = angularPath;
-            break;
-        case 'react':
-            frameworkPath = reactPath;
-            break;
-        case 'vue':
-            frameworkPath = vuePath;
-            break;
-        default:
-            frameworkPath = componentStaticPath;
-    }
-    return getStructuredMetaData(frameworkPath);
-};
-/**
- * Get additional information about the usage of a specific framework in the Synergy Design System.
- * @param framework The framework to get information about
- * @returns List of structured metadata for the specified framework.
- */
-export const getStaticMetaDataForFramework = async (framework = 'vanilla') => {
-    const frameworkPath = framework === 'vanilla' ? 'components' : framework;
-    return getStructuredMetaData(getAbsolutePath(`${staticPath}/${frameworkPath}`));
-};
-/**
- * Get additional information for a specific component from the static metadata.
- * @param component The name of the component to get information about, e.g., 'syn-button'.
- * @returns The structured metadata for the specified component, taken from the static metadata.
- */
-const getAdditionalInformationForComponent = async (component) => getStructuredMetaDataForComponent(component, undefined, 'static');
-/**
- * Get information about the usage of a specific component in the Synergy Design System.
- * @param component The name of the component to get information about, e.g., 'syn-button'.
- * @param framework The framework to filter the component usage information by.
- * @returns The structured metadata for the specified component.
- */
-export const getInfoForComponent = async (component, framework = 'vanilla') => {
-    // Filter function to select specific files based on the framework
-    const namePatterns = [
-        'component.ts',
-        'component.styles.ts',
-        'component.custom.styles.ts',
-    ];
-    switch (framework) {
-        case 'react':
-            namePatterns.push('component.react.ts');
-            break;
-        case 'vue':
-            namePatterns.push('component.vue');
-            break;
-        case 'angular':
-            namePatterns.push('component.angular.ts');
-            break;
-        default:
-    }
-    const finalPattern = namePatterns.map(pattern => pattern.toLowerCase());
-    const data = await getStructuredMetaDataForComponent(component, fileName => finalPattern.some(pattern => fileName.toLowerCase().includes(pattern)));
-    const additionalData = await getAdditionalInformationForComponent(component);
-    return [
-        ...data,
-        ...additionalData,
-    ].filter(Boolean);
-};
-/**
- * Get a list of all available components in the Synergy Design System.
- * @returns A list of all available components in the Synergy Design System.
- */
-export const getAvailableComponents = async () => {
-    const absolutePath = getAbsolutePath(`${componentPath}`);
-    const folders = await fs.readdir(absolutePath, { withFileTypes: true });
-    const components = folders
-        .filter((dirent) => dirent.isDirectory())
-        .map((dirent) => dirent.name);
-    return components;
-};

package/dist/utilities/file.d.ts

@@ -1,12 +0,0 @@
-/**
- * Get the absolute path to the wanted file or directory, relative from the current one.
- * @param path - The relative path to the file or directory.
- * @returns The absolute path to the file or directory.
- */
-export declare const getAbsolutePath: (fileName?: string) => string;
-/**
- * Create a new directory.
- * @param dirName - The name of the directory to create, relative to the current file.
- * @returns The absolute path to the created directory.
- */
-export declare const createPath: (dirName: string) => Promise<string>;

package/dist/utilities/file.js

@@ -1,31 +0,0 @@
-import { fileURLToPath } from 'url';
-import path from 'path';
-import fs from 'fs/promises';
-/**
- * Get the absolute path to the wanted file or directory, relative from the current one.
- * @param path - The relative path to the file or directory.
- * @returns The absolute path to the file or directory.
- */
-export const getAbsolutePath = (fileName = '') => {
-    const filename = fileURLToPath(import.meta.url);
-    const dirname = path.dirname(filename);
-    return path.isAbsolute(fileName)
-        ? fileName
-        : path.resolve(dirname, fileName);
-};
-/**
- * Create a new directory.
- * @param dirName - The name of the directory to create, relative to the current file.
- * @returns The absolute path to the created directory.
- */
-export const createPath = async (dirName) => {
-    const absolutePath = getAbsolutePath(dirName);
-    try {
-        await fs.mkdir(absolutePath, { recursive: true });
-    }
-    catch (error) {
-        // eslint-disable-next-line no-console
-        console.error(`Failed to create directory at ${absolutePath}:`, error);
-    }
-    return absolutePath;
-};

package/dist/utilities/fonts.d.ts

@@ -1,2 +0,0 @@
-import { type Filter } from './metadata.js';
-export declare const getFontsMetaData: (filter?: Filter) => Promise<(import("./metadata.js").MetadataFile | null)[]>;

package/dist/utilities/fonts.js

@@ -1,3 +0,0 @@
-import { fontsPath, } from './config.js';
-import { getStructuredMetaData, } from './metadata.js';
-export const getFontsMetaData = async (filter) => getStructuredMetaData(fontsPath, filter);

package/dist/utilities/stdio.d.ts

@@ -1,14 +0,0 @@
-/**
- * Parses command line arguments and returns the action to take
- */
-export declare const parseCommandLineArgs: (args?: string[]) => {
-    action: "version";
-} | {
-    action: "help";
-} | {
-    action: "continue";
-};
-/**
- * Handles command line arguments and exits if necessary
- */
-export declare const handleCommandLineArgs: () => void;

package/dist/utilities/stdio.js

@@ -1,60 +0,0 @@
-import { getVersion } from './version.js';
-/**
- * Parses command line arguments and returns the action to take
- */
-export const parseCommandLineArgs = (args = process.argv.slice(2)) => {
-    if (args.includes('--version') || args.includes('-v')) {
-        return { action: 'version' };
-    }
-    if (args.includes('--help') || args.includes('-h')) {
-        return { action: 'help' };
-    }
-    return { action: 'continue' };
-};
-/**
- * Handles command line arguments and exits if necessary
- */
-export const handleCommandLineArgs = () => {
-    const result = parseCommandLineArgs();
-    if (result.action === 'version') {
-        const version = getVersion();
-        process.stdout.write(`Synergy Design System MCP Server v${version}\n`);
-        process.exit(0);
-    }
-    if (result.action === 'help') {
-        const version = getVersion();
-        process.stdout.write(`Synergy Design System MCP Server v${version}
-
-USAGE:
-    syn-mcp [OPTIONS]
-
-DESCRIPTION:
-    Model Context Protocol (MCP) server for the Synergy Design System.
-    Provides tools for LLMs to interact with Synergy components, design tokens,
-    styles, and framework-specific guidance.
-
-OPTIONS:
-    -h, --help       Show this help message and exit
-    -v, --version    Show version information and exit
-
-EXAMPLES:
-    syn-mcp                    # Start the MCP server
-    syn-mcp --version          # Show version
-    syn-mcp --help             # Show this help
-
-ABOUT:
-    This server provides the following tools for LLMs:
-    • Component information and documentation
-    • Framework-specific guidance (React, Vue, Angular, Vanilla)
-    • Design tokens and styling information
-    • Asset and icon information
-    • Migration guides from DaVinci to Synergy
-    • Template and pattern information
-
-    For more information, visit:
-    https://github.com/synergy-design-system/synergy-design-system
-
-`);
-        process.exit(0);
-    }
-};

package/dist/utilities/storybook/build-docs.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/utilities/storybook/build-docs.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-/* eslint-disable @typescript-eslint/no-misused-promises */
-import { runDocsScraper } from './docs-scraper.js';
-import { StaticServerManager } from './storybook-manager.js';
-// Parse command line arguments
-const args = process.argv.slice(2);
-const type = args[0] || 'all';
-console.log(`Starting documentation scraping for: ${type}`);
-const serverManager = new StaticServerManager();
-async function main() {
-    try {
-        // Start the static server
-        console.log('Starting static file server...');
-        const server = await serverManager.start();
-        // Run the docs scraper
-        console.log('Starting documentation scraping...');
-        await runDocsScraper(type, server.url);
-        console.log('Documentation scraping completed successfully!');
-        process.exit(0);
-    }
-    catch (error) {
-        console.error('Documentation scraping failed:', error);
-        process.exit(1);
-    }
-    finally {
-        // Always clean up the server
-        await serverManager.stop();
-        console.log('✓ Server stopped');
-    }
-}
-// Handle process termination to clean up server
-process.on('SIGINT', async () => {
-    console.log('\nReceived SIGINT, cleaning up...');
-    await serverManager.stop();
-    process.exit(0);
-});
-process.on('SIGTERM', async () => {
-    console.log('\nReceived SIGTERM, cleaning up...');
-    await serverManager.stop();
-    process.exit(0);
-});
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
-main();

package/dist/utilities/storybook/configs.d.ts

@@ -1,13 +0,0 @@
-import { ScrapingConfig } from './types.js';
-/**
- * Configuration for scraping component documentation
- */
-export declare const componentScrapingConfig: ScrapingConfig;
-/**
- * Configuration for scraping styles documentation
- */
-export declare const stylesScrapingConfig: ScrapingConfig;
-/**
- * Configuration for scraping template documentation
- */
-export declare const templateScrapingConfig: ScrapingConfig;