enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.inspect

Enhance documentation

canvas.inspect

Read the canonical browser URL for a canvas, its exact document version, kind counts, bounds, and next inspection commands.

↓ Markdown

canvas.inspect

query read

Use when current canvas state is missing from the task context.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

Show complete JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["canvasId"]}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010"
}

Result

Returns a typed canvas.inspect result from the Enhance API without transport-specific prose.

  • canvasId (required): Returned field canvasId.
  • openUrl (required): Returned field openUrl.
  • title (required): Returned field title.
  • version (required): Returned field version.
  • nodeCount (required): Returned field nodeCount.
  • rootChildCount (required): Returned field rootChildCount.
  • bounds (required): Returned field bounds.
  • kinds (required): Returned field kinds.
  • next (required): Returned field next.
Show complete result JSON Schema 
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"openUrl":{"type":"string","format":"uri"},"title":{"type":"string","minLength":1},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"nodeCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"rootChildCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"bounds":{"anyOf":[{"type":"object","properties":{"x":{"type":"number"},"y":{"type":"number"},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}},"required":["x","y","width","height"],"additionalProperties":false},{"type":"null"}]},"kinds":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"integer","minimum":0,"maximum":9007199254740991}},"next":{"type":"array","items":{"type":"string","minLength":1}}},"required":["canvasId","openUrl","title","version","nodeCount","rootChildCount","bounds","kinds","next"],"additionalProperties":false}

Example result

Show example result 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "openUrl": "https://example.test/path",
 "title": "x",
 "version": 1,
 "nodeCount": 0,
 "rootChildCount": 0,
 "bounds": {
  "x": 0,
  "y": 0,
  "width": 1,
  "height": 1
 },
 "kinds": {},
 "next": []
}

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Use the returned identifiers and version in the next canvas operation.

Versions

Compatibility: e83a128a52d8d3e8f95d8bddae87410966193f3d52ac87330d625353f0e43820.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.