Styles

Tools for creating and managing paint, text, and effect styles

1 tool in this domain.

styles

endpoint

CRUD endpoint for local styles (paint, text, effect). list → {type?, fields?, offset?, limit?} → {totalCount, items: [{id, name, type, ...}]} get → {id, fields?} → style object (full detail; fields to filter) create → {type, items: [...]} → {results: [{id}, ...]} update → {type?, items: [{id, ...}]} → {results: ['ok'|{warning}, ...]} delete → {id} or {items: [{id}, ...]} → 'ok' or {results: ['ok', ...]}

Parameter	Type	Required	Description
method	"create" | "get" | "list" | "update" | "delete"	✓
id	string	✗	Resource ID (get, delete)
fields	string[]	✗	Property whitelist (get/list). Identity fields (id, name, type) always included. Omit for stubs on list, full detail on get. Pass ["*"] for all fields.
offset	number	✗	Skip N items for pagination (default 0)
limit	number	✗	Max items per page (default 100)
type	"paint" | "text" | "effect"	✗	Style type. Required for create. Filters list by type. Optional for update (strict per-type validation; omit to auto-detect).
items	array	✗	Create: [{name, color}] (paint), [{name, fontFamily, fontSize, ...}] (text), [{name, effects}] (effect). Update: [{id, ...fields}]. Delete (batch): [{id}, ...].
depth	number	✗	Response detail: omit for id+name only. 0=properties + child stubs. N=recurse N levels. -1=unlimited.

JSON Schema

{
  "type": "object",
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "create",
        "get",
        "list",
        "update",
        "delete"
      ]
    },
    "id": {
      "description": "Resource ID (get, delete)",
      "type": "string"
    },
    "fields": {
      "description": "Property whitelist (get/list). Identity fields (id, name, type) always included. Omit for stubs on list, full detail on get. Pass [\"*\"] for all fields.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "offset": {
      "description": "Skip N items for pagination (default 0)",
      "type": "number"
    },
    "limit": {
      "description": "Max items per page (default 100)",
      "type": "number"
    },
    "type": {
      "description": "Style type. Required for create. Filters list by type. Optional for update (strict per-type validation; omit to auto-detect).",
      "type": "string",
      "enum": [
        "paint",
        "text",
        "effect"
      ]
    },
    "items": {
      "description": "Create: [{name, color}] (paint), [{name, fontFamily, fontSize, ...}] (text), [{name, effects}] (effect). Update: [{id, ...fields}]. Delete (batch): [{id}, ...].",
      "type": "array",
      "items": {}
    },
    "depth": {
      "description": "Response detail: omit for id+name only. 0=properties + child stubs. N=recurse N levels. -1=unlimited.",
      "type": "number"
    }
  },
  "required": [
    "method"
  ]
}

Response reference only — not included in tool definitions

No parameters

Example response

{
  "totalCount": 3,
  "returned": 3,
  "offset": 0,
  "limit": 100,
  "items": [
    {
      "id": "S:abc123,",
      "name": "Primary/Blue",
      "type": "PAINT"
    },
    {
      "id": "S:def456,",
      "name": "Heading/H1",
      "type": "TEXT"
    },
    {
      "id": "S:ghi789,",
      "name": "Shadow/Large",
      "type": "EFFECT"
    }
  ]
}

Response JSON Schema

{
  "type": "object",
  "description": "Response varies by method. list → paginated {totalCount, items: [...]} (stubs by default, use fields for detail). get → style object (full detail, field-filterable). create → {results: [{id}]}. update → {results: ['ok'|{warning}]}. delete → 'ok' (single) or {results: ['ok', ...]} (batch)."
}