@synergy-design-system/mcp 0.1.0 → 1.0.0

package/dist/tools/component-list.js

@@ -0,0 +1,42 @@
+import { getAvailableComponents, getStructuredMetaData, } 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 componentListTool = (server) => {
+    server.registerTool('component-list', {
+        description: 'Outputs a list of all available components in the Synergy Design System',
+        inputSchema: {},
+        title: 'List Synergy Components',
+    }, async () => {
+        // Get the package data for components
+        try {
+            const components = await getAvailableComponents();
+            const componentNames = components.map(filename => `- ${filename}`);
+            const aiRules = await getStructuredMetaData('../../metadata/static/component-list');
+            return {
+                content: [
+                    {
+                        text: JSON.stringify(aiRules, null, 2),
+                        type: 'text',
+                    },
+                    {
+                        text: componentNames.join('\n'),
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        text: `Error fetching components: ${error.message}`,
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+    });
+};

package/dist/tools/davinci-migration.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare const davinciMigrateComponentList: (server: McpServer) => void;
+export declare const davinciMigrateComponentTool: (server: McpServer) => void;

package/dist/tools/davinci-migration.js

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+import { getStructuredMetaData, metaDataPath } from '../utilities/index.js';
+const data = getStructuredMetaData(`${metaDataPath}/davinci-migration`);
+export const davinciMigrateComponentList = (server) => {
+    server.registerTool('davinci-migrate-list', {
+        description: 'Get a list of all components that have migration information from DaVinci to Synergy.',
+        title: 'DaVinci Migration List',
+    }, async () => {
+        const metadata = await data; // Ensure metadata is loaded
+        if (!metadata || metadata.length === 0) {
+            return {
+                content: [
+                    {
+                        text: `No migration information found for components! Please ensure the metadata files are present in the ${metaDataPath}/davinci-migration directory.`,
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+        // Extract all h3 headings that start with 'davinci-'
+        const matches = Array.from(metadata.at(0).content.matchAll(/^### (davinci-[\w-]+)/gm)).map(match => `- ${match[1].replace('### ', '')}`);
+        return {
+            content: [
+                {
+                    text: `Migration information was found for the following components: ${matches.join(', ')}`,
+                    type: 'text',
+                },
+            ],
+        };
+    });
+};
+export const davinciMigrateComponentTool = (server) => {
+    server.registerTool('davinci-migrate-component', {
+        description: 'Get information about the migration of a specific component from DaVinci to Synergy.',
+        inputSchema: {
+            component: z.string().startsWith('davinci-').describe('The name of the davinci component to get migration information about.'),
+        },
+        title: 'DaVinci Migration Info',
+    }, async ({ component }) => {
+        const metadata = await data; // Ensure metadata is loaded
+        if (!metadata || metadata.length === 0) {
+            return {
+                content: [
+                    {
+                        text: `No migration information found for components! Please ensure the metadata files are present in the ${metaDataPath}/davinci-migration directory.`,
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+        // Only process the the parts of the migration guide we are interested in
+        const regex = new RegExp(`^### ${component.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&')}[\\s\\S]*?(?=^### |\\Z)`, 'm');
+        const match = metadata.at(0).content.match(regex);
+        const text = match
+            ? `Migration information for ${component}: ${match.at(0)}`
+            : `No migration information found for component ${component}. Here is some common migration information: ${JSON.stringify(metadata, null, 2)}`;
+        return {
+            content: [
+                {
+                    text,
+                    type: 'text',
+                },
+            ],
+        };
+    });
+};

package/dist/tools/framework-info.d.ts

@@ -0,0 +1,7 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.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 declare const frameworkInfoTool: (server: McpServer) => void;

package/dist/tools/framework-info.js

@@ -0,0 +1,59 @@
+/* eslint-disable complexity */
+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/index.d.ts

@@ -0,0 +1,13 @@
+export * from './asset-info.js';
+export * from './asset-list.js';
+export * from './component-info.js';
+export * from './component-list.js';
+export * from './davinci-migration.js';
+export * from './framework-info.js';
+export * from './migration-info.js';
+export * from './styles-info.js';
+export * from './styles-list.js';
+export * from './template-list.js';
+export * from './template-info.js';
+export * from './tokens.js';
+export * from './version.js';

package/dist/tools/index.js

@@ -0,0 +1,13 @@
+export * from './asset-info.js';
+export * from './asset-list.js';
+export * from './component-info.js';
+export * from './component-list.js';
+export * from './davinci-migration.js';
+export * from './framework-info.js';
+export * from './migration-info.js';
+export * from './styles-info.js';
+export * from './styles-list.js';
+export * from './template-list.js';
+export * from './template-info.js';
+export * from './tokens.js';
+export * from './version.js';

package/dist/tools/migration-info.d.ts

@@ -0,0 +1,6 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+/**
+ * Simple tool to list all available migration in the Synergy Design System.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export declare const migrationInfoTool: (server: McpServer) => void;

package/dist/tools/migration-info.js

@@ -0,0 +1,27 @@
+import { componentStaticPath, getMigrationMetaData, getStructuredMetaData, } from '../utilities/index.js';
+/**
+ * Simple tool to list all available migration in the Synergy Design System.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export const migrationInfoTool = (server) => {
+    server.registerTool('migration-info', {
+        description: 'Get information about migrations available in the Synergy Design System',
+        inputSchema: {},
+        title: 'Migration info',
+    }, async () => {
+        const metadata = await getMigrationMetaData();
+        const changelog = await getStructuredMetaData(componentStaticPath, fileName => fileName.toLowerCase().includes('changelog'));
+        return {
+            content: [
+                {
+                    text: JSON.stringify(metadata, null, 2),
+                    type: 'text',
+                },
+                {
+                    text: JSON.stringify(changelog, null, 2),
+                    type: 'text',
+                },
+            ],
+        };
+    });
+};

package/dist/tools/styles-info.d.ts

@@ -0,0 +1,7 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.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 declare const stylesInfoTool: (server: McpServer) => void;

package/dist/tools/styles-info.js

@@ -0,0 +1,28 @@
+import { getStructuredMetaData, getStylesMetaData, } 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 stylesInfoTool = (server) => {
+    server.registerTool('styles-info', {
+        description: 'Get information about css utilities available in the Synergy Design System',
+        inputSchema: {},
+        title: 'Styles info',
+    }, async () => {
+        const metadata = await getStylesMetaData();
+        const aiRules = await getStructuredMetaData('../../metadata/static/styles');
+        return {
+            content: [
+                {
+                    text: JSON.stringify(aiRules, null, 2),
+                    type: 'text',
+                },
+                {
+                    text: JSON.stringify(metadata, null, 2),
+                    type: 'text',
+                },
+            ],
+        };
+    });
+};

package/dist/tools/styles-list.d.ts

@@ -0,0 +1,7 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+/**
+ * Simple tool to list all available styles in the Synergy Design System.
+ * This tool fetches the styles data from the Synergy package and formats it for display.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export declare const stylesList: (server: McpServer) => void;

package/dist/tools/styles-list.js

@@ -0,0 +1,42 @@
+import { getAvailableStyles, getStructuredMetaData, } from '../utilities/index.js';
+/**
+ * Simple tool to list all available styles in the Synergy Design System.
+ * This tool fetches the styles data from the Synergy package and formats it for display.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export const stylesList = (server) => {
+    server.registerTool('styles-list', {
+        description: 'Outputs a list of available styles in the Synergy Design System',
+        inputSchema: {},
+        title: 'List Synergy Styles',
+    }, async () => {
+        // Get the package data for styles
+        try {
+            const styles = await getAvailableStyles();
+            const styleNames = styles.map(style => `- ${style}`);
+            const aiRules = await getStructuredMetaData('../../metadata/static/styles');
+            return {
+                content: [
+                    {
+                        text: JSON.stringify(aiRules, null, 2),
+                        type: 'text',
+                    },
+                    {
+                        text: styleNames.join('\n'),
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        text: `Error fetching components: ${error.message}`,
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+    });
+};

package/dist/tools/template-info.d.ts

@@ -0,0 +1,6 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+/**
+ * Simple tool to retrieve information about a given template in the Synergy Design System.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export declare const templateInfoTool: (server: McpServer) => void;

package/dist/tools/template-info.js

@@ -0,0 +1,34 @@
+/* eslint-disable complexity */
+import { z } from 'zod';
+import { getInfoForTemplate, getStructuredMetaData, } from '../utilities/index.js';
+/**
+ * Simple tool to retrieve information about a given template in the Synergy Design System.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export const templateInfoTool = (server) => {
+    server.registerTool('template-info', {
+        description: 'Get a specific template in the Synergy Design System',
+        inputSchema: {
+            template: z.string().describe('The name of the template to get information about.'),
+        },
+        title: 'Template info',
+    }, async ({ template, }) => {
+        const data = await getInfoForTemplate(template);
+        const text = data && data.length > 0
+            ? JSON.stringify(data, null, 2)
+            : `No metadata found for template ${template}`;
+        const aiRules = await getStructuredMetaData('../../metadata/static/templates', file => file === 'index.md');
+        return {
+            content: [
+                {
+                    text: JSON.stringify(aiRules, null, 2),
+                    type: 'text',
+                },
+                {
+                    text,
+                    type: 'text',
+                },
+            ],
+        };
+    });
+};

package/dist/tools/template-list.d.ts

@@ -0,0 +1,7 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+/**
+ * Simple tool to list all available templates in the Synergy Design System.
+ * This tool fetches the templates data from the Synergy package and formats it for display.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export declare const templateList: (server: McpServer) => void;

package/dist/tools/template-list.js

@@ -0,0 +1,42 @@
+import { getAvailableTemplates, getStructuredMetaData, } from '../utilities/index.js';
+/**
+ * Simple tool to list all available templates in the Synergy Design System.
+ * This tool fetches the templates data from the Synergy package and formats it for display.
+ * @param server - The MCP server instance to register the tool on.
+ */
+export const templateList = (server) => {
+    server.registerTool('template-list', {
+        description: 'Outputs a list of available static templates built with the Synergy Design System',
+        inputSchema: {},
+        title: 'List Synergy Templates',
+    }, async () => {
+        // Get the package data for templates
+        try {
+            const templates = await getAvailableTemplates();
+            const templateNames = templates.map(template => `- ${template}`);
+            const aiRules = await getStructuredMetaData('../../metadata/static/templates', file => file === 'index.md');
+            return {
+                content: [
+                    {
+                        text: JSON.stringify(aiRules, null, 2),
+                        type: 'text',
+                    },
+                    {
+                        text: templateNames.join('\n'),
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            return {
+                content: [
+                    {
+                        text: `Error fetching templates: ${error.message}`,
+                        type: 'text',
+                    },
+                ],
+            };
+        }
+    });
+};

package/dist/tools/tokens.d.ts

@@ -0,0 +1,7 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.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 declare const tokenInfoTool: (server: McpServer) => void;

package/dist/tools/tokens.js

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,51 @@
+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',
+    }, 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

@@ -0,0 +1 @@
+export declare const getAssetsMetaData: () => Promise<(import("./metadata.js").MetadataFile | null)[]>;

package/dist/utilities/assets.js

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

package/dist/utilities/checksum.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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>;