Retrieve all Canvases in your Braze workspace, with optional filtering by archive status, sort direction, and last edit time to locate and manage specific user journeys.
List all Canvases in the workspace.
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| apiKey | No | Braze REST API key | |
| restEndpoint | No | Braze REST endpoint URL | |
| sort_direction | No | ||
| include_archived | No | ||
| last_edit_time_gt | No |
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 doesn't disclose pagination behavior, authentication requirements (apiKey/restEndpoint), or whether the list is filtered by default (e.g., include_archived). For a list tool with 6 parameters and no annotations, this is a significant gap.
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, clear sentence that is front-loaded with the essential action. It contains no unnecessary words.
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?
Given the complexity (6 parameters, no output schema, no annotations) and low schema description coverage, the description is incomplete. It fails to explain pagination, filtering options, or authentication, which are crucial for correct invocation.
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 33% (only apiKey and restEndpoint are described). The description adds no meaning for the other parameters (page, sort_direction, include_archived, last_edit_time_gt), leaving them undocumented. A baseline of 3 is not warranted because the description does not compensate for the low coverage.
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 description states a clear verb ('List') and resource ('Canvases in the workspace'), which is easily distinguishable from siblings like canvas_details or canvas_analytics. However, it lacks explicit differentiation from campaigns_list (a similar list tool for a different resource).
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?
There is no guidance on when to use this tool versus alternatives like canvas_details or campaigns_list. The description only states what it does, not when to use it or any prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.