Design system operations
20 operations named designSystem.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| designSystem.promoteVariant | Promote authored component overrides to a reusable variant and reattach the node. | designSystem.promote | none |
| designSystem.setToken | Write one token ({ set, path, type, value }), under the AA contrast gate and the token group rules. | designSystem.operation | none |
| designSystem.setTokens | Write many tokens as one change, gated once for AA contrast on the end state, so one undo restores the lot. | designSystem.operation | none |
| designSystem.setComponentCell | Design-system setComponentCell, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.createVariant | Design-system createVariant, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.createTheme | Design-system createTheme, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.activateSet | Design-system activateSet, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.setScheme | Design-system setScheme, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.resetToBlueprint | Design-system resetToBlueprint, using the same validation and access gates as the editor. | designSystem.operation | destructive |
| designSystem.importTokens | Design-system importTokens, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.diff | Read every override the draft holds over its blueprint (tokens, cells, variants, themes, sets, mixins). | designSystem.operation | none |
| designSystem.lint | Check the draft design system: every contrast pair below AA or AAA, the pairs that cannot be judged, the missing media assets and the lint rules' findings, with the draft's overrides. | designSystem.operation | none |
| designSystem.createSet | Design-system createSet, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.updateTheme | Design-system updateTheme, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.updateVariant | Design-system updateVariant, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.deleteVariant | Design-system deleteVariant, using the same validation and access gates as the editor. | designSystem.operation | destructive |
| designSystem.setMixin | Design-system setMixin, using the same validation and access gates as the editor. | designSystem.operation | none |
| designSystem.deleteMixin | Design-system deleteMixin, using the same validation and access gates as the editor. | designSystem.operation | destructive |
| designSystem.read | Read the draft design system's index: its revision, sets, themes, every component with its variant keys, and every token group with its number of paths. | designSystem.operation | none |
| designSystem.readComponent | Read the cells of one design-system component, filtered and paged: variant, size, state, part, breakpoint and property keep the cells whose key segment equals them (a cell key is <variant>.<size>.<state>.<part>.<breakpoint>.<property>), and own: true keeps only the cells set at their own key, leaving out the inherited ones. | designSystem.operation | none |
designSystem.promoteVariant
Promote authored component overrides to a reusable variant and reattach the node.
permission: designSystem.promotewrites: designSystem, tree:{pageId}class: transactionundo: yes
Example input
{
"pageId": "6f1d2c3b-4a59-4e8d-9c7b-1a2b3c4d5e6f",
"nodeId": "claim001",
"variant": "claim",
"label": "Claim"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| pageId | string | yes | At least 1 character. |
| nodeId | string | yes | |
| variant | string | yes | |
| label | string | yes | At least 1 character. At most 120 characters. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.promoteVariant '{"pageId":"6f1d2c3b-4a59-4e8d-9c7b-1a2b3c4d5e6f","nodeId":"claim001","variant":"claim","label":"Claim"}' --dry-rundesignSystem.setToken
Write one token ({ set, path, type, value }), under the AA contrast gate and the token group rules. To scale spacing, write a scale factor instead of every step: a number token named scale in a space group multiplies every dimension of that group and its subgroups (space.section-y.scale: 0.75 makes every section spacing 25 % tighter, space.scale scales all spacing; above 0).
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"set": "core",
"path": "radius.md",
"type": "dimension",
"value": "9px"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| set | string | yes | At least 1 character. |
| path | string | yes | At least 1 character. |
| type | string | yes | At least 1 character. |
| value | value | yes | |
| description | string | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.setToken '{"set":"core","path":"radius.md","type":"dimension","value":"9px"}' --dry-rundesignSystem.setTokens
Write many tokens as one change, gated once for AA contrast on the end state, so one undo restores the lot. To scale spacing, write a scale factor instead of every step: a number token named scale in a space group multiplies every dimension of that group and its subgroups (space.section-y.scale: 0.75 makes every section spacing 25 % tighter, space.scale scales all spacing; above 0).
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"writes": [
{
"set": "core",
"path": "color.palette.neutral.900",
"type": "color",
"value": "#4a4a4a"
},
{
"set": "semantic-dark",
"path": "color.text.faint",
"type": "color",
"value": "rgba(255, 255, 255, 0.7)"
}
]
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| writes | array of object | yes | At least 1 item. |
| writes[].layer | string | no | One of "site", "blueprint". |
| writes[].set | string | yes | At least 1 character. |
| writes[].path | string | yes | At least 1 character. |
| writes[].type | string | yes | At least 1 character. |
| writes[].value | value | yes | |
| writes[].description | string | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.setTokens '{"writes":[{"set":"core","path":"color.palette.neutral.900","type":"color","value":"#4a4a4a"},{"set":"semantic-dark","path":"color.text.faint","type":"color","value":"rgba(255, 255, 255, 0.7)"}]}' --dry-rundesignSystem.setComponentCell
Design-system setComponentCell, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"component": "button",
"cells": [
{
"cell": "primary.all.hover.container.base.background",
"value": "{color.bg.accent-strong}"
}
]
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| component | string | yes | At least 1 character. |
| cells | array of object | yes | At least 1 item. |
| cells[].cell | string | yes | At least 1 character. |
| cells[].value | string | object | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.setComponentCell '{"component":"button","cells":[{"cell":"primary.all.hover.container.base.background","value":"{color.bg.accent-strong}"}]}' --dry-rundesignSystem.createVariant
Design-system createVariant, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"component": "button",
"variant": "ghost",
"label": "Ghost",
"from": "primary"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| component | string | yes | At least 1 character. |
| variant | string | yes | At least 1 character. |
| label | string | yes | At least 1 character. |
| from | string | yes | At least 1 character. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.createVariant '{"component":"button","variant":"ghost","label":"Ghost","from":"primary"}' --dry-rundesignSystem.createTheme
Design-system createTheme, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"key": "night",
"label": "Night",
"sets": [
"core",
"semantic-dark"
]
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| key | string | yes | At least 1 character. |
| label | string | yes | At least 1 character. |
| sets | array of string | yes | At least 1 item. |
| activation | object | no | |
| activation.prefersColorScheme | string | no | One of "light", "dark". |
| activation.hostname | string | no | |
| activation.pathPrefix | string | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.createTheme '{"key":"night","label":"Night","sets":["core","semantic-dark"]}' --dry-rundesignSystem.activateSet
Design-system activateSet, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"theme": "night",
"set": "semantic-dark"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| theme | string | yes | At least 1 character. |
| set | string | yes | At least 1 character. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.activateSet '{"theme":"night","set":"semantic-dark"}' --dry-rundesignSystem.setScheme
Design-system setScheme, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: tree:{pageId}class: transactionundo: yes
Example input
{
"pageId": "6f1d2c3b-4a59-4e8d-9c7b-1a2b3c4d5e6f",
"nodeId": "claim001",
"theme": "night"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| pageId | string | yes | At least 1 character. |
| nodeId | string | yes | |
| theme | string | null | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.setScheme '{"pageId":"6f1d2c3b-4a59-4e8d-9c7b-1a2b3c4d5e6f","nodeId":"claim001","theme":"night"}' --dry-rundesignSystem.resetToBlueprint
Design-system resetToBlueprint, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionconfirm: destructiveundo: yes
Example input
{
"scope": {
"kind": "prefix",
"prefix": "color.brand"
}
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| scope | object | object | object | object | object | object | object | object | object | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.
designSystem.importTokens
Design-system importTokens, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"format": "dtcg",
"files": [
{
"name": "tokens.json",
"text": "{\"color\":{\"brand\":{\"$type\":\"color\",\"$value\":\"#1e3d4f\"}}}"
}
]
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| format | string | yes | One of "dtcg", "figma". |
| files | array of object | object | yes | At least 1 item. |
| mapping | record of string | no | Default {}. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.importTokens '{"format":"dtcg","files":[{"name":"tokens.json","text":"{\"color\":{\"brand\":{\"$type\":\"color\",\"$value\":\"#1e3d4f\"}}}"}]}' --dry-rundesignSystem.diff
Read every override the draft holds over its blueprint (tokens, cells, variants, themes, sets, mixins). Over MCP it answers a summary (their count and names, the stylesheet's size); pass full: true for every override with its blueprint and site values, and the stylesheet.
permission: designSystem.operationreads onlyclass: read
Example input
{}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| full | boolean | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.diff '{}' --dry-rundesignSystem.lint
Check the draft design system: every contrast pair below AA or AAA, the pairs that cannot be judged, the missing media assets and the lint rules' findings, with the draft's overrides. Over MCP it answers a summary (counts by severity and reason, the worst findings first, the override names, the stylesheet's size); pass full: true for every finding, every override and the stylesheet.
permission: designSystem.operationreads onlyclass: read
Example input
{}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| full | boolean | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.lint '{}' --dry-rundesignSystem.createSet
Design-system createSet, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"key": "brand-sub",
"label": "Sub-brand",
"after": "semantic-light"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| key | string | yes | At least 1 character. |
| label | string | yes | At least 1 character. |
| after | string | yes | At least 1 character. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.createSet '{"key":"brand-sub","label":"Sub-brand","after":"semantic-light"}' --dry-rundesignSystem.updateTheme
Design-system updateTheme, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"key": "night",
"label": "Night",
"isDefault": false
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| key | string | yes | At least 1 character. |
| label | string | no | At least 1 character. |
| sets | array of string | no | At least 1 item. |
| isDefault | boolean | no | |
| draft | boolean | no | |
| activation | object | no | |
| activation.prefersColorScheme | string | no | One of "light", "dark". |
| activation.hostname | string | no | |
| activation.pathPrefix | string | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.updateTheme '{"key":"night","label":"Night","isDefault":false}' --dry-rundesignSystem.updateVariant
Design-system updateVariant, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"component": "button",
"variant": "ghost",
"label": "Ghost, quiet"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| component | string | yes | At least 1 character. |
| variant | string | yes | At least 1 character. |
| label | string | no | At least 1 character. |
| hidden | boolean | no |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.updateVariant '{"component":"button","variant":"ghost","label":"Ghost, quiet"}' --dry-rundesignSystem.deleteVariant
Design-system deleteVariant, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionconfirm: destructiveundo: yes
Example input
{
"component": "button",
"variant": "ghost"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| component | string | yes | At least 1 character. |
| variant | string | yes | At least 1 character. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.
designSystem.setMixin
Design-system setMixin, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionundo: yes
Example input
{
"key": "band",
"label": "Band",
"sheet": {
"padding-block": "{space.md}",
"border-top": "1px solid {color.border.default}"
}
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| key | string | yes | |
| label | string | yes | At least 1 character. |
| sheet | record of string | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.setMixin '{"key":"band","label":"Band","sheet":{"padding-block":"{space.md}","border-top":"1px solid {color.border.default}"}}' --dry-rundesignSystem.deleteMixin
Design-system deleteMixin, using the same validation and access gates as the editor.
permission: designSystem.operationwrites: designSystemclass: transactionconfirm: destructiveundo: yes
Example input
{
"key": "band"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| layer | string | no | One of "site", "blueprint". |
| key | string | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| tree | object | no | |
| tree.pageId | string | yes | |
| tree.revision | integer | yes | |
| tree.inverse | array of object | object | object | object | object | object | object | object | object | object | object | object | object | yes | |
| findings | array of object | object | object | object | object | yes | |
| diff | array of object | object | object | object | object | object | yes | |
| changes | array of object | no | |
| changes[].change | string | yes | One of "added", "changed", "removed". |
| changes[].override | object | object | object | object | object | object | yes | |
| changed | boolean | yes | |
| revision | integer | yes | |
| dryRun | boolean | yes | |
| css | string | null | yes | |
| report | object | no | |
| report.adds | array of object | yes | |
| report.changes | array of object | yes | |
| report.typeConflicts | array of object | yes | |
| report.unknownNames | array of object | yes |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.
designSystem.read
Read the draft design system's index: its revision, sets, themes, every component with its variant keys, and every token group with its number of paths. Ask for more with tokens (the groups whose paths and values to include, such as ["color.palette", "space"]), components: true (each component's sizes, states and parts, the segments of a setComponentCell key), css: true (the compiled stylesheet, about 240 KB on a large site) or embeds: true. The default answer stays small; read one component's cells with designSystem.readComponent.
permission: designSystem.operationreads onlyclass: read
Example input
{
"tokens": [
"color.palette"
]
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| index | boolean | no | |
| tokens | array of string | no | At most 32 items. |
| components | boolean | no | Default false. |
| css | boolean | no | Default false. |
| embeds | boolean | no | Default false. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| revision | integer | yes | |
| detached | array of object | no | |
| detached[].component | string | yes | |
| detached[].count | integer | yes | At least 0. |
| sets | array of object | no | |
| sets[].key | string | yes | |
| sets[].label | string | yes | |
| sets[].position | integer | yes | |
| sets[].siteAdded | boolean | yes | |
| themes | array of object | no | |
| themes[].key | string | yes | |
| themes[].label | string | yes | |
| themes[].sets | array of string | yes | |
| themes[].isDefault | boolean | no | |
| themes[].draft | boolean | no | |
| themes[].activation | object | no | |
| components | array of object | no | |
| components[].key | string | yes | |
| components[].label | string | yes | |
| components[].group | string | yes | |
| components[].variants | array of string | yes | |
| components[].hiddenVariants | array of string | yes | |
| tokenGroups | array of object | no | |
| tokenGroups[].group | string | yes | |
| tokenGroups[].count | integer | yes | At least 0. |
| tokens | array of object | no | |
| tokens[].group | string | yes | |
| tokens[].tokens | array of object | yes | |
| componentSpecs | array of object | no | |
| componentSpecs[].key | string | yes | |
| componentSpecs[].label | string | yes | |
| componentSpecs[].group | string | yes | |
| componentSpecs[].variants | array of object | yes | |
| componentSpecs[].sizes | array of string | yes | |
| componentSpecs[].states | array of string | yes | |
| componentSpecs[].parts | array of object | object | yes | |
| css | string | no | |
| embeds | record of record of object | no |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.read '{"tokens":["color.palette"]}' --dry-rundesignSystem.readComponent
Read the cells of one design-system component, filtered and paged: variant, size, state, part, breakpoint and property keep the cells whose key segment equals them (a cell key is <variant>.<size>.<state>.<part>.<breakpoint>.<property>), and own: true keeps only the cells set at their own key, leaving out the inherited ones. Each cell has its own value (null when it inherits), the key it inherits from and the blueprint's value; resolved: true adds its value in every theme, css: true the blueprint's baseline stylesheet. limit cells (100 by default) from cursor; total counts every match and nextCursor names the next page. A large component has thousands of cells: filter by variant and state first.
permission: designSystem.operationreads onlyclass: read
Example input
{
"component": "button",
"variant": "primary",
"state": "hover",
"own": true
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| component | string | yes | At least 1 character. |
| variant | string | no | At least 1 character. |
| size | string | no | At least 1 character. |
| state | string | no | At least 1 character. |
| part | string | no | At least 1 character. |
| breakpoint | string | no | At least 1 character. |
| property | string | no | At least 1 character. |
| own | boolean | no | Default false. |
| resolved | boolean | no | Default false. |
| css | boolean | no | Default false. |
| limit | integer | no | At least 1. At most 1000. Default 100. |
| cursor | integer | no | At least 0. Default 0. |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| revision | integer | yes | |
| component | string | yes | |
| total | integer | yes | At least 0. |
| nextCursor | integer | null | yes | |
| cells | array of object | yes | |
| cells[].cell | string | yes | |
| cells[].value | string | object | null | yes | |
| cells[].source | object | yes | |
| cells[].blueprint | string | object | null | yes | |
| cells[].resolved | record of value | no | |
| blueprint | object | yes | |
| blueprint.variants | array of string | yes | |
| blueprint.css | string | no | |
| blueprint.embeds | record of record of object | no |
Fields nested deeper are in the output schema that discover_operations answers with outputSchemas: true.
Try it
yarn splash designSystem.readComponent '{"component":"button","variant":"primary","state":"hover","own":true}' --dry-runGenerated from the operation registry and the MCP tool catalogue (source e12a26fad3b21a06).
Something wrong on this page? Write to docs@librettocms.com.