Tools
Exactly what the server advertised in the scan completed . Effects and capabilities are classified by Squatch from each tool's metadata. Squatch never runs tools.
- Effect: Read 4
- Effect: Write 8
- Effect: Delete 2
- Effect: Execute 1
Showing 15 of 15 tools
| Details | ||
|---|---|---|
| validate_project Run the @clipkit/protocol validator against the current project AND surface render-time warnings even when the JSON is valid — things that … | Effect: Execute | |
| delete_element Delete the element with the given id, anywhere in the tree (including one nested inside a group or its mask) — a tweak to an existing compo… | Effect: Delete | |
| set_project Replace the entire project with the given source JSON, returning its project_id. This is the PRIMARY way to build: use it to create a compo… | Effect: Delete | |
| add_element Append a single element to an existing project — a TWEAK, e.g. dropping in one more caption or shape. By default it is added at the top lev… | Effect: Write | |
| create_project Create a new, blank Clipkit project with the given dimensions and duration, and return its project_id. Defaults: 1920×1080, 10 seconds, 30 … | Effect: Write | |
| create_promo Assemble a designed-looking promo/intro/product/data video from the Clipkit pattern library: give an ordered list of SCENES and the words, … | Effect: Write | |
| describe_project Return a compact, human-readable summary of the current project — dimensions, fps, duration, an element breakdown by type, a per-track time… | Effect: Write | |
| edit_element Change fields on the element with the given id by merging in a partial element — only the keys you include change. The id may be any elemen… | Effect: Write | |
| ingest_asset Fetch a remote media URL (image/video/audio) and HOST it on Clipkit, returning a stable asset_url to put in an element's `url`. Use this so… | Effect: Write | |
| load_project Import a previously shared project as the current project, by its share id or its editor URL (e.g. https://clipkit.dev/editor?id=…), return… | Effect: Write | |
| open_in_editor Validate the current project and create a link that opens it in the Clipkit web editor, where the user can preview and refine it. This shar… | Effect: Write | |
| get_project Return the full current Clipkit source as JSON. Use this to inspect the project, pass it to a render pipeline, or compose follow-up edits. | Effect: Read | |
| get_schema Return the authoritative JSON Schema for a Clipkit Source — exact field names, types, and enums, generated from the protocol. Call with no … | Effect: Read | |
| preview_still Render a single frame of the current project to a PNG and return it as an image you can look at. This is how you check your work — in chat … | Effect: Read | |
| read_docs Return a canonical Clipkit doc as text. topic "card" = the ~8KB compact authoring card — the recommended context for authoring; "pattern-li… | Effect: Read |