bdesign_canvas_get
Retrieves the canvas document and its revision for a specified project by project ID.
Instructions
Read the Canvas document and revision for a project.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | No |
Retrieves the canvas document and its revision for a specified project by project ID.
Read the Canvas document and revision for a project.
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | No |
Changes observed during successful MCP inspections.
v0.2.3Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description is consistent with the readOnlyHint annotation and does not contradict it. However, it adds no behavioral details beyond what the annotation already provides, such as side effects or constraints.
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 concise sentence that directly states the tool's purpose. It is well-structured and front-loaded with the key action and resource.
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 simple read operation with a single parameter, the description is minimally sufficient. However, because there is no output schema, the description could more explicitly state what is returned beyond 'document and revision'.
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?
The schema provides no description for projectId, and the tool description does not explain the parameter. With 0% schema description coverage and no compensation in the description, parameter semantics are entirely missing.
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 clearly states a specific action ('Read') and the resource ('Canvas document and revision for a project'). It is understandable and provides enough purpose, though it does not explicitly differentiate from the similarly named canvas_view sibling.
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 guidance is given about when to use this tool versus alternatives like canvas_view or canvas_search. The description implies retrieval but does not state context or exclusions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.