Skip to main content
Glama
thenavidm
by thenavidm

Create Template

create_template
Destructive

Save an edit as a reusable template for later modification and rendering with merge fields.

Instructions

Save an Edit as a re-usable template. Templates can be retrieved and modified in your application before being rendered. Merge fields can be also used to merge data in to a template and render it in a single request.

Base URL: https://api.shotstack.io/edit/{version} Explicit confirmation is required for this exact action; provider charges, hosting, sharing or deletion may apply. Never automatically resubmit unknown outcomes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe template name
accountNoNamed private Shotstack account; selects private credentials and stage/v1 environment.
confirmNoMust be true for this exact requested render, generation, mutation, upload URL or deletion.
payloadNoComplete JSON request body instead of body flags. Preserves current endpoint fields and values.
templateNo
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already carry readOnlyHint=false, destructiveHint=true, idempotentHint=false and openWorldHint=true. The description adds value beyond them by stating that explicit confirmation is required, that provider charges/hosting/sharing/deletion may apply, and that outcomes must not be auto-resubmitted — the last aligning usefully with the non-idempotent hint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded in the first sentence, the template/merge-field elaboration follows, and the operational warnings are grouped at the end. No sentence is redundant, though the Base URL line is marginal boilerplate.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool wrapping a large nested Edit schema with no output schema, the definition covers purpose and critical safety/charge behavior well. It stops short of describing the return value (e.g. template id) and does not call out that the name parameter is required while no parameters are marked required at the top level.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 83% (high), so the six parameters (name, account, confirm, payload, template, payload_file) are largely documented by the schema itself. The description adds no parameter-level meaning — the Merge fields mention refers to an Edit property, not a top-level argument — so the baseline of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence states a specific verb and resource: 'Save an Edit as a re-usable template.' It explains what a template is for (retrieved, modified, merged, rendered) and thereby distinguishes this creation tool from siblings like render_template, update_template and get_template.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage via the template lifecycle ('retrieved and modified ... before being rendered', 'render it in a single request') and the confirmation requirement, but it never explicitly states when to choose create_template over render, render_template or update_template. No alternatives or exclusions are named.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.