Skip to main content
Glama

ai_modeling_canvas_get

Read-only

Read a canvas by ID to retrieve its nodes, edges, revision, and node execution state so agents can inspect current structure and task progress.

Instructions

Read nodes, edges, revision and node execution state.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "canvasId": "<canvasId>"
    },
    "name": "ai_modeling_canvas_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
canvasIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.4

TDQS

C2.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description's genuine contribution is enumerating what comes back (nodes, edges, revision, node execution state), which is useful since there is no output schema, but it says nothing about pagination, size limits, or behavior for missing/invalid canvases.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no filler or repetition. It is efficient, though the brevity borders on under-specification for a tool with an undocumented identifier parameter.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With annotations present, one simple parameter, and no output schema, the description covers the minimum: it names the action and the returned artifacts. It still omits how to source canvasId and how this getter differs from the other canvas retrieval tools, which is the main missing piece.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the description never mentions the single canvasId parameter, so it adds no meaning beyond the schema's pattern/length constraints. The parameter name is largely self-evident, but with zero documented coverage the description should have specified what the identifier refers to and where to obtain it.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Read" plus a list of returned artifacts (nodes, edges, revision, node execution state) makes the basic action identifiable, but nothing distinguishes it from the surrounding get-family siblings such as ai_modeling_canvas_get_shared, ai_modeling_canvas_get_project, or ai_modeling_canvas_session_get — an agent cannot tell which getter returns the canvas graph itself.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use guidance, no exclusions, and no mention of any alternative tool or prerequisite (e.g., needing a canvasId from canvas_create or a listing call). The agent must infer applicability purely from the tool name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools