Skip to main content
Glama

Add Annotation

add_annotation

Place free text notes on drawing pages at specified X/Y coordinates in millimeters to label views and document details.

Instructions

Add a free text annotation to a drawing page at page position (x, y) in mm (origin bottom-left, +Y up, matching TechDraw view placement). Returns {handle, name, text}.

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": {
      "page": "<page>",
      "text": "<text>"
    },
    "name": "add_annotation"
  }
}

Input Schema

NameRequiredDescriptionDefault
xNo
yNo
nameNoNote
pageYes
textYes
workspaceNoRun this call in this named workspace

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.5.7
    • addedInput schema / properties / workspace
      Added value: +{
      +  "default": "",
      +  "description": "Run this call in this named workspace",
      +  "title": "Workspace",
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior in the coordinate-frame and unit specification plus the returned triple, but omits failure modes (missing page, duplicate name) and whether the annotation can later be edited or removed.

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?

Two tight sentences with no filler; the location convention is front-loaded before the return contract. Every clause carries information an agent would otherwise have to guess.

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 no output schema, spelling out the return shape is a real contribution, but a mutation tool with 6 params and 17% schema coverage should also cover page existence requirements, name uniqueness, and what happens on an invalid page. Adequate but with clear gaps.

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 only 17% (just the workspace param), so the description must compensate. It does explain x/y semantics thoroughly and implies that 'name' is an identifier via the return triple, but the page and text parameters are only implied, and the default name 'Note' plus the default 20/20 position are left undocumented in prose.

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 and resource ('Add a free text annotation to a drawing page') and pins down where it lands with a concrete coordinate convention (mm, origin bottom-left, +Y up, TechDraw-style). It also lists the return shape, so an agent knows exactly what operation it is committing to.

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?

There is no guidance on when to pick this over drawing siblings such as add_feature_note, add_dimension, add_gdt_callout, or balloon_drawing — all of which also place content on a drawing page. It also never states prerequisites, such as whether the page must already exist or whether the drawing must be opened first.

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