@splunk/splunk-ui-mcp 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,54 @@
+# @splunk/splunk-ui-mcp
+
+A Model Context Protocol (MCP) server that gives AI assistants Splunk UI Design System documentation, including:
+- Version requirements for building with Splunk UI packages
+- Component documentation and usage guidance
+- Design pattern best practices
+- Icon search and metadata
+
+## Requirements
+
+- Node.js 22 or newer
+- An MCP-compatible client (VS Code, Cursor, Windsurf, Claude Desktop, Goose, etc.)
+- Access to @splunk/react-ui and @splunk/react-icons (used for component docs and icon metadata)
+
+## Install and configure
+
+Use `npx` in your MCP client configuration (works in most tools):
+
+```js
+{
+  "mcpServers": {
+    "splunk-ui": {
+      "command": "npx",
+      "args": ["@splunk/splunk-ui-mcp@latest"]
+    }
+  }
+}
+```
+
+To pin a version, replace `@latest` with the desired version.
+
+## Reference (tools and resources)
+
+If you need the underlying tool or resource names (for debugging or client integrations), use the list below.
+
+### Tools
+
+- `get_component_docs`: Retrieve full docs for a `@splunk/react-ui` component.
+- `find_icons`: Search `@splunk/react-icons` and return a recommended icon plus alternatives.
+- `list_splunk_ui_requirements`: Return version requirements and peer dependencies.
+
+### Resources
+
+**Component documentation**
+
+```
+mcp://splunk-ui/components/{componentName}
+```
+
+**Icon catalog**
+
+```
+mcp://splunk-ui/icons/{iconName}
+```

package/lib/constants/versions.d.ts

@@ -0,0 +1,9 @@
+declare const VERSIONS: {
+    "@splunk/react-ui": string;
+    react: string;
+    "react-dom": string;
+    "styled-components": string;
+    "@splunk/themes": string;
+    "@splunk/react-icons": string;
+};
+export default VERSIONS;

package/lib/constants/versions.js

@@ -0,0 +1,12 @@
+/* eslint-disable quotes, comma-dangle, quote-props */
+// This file contains version information that gets injected at build time
+// DO NOT EDIT MANUALLY - this file is auto-generated during build
+const VERSIONS = {
+    "@splunk/react-ui": "5.8.0",
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "styled-components": "^5.3.10",
+    "@splunk/themes": "1.5.0",
+    "@splunk/react-icons": "5.8.0"
+};
+export default VERSIONS;

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import requirements from "./tools/requirements.js";
+import findIcons from "./tools/find_icons.js";
+import getComponentDocs from "./tools/get_component_docs.js";
+import iconResource from "./resources/icons.js";
+import componentResource from "./resources/components.js";
+// prettier-ignore
+import packageJson from '../package.json' with { type: 'json' };
+// Create an MCP server
+const server = new McpServer({
+    name: packageJson.name,
+    version: packageJson.version,
+}, {
+    capabilities: {
+        resources: {},
+        logging: {},
+    },
+});
+// Register all tools
+const tools = [requirements, findIcons, getComponentDocs];
+tools.forEach((tool) => {
+    server.registerTool(tool.name, tool.config, tool.handler);
+});
+const resources = [iconResource, componentResource];
+resources.forEach((resource) => {
+    server.registerResource(resource.name, resource.template, resource.config, resource.handler);
+});
+async function main() {
+    try {
+        const transport = new StdioServerTransport();
+        await server.connect(transport);
+        // eslint-disable-next-line no-console
+        console.error('Server started and listening on stdio');
+    }
+    catch (error) {
+        // eslint-disable-next-line no-console
+        console.error('Failed to start server:', error);
+        process.exit(1);
+    }
+}
+main();

package/lib/resources/components.d.ts

@@ -0,0 +1,26 @@
+import { ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { ResourceLink, ReadResourceResult } from '@modelcontextprotocol/sdk/types.js';
+export declare const COMPONENT_RESOURCE_NAME = "splunk-ui-components";
+export declare const COMPONENT_RESOURCE_URI_BASE = "mcp://splunk-ui/components";
+/**
+ * Creates an MCP resource URI for a component
+ */
+export declare const createComponentResourceUri: (componentName: string) => string;
+/**
+ * Creates a resource link for a component
+ */
+export declare const createComponentResourceLink: (componentName: string) => ResourceLink;
+/**
+ * MCP resource for component documentation
+ */
+declare const componentResource: {
+    name: string;
+    template: ResourceTemplate;
+    config: {
+        title: string;
+        description: string;
+        mimeType: string;
+    };
+    handler: (uri: URL, params: Record<string, unknown>) => ReadResourceResult;
+};
+export default componentResource;

package/lib/resources/components.js

@@ -0,0 +1,133 @@
+import { ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { filterByKeywords } from '@splunk/ui-utils/filter.js';
+import { getComponentList, getComponentDocs, getComponentInfo, } from "../utils/component-catalog.js";
+export const COMPONENT_RESOURCE_NAME = 'splunk-ui-components';
+export const COMPONENT_RESOURCE_URI_BASE = 'mcp://splunk-ui/components';
+/**
+ * Creates an MCP resource URI for a component
+ */
+export const createComponentResourceUri = (componentName) => `${COMPONENT_RESOURCE_URI_BASE}/${encodeURIComponent(componentName)}`;
+/**
+ * Creates resource metadata for a component
+ */
+const createComponentResourceMetadata = (component) => ({
+    name: component.name,
+    title: component.name,
+    uri: createComponentResourceUri(component.name),
+    description: component.category ? `${component.category} component` : undefined,
+    mimeType: 'text/markdown',
+});
+/**
+ * Creates a resource link for a component
+ */
+export const createComponentResourceLink = (componentName) => {
+    const componentInfo = getComponentInfo(componentName);
+    let metadata;
+    // If the component is unknown, fall back to minimal metadata so a resource link can still be created.
+    if (!componentInfo) {
+        metadata = {
+            name: componentName,
+            title: componentName,
+            // Use the requested name so the read handler emits the unknown-component error path.
+            uri: createComponentResourceUri(componentName),
+            description: undefined,
+            mimeType: 'text/markdown',
+        };
+    }
+    else {
+        metadata = createComponentResourceMetadata(componentInfo);
+    }
+    return {
+        type: 'resource_link',
+        ...metadata,
+    };
+};
+/**
+ * Lists all available component resources
+ */
+const createListResult = () => ({
+    resources: getComponentList().map(createComponentResourceMetadata),
+});
+/**
+ * Reads the documentation for a specific component
+ */
+const readComponentResource = (componentName) => {
+    const componentInfo = getComponentInfo(componentName);
+    if (!componentInfo) {
+        throw new Error(`Unknown component "${componentName}"`);
+    }
+    const uri = createComponentResourceUri(componentInfo.name);
+    const docs = getComponentDocs(componentInfo.name);
+    return {
+        contents: [
+            {
+                uri,
+                mimeType: 'text/markdown',
+                text: docs,
+            },
+        ],
+    };
+};
+/**
+ * Resource template for component documentation
+ */
+const componentResourceTemplate = new ResourceTemplate(`${COMPONENT_RESOURCE_URI_BASE}/{componentName}`, {
+    list: async () => createListResult(),
+    complete: {
+        componentName: async (value) => {
+            const input = value?.toString() ?? '';
+            // Return all component names if no input is provided
+            if (!input) {
+                return getComponentList().map((component) => component.name);
+            }
+            const componentNames = getComponentList().map((component) => component.name);
+            return filterByKeywords(componentNames, input);
+        },
+    },
+});
+/**
+ * MCP resource for component documentation
+ */
+const componentResource = {
+    name: COMPONENT_RESOURCE_NAME,
+    template: componentResourceTemplate,
+    config: {
+        title: 'Splunk UI Component Documentation',
+        description: 'Documentation and usage guidance for components from @splunk/react-ui.',
+        mimeType: 'text/markdown',
+    },
+    handler: (uri, params) => {
+        const { componentName: componentNameParam } = params;
+        // Prefer the componentName param, but fall back to extracting from the path.
+        let componentName;
+        if (typeof componentNameParam === 'string' && componentNameParam.length > 0) {
+            componentName = componentNameParam;
+        }
+        else {
+            // Extract from path, but exclude 'components' itself
+            const pathParts = uri.pathname.split('/').filter(Boolean);
+            // Get the last part that isn't 'components'
+            const encodedComponentName = pathParts[pathParts.length - 1];
+            if (encodedComponentName === 'components') {
+                componentName = undefined;
+            }
+            else if (encodedComponentName) {
+                try {
+                    componentName = decodeURIComponent(encodedComponentName);
+                }
+                catch {
+                    throw new Error(`Invalid component name in resource path: ${encodedComponentName}`);
+                }
+            }
+        }
+        if (!componentName) {
+            throw new Error(`Component name missing in resource request: ${uri.toString()}`);
+        }
+        return readComponentResource(componentName);
+    },
+};
+export default componentResource;
+// TODO: Future enhancement - add section extraction helpers
+// These would allow returning specific sections of the markdown
+// Example:
+// export function getComponentSection(componentName: string, sectionName: string): string

package/lib/resources/icons.d.ts

@@ -0,0 +1,30 @@
+import { ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
+import type { ResourceLink, ReadResourceResult } from '@modelcontextprotocol/sdk/types.js';
+import iconCatalog from '@splunk/react-icons/icon-catalog.json';
+export declare const ICON_RESOURCE_NAME = "splunk-ui-icons";
+export declare const ICON_RESOURCE_URI_BASE = "mcp://splunk-ui/icons";
+type IconCatalogEntry = (typeof iconCatalog)[number];
+export type IconResourceDetails = {
+    name: string;
+    importPath: string;
+    category?: string;
+    description?: string;
+    keywords?: string;
+    variants?: string[];
+    usageExample: string;
+};
+export declare const createIconResourceUri: (iconName: string) => string;
+export declare function getIconResourceDetails(icon: IconCatalogEntry): IconResourceDetails;
+export declare function getIconResourceDetails(iconName: string): IconResourceDetails | undefined;
+export declare const createIconResourceLink: (iconName: string) => ResourceLink;
+declare const iconResource: {
+    name: string;
+    template: ResourceTemplate;
+    config: {
+        title: string;
+        description: string;
+        mimeType: string;
+    };
+    handler: (uri: URL, params: Record<string, unknown>) => ReadResourceResult;
+};
+export default iconResource;

package/lib/resources/icons.js

@@ -0,0 +1,123 @@
+import { ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
+import iconCatalog from '@splunk/react-icons/icon-catalog.json' with { type: 'json' };
+export const ICON_RESOURCE_NAME = 'splunk-ui-icons';
+export const ICON_RESOURCE_URI_BASE = 'mcp://splunk-ui/icons';
+const iconByName = new Map(iconCatalog.map((icon) => [icon.name, icon]));
+const buildUsageExample = (iconName) => [
+    '```tsx',
+    "import type { ComponentProps } from 'react';",
+    `import ${iconName} from '@splunk/react-icons/${iconName}';`,
+    '',
+    `type ${iconName}Props = ComponentProps<typeof ${iconName}>;`,
+    '',
+    `const Example = (props: ${iconName}Props) => (`,
+    `    <${iconName} width={16} height={16} {...props} />`,
+    ');',
+    '```',
+].join('\n');
+const describeIcon = (icon) => {
+    const description = icon.description?.trim();
+    if (description) {
+        return description;
+    }
+    const keywords = icon.keywords?.trim();
+    if (keywords) {
+        return `Keywords: ${keywords}`;
+    }
+    return undefined;
+};
+export const createIconResourceUri = (iconName) => `${ICON_RESOURCE_URI_BASE}/${encodeURIComponent(iconName)}`;
+const createIconResourceMetadata = (icon) => ({
+    name: icon.name,
+    title: icon.name,
+    uri: createIconResourceUri(icon.name),
+    description: describeIcon(icon),
+    mimeType: 'application/json',
+});
+export function getIconResourceDetails(iconOrName) {
+    const icon = typeof iconOrName === 'string' ? iconByName.get(iconOrName) : iconOrName;
+    if (!icon) {
+        return undefined;
+    }
+    return {
+        ...icon,
+        importPath: `@splunk/react-icons/${icon.name}`,
+        usageExample: buildUsageExample(icon.name),
+    };
+}
+export const createIconResourceLink = (iconName) => {
+    const icon = iconByName.get(iconName);
+    let metadata;
+    // If the icon is unknown, fall back to minimal metadata so a resource link can still be created.
+    if (!icon) {
+        metadata = {
+            name: iconName,
+            title: iconName,
+            // Use the requested name so the read handler emits the unknown-icon error path.
+            uri: createIconResourceUri(iconName),
+            description: undefined,
+            mimeType: 'application/json',
+        };
+    }
+    else {
+        metadata = createIconResourceMetadata(icon);
+    }
+    return {
+        type: 'resource_link',
+        ...metadata,
+    };
+};
+const createListResult = () => ({
+    resources: iconCatalog.map(createIconResourceMetadata),
+});
+const readIconResource = (iconName) => {
+    const icon = iconByName.get(iconName);
+    if (!icon) {
+        throw new Error(`Unknown icon "${iconName}"`);
+    }
+    const uri = createIconResourceUri(icon.name);
+    const details = getIconResourceDetails(icon);
+    return {
+        contents: [
+            {
+                uri,
+                mimeType: 'application/json',
+                text: `${JSON.stringify(details, null, 2)}\n`,
+            },
+        ],
+    };
+};
+const iconResourceTemplate = new ResourceTemplate(`${ICON_RESOURCE_URI_BASE}/{iconName}`, {
+    list: async () => createListResult(),
+    complete: {
+        iconName: async (value) => {
+            const input = value?.toString().toLowerCase() ?? '';
+            const matches = iconCatalog
+                .map((icon) => icon.name)
+                .filter((name) => name.toLowerCase().startsWith(input));
+            // Limit to 50 matches to avoid returning too many results when autocompleting.
+            return matches.slice(0, 50);
+        },
+    },
+});
+const iconResource = {
+    name: ICON_RESOURCE_NAME,
+    template: iconResourceTemplate,
+    config: {
+        title: 'Splunk UI Icon Catalog',
+        description: 'Metadata and usage guidance for icons from @splunk/react-icons.',
+        mimeType: 'application/json',
+    },
+    handler: (uri, params) => {
+        const { iconName: iconNameParam } = params;
+        // Prefer the iconName param, but fall back to extracting from the path.
+        const iconName = typeof iconNameParam === 'string' && iconNameParam.length > 0
+            ? iconNameParam
+            : uri.pathname.split('/').filter(Boolean).pop();
+        if (!iconName) {
+            throw new Error(`Icon name missing in resource request: ${uri.toString()}`);
+        }
+        return readIconResource(iconName);
+    },
+};
+export default iconResource;

package/lib/resources/tests/components.unit.d.ts

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