Skip to main content
Glama

Add annotation

annotation_add

Add framed group comments around nodes or free text notes to document an IlluGen graph without changing rendered output, then return the index for later removal.

Instructions

Adds a comment to the node graph: a framed group around nodes, or a free text note.

Annotations only document the graph; they do not change the rendered result. Writes the project file in place.
Returns {"group": index} or {"note": index}, the index to pass to annotation_remove.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindYes'group' = framed comment box drawn behind nodes; 'note' = free text label.
pathYesAbsolute path of the .illugen project file.
sizeNo[width, height]. Default 600 x 400 for a group, 460 x 60 for a note.
textYesComment of the group, or text of the note.
graphNoGraph to work in: empty for the top-level graph, or the id or label of a Node_Subgraph node ('outer/inner' for nested subgraphs).
positionNo[x, y] top-left corner. Required unless around_nodes is given.
color_idxNoGroups: color index of the frame. 0 = default color.
around_nodesNoGroups: ids or labels of the nodes to frame; position and size are computed from them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.1.2
    • addedInput schema / properties / around_nodes / description
      Added value: +"Groups: ids or labels of the nodes to frame; position and size are computed from them."
    • addedInput schema / properties / color_idx / description
      Added value: +"Groups: color index of the frame. 0 = default color."
    • addedInput schema / properties / graph / description
      Added value: +"Graph to work in: empty for the top-level graph, or the id or label of a Node_Subgraph node ('outer/inner' for nested subgraphs)."
    • addedInput schema / properties / kind / description
      Added value: +"'group' = framed comment box drawn behind nodes; 'note' = free text label."
    • addedInput schema / properties / kind / enum
      Added value: +[
      +  "group",
      +  "note"
      +]
    • addedInput schema / properties / path / description
      Added value: +"Absolute path of the .illugen project file."
    • addedInput schema / properties / position / description
      Added value: +"[x, y] top-left corner. Required unless around_nodes is given."
    • addedInput schema / properties / size / description
      Added value: +"[width, height]. Default 600 x 400 for a group, 460 x 60 for a note."
    • addedInput schema / properties / text / description
      Added value: +"Comment of the group, or text of the note."
  2. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

The description adds behavior beyond the annotations: it discloses the in-place project-file write ('Writes the project file in place') and the non-rendering side-effect profile, corroborating readOnlyHint=false and non-idempotent behavior. It also documents the return shape, which is useful given no output schema. Minor gaps remain (no mention of permission/auth requirements), but the side-effect disclosure is meaningful.

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, front-loaded with purpose, then the behavioral note, then the return contract. Nothing is wasted and the most decision-relevant information (what it does and that it doesn't affect rendering) comes first.

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 an 8-parameter write tool with no output schema, the description covers the essentials: purpose, non-rendering semantics, in-place write, and the returned index needed to chain into annotation_remove. Annotations handle the safety profile, so the definition is nearly complete, though it doesn't tie the returned index back to more of the surrounding workflow.

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 description coverage is 100%, so all 8 parameters (including the kind enum, position, size defaults, graph scoping, and around_nodes) are already documented in the schema. The description only loosely reinforces the group/note distinction and adds no syntax or format detail beyond it, so the baseline of 3 applies.

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?

The description states a specific verb and resource ('Adds a comment to the node graph') and immediately disambiguates the two modes it supports ('a framed group around nodes, or a free text note'). An agent can distinguish it from annotation_remove and the node_* siblings without opening the schema.

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?

It gives a clear usage frame by clarifying annotations 'only document the graph; they do not change the rendered result', which tells the agent when this tool is and isn't appropriate versus rendering tools like project_render. It also points at annotation_remove for the removal flow. However, no explicit when-not or alternative-tool routing is stated for the add case itself.

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