@czi-sds/mcp 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Chan Zuckerberg Initiative Foundation 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# SDS MCP Server
+
+An MCP server providing AI assistants with access to SDS components,
+examples, design tokens and migration patterns.
+
+## Features
+
+- **Component Library**: Get components, props, and usage examples
+- **Migration Support**: Upgrade guidance with before/after code
+  snippets
+- **Design Tokens**: Access semantic tokens and font styles for consistent
+  theming
+
+## Available Tools
+
+- `get_components` - List all Chakra UI components
+- `get_component_props` - Get component properties and configuration
+- `get_component_example` - Retrieve usage examples and code patterns
+- `get_theme` - Get theme tokens, semantic tokens, text styles and layer styles
+
+## Setup
+
+### Claude Desktop / Cursor
+
+```json
+{
+  "mcpServers": {
+    "sds-mcp": {
+      "command": "npx",
+      "args": ["-y", "@czi-sds/mcp"]
+    }
+  }
+}
+```

package/data/component-list.json

@@ -0,0 +1,55 @@
+{
+  "components": [
+    "Accordion",
+    "Alert",
+    "Autocomplete",
+    "Banner",
+    "Button",
+    "ButtonDropdown",
+    "ButtonIcon",
+    "ButtonToggle",
+    "Callout",
+    "CellBasic",
+    "CellComponent",
+    "CellHeader",
+    "Chip",
+    "ComplexFilter",
+    "ContentCard",
+    "Dialog",
+    "Dropdown",
+    "DropdownMenu",
+    "Icon",
+    "InputCheckbox",
+    "InputDropdown",
+    "InputRadio",
+    "InputSearch",
+    "InputSlider",
+    "InputText",
+    "InputToggle",
+    "Link",
+    "List",
+    "LoadingIndicator",
+    "Menu",
+    "MenuItem",
+    "MenuSelect",
+    "NavigationFooter",
+    "NavigationHeader",
+    "NavigationJumpTo",
+    "Notification",
+    "Pagination",
+    "Panel",
+    "SegmentedControl",
+    "Table",
+    "TableHeader",
+    "TableRow",
+    "Tabs",
+    "Tag",
+    "TagFilter",
+    "Tooltip",
+    "TooltipCondensed",
+    "TooltipTable"
+  ],
+  "data-viz": [
+    "HeatmapChart"
+  ]
+}

package/data/component-props/Accordion.json

@@ -0,0 +1,31 @@
+{
+  "Accordion": {
+    "props": {
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "The content of the component."
+      },
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLDivElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      }
+    }
+  }
+}

package/data/component-props/Alert.json

@@ -0,0 +1,52 @@
+{
+  "Alert": {
+    "props": {
+      "color": {
+        "type": "\"success\" | \"info\" | \"warning\" | \"error\"",
+        "isRequired": false,
+        "description": "The color of the component. Unless provided, the value is taken from the `severity` prop.\nIt supports both default and custom theme colors, which can be added as shown in the\n[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors)."
+      },
+      "icon": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "Override the icon displayed before the children.\nUnless provided, the icon is mapped to the value of the `severity` prop.\nSet to `false` to remove the `icon`."
+      },
+      "onClose": {
+        "type": "(event: SyntheticEvent<Element, Event>) => void",
+        "isRequired": false,
+        "description": "Callback fired when the component requests to be closed.\nWhen provided and no `action` prop is set, a close icon button is displayed that triggers the callback when clicked.\n@param event The event source of the callback."
+      },
+      "variant": {
+        "type": "\"standard\" | \"filled\" | \"outlined\"",
+        "isRequired": false,
+        "description": "The variant to use.",
+        "defaultValue": "standard"
+      },
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "The content of the component."
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLDivElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      }
+    }
+  }
+}

package/data/component-props/Autocomplete.json

@@ -0,0 +1,52 @@
+{
+  "Autocomplete": {
+    "props": {
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "Popper render function or node."
+      },
+      "open": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": true,
+        "description": "If `true`, the component is shown."
+      },
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLDivElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      },
+      "count": {
+        "type": "number",
+        "isRequired": false
+      },
+      "icon": {
+        "type": "ReactElement",
+        "isRequired": false
+      },
+      "search": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "width": {
+        "type": "number",
+        "isRequired": false
+      }
+    }
+  }
+}

package/data/component-props/Banner.json

@@ -0,0 +1,35 @@
+{
+  "Banner": {
+    "props": {
+      "icon": {
+        "type": "ReactElement",
+        "isRequired": false
+      },
+      "sdsIconProps": {
+        "type": "IconProps<string | number | symbol>",
+        "isRequired": false
+      },
+      "dismissed": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "dismissible": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "onClose": {
+        "type": "function",
+        "isRequired": false
+      },
+      "intent": {
+        "type": "\"info\" | \"negative\" | \"notice\" | \"positive\"",
+        "isRequired": false
+      },
+      "sdsType": {
+        "type": "\"primary\" | \"secondary\"",
+        "isRequired": true,
+        "description": "The type/variant of the component"
+      }
+    }
+  }
+}

package/data/component-props/Button.json

@@ -0,0 +1,109 @@
+{
+  "Button": {
+    "props": {
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "The content of the component.\nThe content of the component."
+      },
+      "disabled": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false,
+        "description": "If `true`, the component is disabled.",
+        "defaultValue": "false\nfalse"
+      },
+      "color": {
+        "type": "\"inherit\" | \"primary\" | \"secondary\" | \"success\" | \"error\" | \"info\" | \"warning\"",
+        "isRequired": false,
+        "description": "The color of the component.\nIt supports both default and custom theme colors, which can be added as shown in the\n[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).",
+        "defaultValue": "primary"
+      },
+      "fullWidth": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false,
+        "description": "If `true`, the button will take up the full width of its container.",
+        "defaultValue": false
+      },
+      "href": {
+        "type": "string",
+        "isRequired": false,
+        "description": "The URL to link to when the button is clicked.\nIf defined, an `a` element will be used as the root node."
+      },
+      "size": {
+        "type": "\"small\" | \"medium\" | \"large\"",
+        "isRequired": false,
+        "description": "The size of the component.\n`small` is equivalent to the dense button styling.",
+        "defaultValue": "medium"
+      },
+      "variant": {
+        "type": "\"text\" | \"outlined\" | \"contained\"",
+        "isRequired": false,
+        "description": "The variant to use.",
+        "defaultValue": "text"
+      },
+      "name": {
+        "type": "string",
+        "isRequired": false
+      },
+      "value": {
+        "type": "\"string\" | \"number\" | \"readonly string[]\"",
+        "isRequired": false
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLButtonElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      },
+      "sdsStyle": {
+        "type": "\"icon\" | \"minimal\" | \"rounded\" | \"square\"",
+        "isRequired": true,
+        "description": "The visual style variant of the component"
+      },
+      "sdsType": {
+        "type": "\"primary\" | \"secondary\" | \"tertiary\" | \"destructive\"",
+        "isRequired": false,
+        "description": "The type/variant of the component"
+      },
+      "sdsSize": {
+        "type": "\"small\" | \"medium\" | \"large\"",
+        "isRequired": false,
+        "description": "The size of the component"
+      },
+      "icon": {
+        "type": "ReactElement",
+        "isRequired": true
+      },
+      "sdsIconProps": {
+        "type": "Partial<IconProps<keyof IconNameToSizes>>",
+        "isRequired": false
+      },
+      "isAllCaps": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "target": {
+        "type": "\"string & {}\" | \"_self\" | \"_blank\" | \"_parent\" | \"_top\"",
+        "isRequired": false
+      },
+      "isRounded": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      }
+    }
+  }
+}

package/data/component-props/ButtonIcon.json

@@ -0,0 +1,80 @@
+{
+  "ButtonIcon": {
+    "props": {
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "The icon to display.\nThe content of the component."
+      },
+      "disabled": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false,
+        "description": "If `true`, the component is disabled.",
+        "defaultValue": "false\nfalse"
+      },
+      "color": {
+        "type": "\"inherit\" | \"default\" | \"primary\" | \"secondary\" | \"error\" | \"info\" | \"success\" | \"warning\"",
+        "isRequired": false,
+        "description": "The color of the component.\nIt supports both default and custom theme colors, which can be added as shown in the\n[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).",
+        "defaultValue": "default"
+      },
+      "size": {
+        "type": "\"small\" | \"medium\" | \"large\"",
+        "isRequired": false,
+        "description": "The size of the component.\n`small` is equivalent to the dense button styling.",
+        "defaultValue": "medium"
+      },
+      "name": {
+        "type": "string",
+        "isRequired": false
+      },
+      "value": {
+        "type": "\"string\" | \"number\" | \"readonly string[]\"",
+        "isRequired": false
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLButtonElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      },
+      "sdsSize": {
+        "type": "\"small\" | \"medium\" | \"large\"",
+        "isRequired": false,
+        "description": "The size of the component"
+      },
+      "sdsType": {
+        "type": "\"primary\" | \"secondary\" | \"tertiary\"",
+        "isRequired": false,
+        "description": "The type/variant of the component"
+      },
+      "icon": {
+        "type": "ReactElement",
+        "isRequired": true
+      },
+      "sdsIcon": {
+        "type": "ReactElement",
+        "isRequired": false,
+        "description": "@deprecated (masoudmanson): This prop is deprecated and will be removed in the next major version.\nPlease use `icon` instead."
+      },
+      "sdsIconProps": {
+        "type": "IconProps<string | number | symbol>",
+        "isRequired": false
+      }
+    }
+  }
+}

package/data/component-props/ButtonToggle.json

@@ -0,0 +1,91 @@
+{
+  "ButtonToggle": {
+    "props": {
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "The content of the component."
+      },
+      "disabled": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false,
+        "description": "If `true`, the component is disabled."
+      },
+      "color": {
+        "type": "\"inherit\" | \"primary\" | \"secondary\" | \"success\" | \"error\" | \"info\" | \"warning\"",
+        "isRequired": false,
+        "description": "The color of the component.\nIt supports both default and custom theme colors, which can be added as shown in the\n[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).",
+        "defaultValue": "primary"
+      },
+      "fullWidth": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false,
+        "description": "If `true`, the button will take up the full width of its container.",
+        "defaultValue": false
+      },
+      "href": {
+        "type": "string",
+        "isRequired": false,
+        "description": "The URL to link to when the button is clicked.\nIf defined, an `a` element will be used as the root node."
+      },
+      "size": {
+        "type": "\"small\" | \"medium\" | \"large\"",
+        "isRequired": false,
+        "description": "The size of the component.\n`small` is equivalent to the dense button styling.",
+        "defaultValue": "medium"
+      },
+      "variant": {
+        "type": "\"text\" | \"outlined\" | \"contained\"",
+        "isRequired": false,
+        "description": "The variant to use.",
+        "defaultValue": "text"
+      },
+      "name": {
+        "type": "string",
+        "isRequired": false
+      },
+      "value": {
+        "type": "\"string\" | \"number\" | \"readonly string[]\"",
+        "isRequired": false
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLButtonElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      },
+      "icon": {
+        "type": "ReactElement",
+        "isRequired": true
+      },
+      "sdsSize": {
+        "type": "\"small\" | \"medium\" | \"large\"",
+        "isRequired": false,
+        "description": "The size of the component"
+      },
+      "sdsStage": {
+        "type": "\"off\" | \"on\"",
+        "isRequired": false
+      },
+      "sdsType": {
+        "type": "\"primary\" | \"secondary\"",
+        "isRequired": false,
+        "description": "The type/variant of the component"
+      }
+    }
+  }
+}

package/data/component-props/Callout.json

@@ -0,0 +1,93 @@
+{
+  "Callout": {
+    "props": {
+      "className": {
+        "type": "string",
+        "isRequired": false
+      },
+      "style": {
+        "type": "CSSProperties",
+        "isRequired": false
+      },
+      "children": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "The content of the component."
+      },
+      "variant": {
+        "type": "\"standard\" | \"filled\" | \"outlined\"",
+        "isRequired": false,
+        "description": "The variant to use.",
+        "defaultValue": "standard"
+      },
+      "id": {
+        "type": "string",
+        "isRequired": false
+      },
+      "color": {
+        "type": "\"success\" | \"info\" | \"warning\" | \"error\"",
+        "isRequired": false,
+        "description": "The color of the component. Unless provided, the value is taken from the `severity` prop.\nIt supports both default and custom theme colors, which can be added as shown in the\n[palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors)."
+      },
+      "onChange": {
+        "type": "FormEventHandler<HTMLDivElement>",
+        "isRequired": false
+      },
+      "onClick": {
+        "type": "function",
+        "isRequired": false
+      },
+      "icon": {
+        "type": "ReactNode",
+        "isRequired": false,
+        "description": "Override the icon displayed before the children.\nUnless provided, the icon is mapped to the value of the `severity` prop.\nSet to `false` to remove the `icon`."
+      },
+      "onClose": {
+        "type": "(event: SyntheticEvent<Element, Event>) => void",
+        "isRequired": false,
+        "description": "Callback fired when the component requests to be closed.\nWhen provided and no `action` prop is set, a close icon button is displayed that triggers the callback when clicked.\n@param event The event source of the callback."
+      },
+      "autoDismiss": {
+        "type": "\"number\" | \"false\" | \"true\"",
+        "isRequired": false
+      },
+      "dismissed": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "sdsIconProps": {
+        "type": "IconProps<string | number | symbol>",
+        "isRequired": false
+      },
+      "intent": {
+        "type": "\"info\" | \"negative\" | \"notice\" | \"positive\"",
+        "isRequired": true
+      },
+      "sdsStage": {
+        "type": "\"closed\" | \"open\"",
+        "isRequired": false
+      },
+      "hideTitle": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "body": {
+        "type": "ReactNode",
+        "isRequired": false
+      },
+      "hideBody": {
+        "type": "\"false\" | \"true\"",
+        "isRequired": false
+      },
+      "extraContent": {
+        "type": "ReactNode",
+        "isRequired": false
+      },
+      "sdsStyle": {
+        "type": "\"persistent\" | \"expandable\" | \"dismissible\"",
+        "isRequired": false,
+        "description": "The visual style variant of the component"
+      }
+    }
+  }
+}