Retrieve a diagram's title, workspace, element count, and last-updated time without loading raw scene data. Use it to inspect or list diagram metadata in CanvasKeep.
Get a summary of an existing diagram: its title, workspace, element count, and when it was last updated. Does NOT return the raw scene data.
| Name | Required | Description | Default |
|---|---|---|---|
| diagram_id | Yes | The diagram UUID to look up |
Changes observed during successful MCP inspections.
v0.6.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full disclosure burden. It does useful work by defining the payload boundary (metadata only, no scene data), which signals a cheap read operation, but it says nothing about permissions, behavior when the diagram_id does not exist, or error semantics. Adequate but incomplete for a zero-annotation tool.
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?
Two sentences, zero filler, with the returned-field list front-loaded and the exclusion clause placed last where it is most useful. Every clause earns its place.
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?
With no output schema and no annotations, the description compensates well by enumerating the returned fields and their boundary. It is nearly complete for a simple read-only lookup, though it omits not-found/permission behavior an agent might want before calling.
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?
There is a single parameter, diagram_id, and schema description coverage is 100% ('The diagram UUID to look up'), so the schema already does the heavy lifting. The description adds no format or lookup semantics beyond that, making the baseline 3 correct.
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?
States a specific verb and resource ('Get a summary of an existing diagram') and enumerates exactly what the summary contains: title, workspace, element count, last-updated time. It also explicitly disambiguates from the sibling get_diagram_scene by stating it does NOT return raw scene data, so an agent can pick between the two without opening either schema.
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 negative clause 'Does NOT return the raw scene data' implicitly routes the agent away from this tool when full scene contents are needed, effectively naming the alternative by contrast. There is no explicit 'use this when' statement or mention of prerequisites, so it stops short of a full 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.