Updates the send schedule for an API-triggered Canvas, letting you adjust timing or local delivery to match new campaign plans.
Update a scheduled API-triggered Canvas.
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | No | Braze REST API key | |
| schedule | Yes | ||
| canvas_id | Yes | Canvas ID | |
| schedule_id | Yes | Schedule ID to update | |
| restEndpoint | No | Braze REST endpoint URL |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations, so the description carries the full behavioral burden. It does not disclose permissions, side effects, reversibility, rate limits, or response behavior for a mutation tool; only the word 'Update' implies a write.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Single front-loaded sentence with no filler. It is appropriately concise, though sparse; missing detail is scored elsewhere.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Mutation tool with no annotations, no output schema, nested object, and five parameters needs more context. The description leaves usage, behavior, and return expectations unspecified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 80%, so baseline is 3. The description adds no parameter meaning beyond the schema; nested schedule fields are documented in the schema, not the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clear verb 'Update' and resource 'scheduled API-triggered Canvas', which separates it from create/delete and campaign/message siblings. It does not explicitly name or contrast with alternatives, so sibling differentiation is implicit rather than stated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use, prerequisites, or alternatives are given. The agent must infer that this is for modifying an existing Canvas schedule rather than creating or deleting one.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.