Retrieve summary analytics for a Braze Canvas by canvas ID and day range to track performance and engagement metrics.
Get summary analytics for a Canvas.
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | No | Braze REST API key | |
| length | Yes | Number of days | |
| canvas_id | Yes | Canvas ID | |
| ending_at | No | ||
| 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 are provided, so the description carries the full burden. It implies a read operation with 'Get', but does not disclose required permissions, behavior of the length/ending_at parameters, rate limits, or what the summary contains.
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?
The description is a single front-loaded sentence with no wasted words. It is appropriately concise, though its brevity leaves the specification thin.
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?
For a 5-parameter analytics tool with no annotations and no output schema, the description is incomplete. It does not explain the required time-range parameters, the meaning of 'summary', or how this differs from related analytics tools.
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 the schema already documents most parameters. The description adds no meaning beyond the schema, which is acceptable at this coverage level but not helpful.
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?
The verb 'Get' and resource 'Canvas' are clear, but 'summary analytics' is vague and does not distinguish this tool from sibling canvas_analytics. An agent cannot tell from the description alone which Canvas analytics tool to choose.
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?
The description provides no guidance on when to use this tool versus canvas_analytics, canvas_details, or campaigns_analytics. It offers no prerequisites, exclusions, or context for selecting it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.