delete_chart
ChatGPTUse this when the user explicitly wants to permanently delete one saved chart. Deletion cannot be undone, and retrying an already completed deletion succeeds; requires authentication.
get_chart
ChatGPTUse this when the user identifies a saved chart by id and wants to view it or retrieve its metadata and URLs. Displays the published chart when available and does not return its document; requires authentication.
get_chart_document
ChatGPTUse this when the user identifies a saved chart by id and needs its complete published Szum document for inspection or reuse. Does not return a newer editor draft; requires authentication.
get_examples
ChatGPTGet complete Szum documents for validation, rendering, or saving, with guidance on when to use each pattern. No filters returns one starter per chart type. Any filter searches the complete catalog; all supplied filters intersect. Most data is illustrative; the Vinyl waterfall cites RIAA reports. Empty matches mean no example satisfies every filter; remove a filter to broaden the search.
get_preview_state
ChatGPTUse this when the Szum chart App needs to restore a rendered preview as its current transient or saved view. It is read-only, owner-scoped when authenticated, and hidden from the model.
get_schema
ChatGPTUse this before authoring an unfamiliar field instead of probing validate_chart for errors. Returns the JSON Schema for the whole Szum document, covering config, data, presentation, size, and output, with every referenced definition included. Pass chart_type to keep only that family's config variants; omitting it returns every family and is much larger. Generated value lists are summarized rather than enumerated; validate_chart remains the authority.
list_chart_types
ChatGPTUse this when choosing a chart family. Returns every current chart type with its shared and family-specific fields.
list_charts
ChatGPTUse this when the user wants to find charts in their saved library. Returns paginated metadata and URLs, not chart documents; requires authentication. Draft-only editor charts have publishedAt null, hasDraft true, and sizeBytes 0 because sizeBytes measures only the stored published document, not draft storage.
list_themes
ChatGPTUse this when choosing a visual theme for a chart. Returns every available theme and guidance on where each works best.
rename_chart
ChatGPTUse this when the user wants to change a saved chart's library title without changing its document, publication state, or public URLs; requires authentication.
render_chart
ChatGPTUse this when the user wants to preview or generate a chart. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Stores a 1 hour preview and returns public image URLs. Authenticated previews use the account's render allowance, and each image produced from a returned URL is another render. Anonymous previews are complimentary; their images use the anonymous image allowance.
save_chart
ChatGPTUse this when the user wants to permanently save and publish a Szum chart document. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Supply one idempotencyKey per intended chart and reuse it for retries. Returns permanent public Image and Embed URLs plus Edit and Studio links; requires authentication and saved-chart storage.
update_chart
ChatGPTUse this when the user wants to replace and publish a saved chart's document while keeping its id and URLs. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Refuses charts with unpublished editor changes; requires authentication and saved-chart storage.
validate_chart
ChatGPTUse this when a chart request or document will be rendered, saved, or updated. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Read-only, free, and fast.
delete_chart
ClaudeUse this when the user explicitly wants to permanently delete one saved chart. Deletion cannot be undone, and retrying an already completed deletion succeeds; requires authentication.
get_chart
ClaudeUse this when the user identifies a saved chart by id and wants to view it or retrieve its metadata and URLs. Displays the published chart when available and does not return its config; requires authentication.
get_chart_config
ClaudeUse this when the user identifies a saved chart by id and needs its complete published Szum config for inspection or reuse. Does not return a newer editor draft; requires authentication.
get_chart_document
ClaudeUse this when the user identifies a saved chart by id and needs its complete published Szum document for inspection or reuse. Does not return a newer editor draft; requires authentication.
get_examples
ClaudeUse this when the model needs current, ready-to-use Szum chart configs or preferred semantic patterns. Optionally filters examples by mark type.
get_preview_state
ClaudeUse this when the Szum chart App needs to restore a rendered preview as its current transient or saved view. It is read-only, owner-scoped when authenticated, and hidden from the model.
get_schema
ClaudeUse this before authoring an unfamiliar field instead of probing validate_chart for errors. Returns the JSON Schema for the whole Szum document, covering config, data, presentation, size, and output, with every referenced definition included. Pass chart_type to keep only that family's config variants; omitting it returns every family and is much larger. Generated value lists are summarized rather than enumerated; validate_chart remains the authority.
list_chart_types
ClaudeUse this when choosing a chart family. Returns every current chart type with its shared and family-specific fields.
list_charts
ClaudeUse this when the user wants to find charts in their saved library. Returns paginated metadata and URLs, not chart configs; requires authentication. Draft-only editor charts have publishedAt null, hasDraft true, and sizeBytes 0 because sizeBytes measures only the stored published config, not draft storage.
list_marks
ClaudeUse this when choosing or configuring chart mark types. Returns every available mark with its properties and defaults.
list_themes
ClaudeUse this when choosing a visual theme for a chart. Returns every available theme and guidance on where each works best.
rename_chart
ClaudeUse this when the user wants to change a saved chart's library title without changing its config, publication state, or public URLs; requires authentication.
render_chart
ClaudeUse this when the user wants to preview or generate a chart from a Szum config after preflighting a generated or materially changed config with validate_chart. Stores a one-hour preview and returns a public image URL; authenticated calls use the account's render allowance.
save_chart
ClaudeUse this when the user wants to permanently save and publish a chart from a Szum config. Returns permanent public Image and Embed URLs plus Edit and Studio links; requires authentication and saved-chart storage.
update_chart
ClaudeUse this when the user wants to replace and publish a saved chart's config while keeping its id and URLs. Refuses charts with unpublished editor changes; requires authentication and saved-chart storage.
validate_chart
ClaudeUse this when preflighting the first render, save, or update of a generated or materially changed Szum config, or when the user asks to validate or debug one. Read-only.