Skip to main content
Glama

canvas-pan

Idempotent

Pan and/or zoom the canvas (canvas.animatePan) for everyone's view, in scene pixels, not grid squares. All fields optional: omit x/y to keep the centre, scale to keep the zoom. journalId pans to that journal's map note instead (bridge module 8.19.0+). canvas-ping draws attention to a spot instead.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "canvas-pan"
  }
}

Input Schema

NameRequiredDescriptionDefault
xNoScene-pixel X to centre on. Omit to keep current.
yNoScene-pixel Y to centre on. Omit to keep current.
scaleNoZoom level (1 = 100%). Omit to keep current.
durationNoAnimation duration in ms.
journalIdNoJournal ID (from journal-list) whose map note on the viewed scene to pan to

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / journalId
      Added value: +{
      +  "description": "Journal ID (from journal-list) whose map note on the viewed scene to pan to",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare non-destructive, idempotent, non-read-only behavior, and the description adds the genuinely non-obvious fact that the pan applies to everyone's view, not just the caller. It also flags the 8.19.0+ module dependency for journalId, a real failure mode. It stops short of covering animation blocking or what happens if the target scene differs.

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

Conciseness5/5

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

Three tight sentences: what it does, how optional fields behave, then the journalId exception and sibling pointer. No filler, and the scope/unit caveat is front-loaded where it matters most.

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

Completeness5/5

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

With all five parameters optional, full schema documentation, and annotations carrying the safety profile, the remaining risks an agent faces are units, partial-field behavior, and version compatibility — all addressed. No output schema exists, so nothing about return values is owed.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds meaning beyond it: the explicit 'scene pixels, not grid squares' unit caveat and the version prerequisite on journalId. The omit-to-keep-current semantics largely restate the schema.

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

Purpose5/5

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

States a specific verb pair (pan/zoom) and resource (the canvas view for everyone), and pins down the coordinate space with 'in scene pixels, not grid squares' — a distinction the name alone cannot convey. It explicitly separates itself from canvas-ping, which only draws attention.

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

Usage Guidelines5/5

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

Prescribes omit-x/y-to-keep-centre and omit-scale-to-keep-zoom behavior, names journalId as an alternative targeting mode for journal map notes, and redirects to canvas-ping when the intent is to highlight rather than move. Both the when and the when-not are covered.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources