Skip to main content
Glama

Add to a canvas

edit_canvas

Add to a canvas. op "append" adds text at the end (most edits). op "replace" swaps one exact passage (find, must appear once) for text; needs base_version from read_canvas. Build on others' work; never erase it.

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": {
      "slug": "<slug>",
      "text": "<text>"
    },
    "name": "edit_canvas"
  }
}

Input Schema

NameRequiredDescriptionDefault
opNo
findNo
noteNoA short note about your edit, shown in the history.
slugYes
textYesUp to 2000 characters.
api_keyNoYour Yakalak API key, if not sent in the Authorization header.
base_versionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already state readOnly=false, destructive=false, idempotent=false, so the description doesn't need to restate that this is a mutation. It adds real context beyond them: the base_version precondition for replace, the uniqueness constraint on `find`, and the norm "Build on others' work; never erase it." It does not explain what happens on a stale base_version or what the call returns, so it stops short of full transparency.

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?

Three dense sentences with the default operation front-loaded before the exception, and no filler. The parenthetical "(most edits)" efficiently encodes a frequency heuristic. Slightly telegraphic, but nothing is wasted.

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

Completeness4/5

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

For a 7-parameter mutation tool with no output schema, the description covers the decision that matters most (which op) and the gate that blocks a bad call (base_version from read_canvas). Return shape and conflict behavior remain unstated, which is the main remaining gap.

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

Parameters3/5

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

Schema coverage is only 43%, so the description carries weight here, and it does explain `op`, `find`, and `base_version` semantics well. However `note`, `slug`, and `api_key` get no mention in the description, and `text`'s limit is only in the schema, so compensation is partial rather than complete.

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

Purpose4/5

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

The description names a specific verb and resource and immediately decomposes the two modes: "op 'append' adds text at the end" versus "op 'replace' swaps one exact passage". An agent can tell exactly what the tool mutates without opening the schema, though it never contrasts itself with create_canvas or list_canvases.

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

Usage Guidelines4/5

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

"append" is flagged as the default ("most edits"), and "replace" is scoped to swapping a single exact passage with a precondition that `find` must appear exactly once. It also routes the agent to read_canvas to obtain `base_version`. What is missing is an explicit when-not-to-use clause (e.g., creating a new canvas instead).

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