Skip to main content
Glama

update_annotation

Idempotent

Updates an existing text annotation in a live Trident document. Only the fields you provide are changed. Use get_document_summary to get all annotation IDs before calling this. Requires a valid editor access token.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tokenYesEditor access token for this document.
agentIdYesYOUR AI assistant name (e.g. "Claude.ai", "GitHub Copilot"). Shown as "[agentId] working with [userName]" in the collaboration presence dot.
changesYesFields to update. Only provided fields are changed.
userNameNoFirst name of the human you are assisting (ask them at session start if you do not know). Shown in the collaboration presence dot as "[agentId] working with [userName]".
annotationIdYesID of the annotation to update
action_explanationNoOptional: brief explanation of what this action does and why (max 250 chars). Shown live to human collaborators in the AI cursor tooltip.

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the annotation-provided write/idempotent/destructive hints, the description discloses partial-update semantics ('Only the fields you provide are changed') and the need for a valid editor access token. It does not describe side effects on collaborators or failure behavior, but adds meaningful context beyond annotations.

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?

The description is four short sentences, each delivering distinct value: purpose, partial-update semantics, ID retrieval prerequisite, and auth requirement. No wasted words or repetition of schema content.

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?

The description provides the essential workflow (obtain IDs first, valid token, partial updates) and is sufficient given that the schema documents all parameters and annotations cover safety. It could mention return behavior or error conditions, but overall it is complete enough for a well-scoped update tool.

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?

With 100% schema description coverage, the schema already documents each parameter. The description adds practical guidance by instructing the agent to obtain annotation IDs via get_document_summary, which directly clarifies the source of the annotationId parameter. It also reinforces the token requirement, slightly enhancing parameter semantics.

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 uses a specific verb ('Updates') and clearly scopes to 'an existing text annotation in a live Trident document,' distinguishing it from add_annotation and delete_annotation. It also clarifies partial-update behavior, leaving no ambiguity about its purpose.

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?

The description instructs the agent to call get_document_summary first to obtain annotation IDs, which is essential prerequisite guidance. It also states the token requirement. While it doesn't explicitly list when not to use this tool, the context makes the usage scenario clear.

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.

TDQS

A4.3/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: CRUD operations for nodes, containers, connections, and annotations are separated, and read-only/utility tools like open_document, get_document_summary, and explain are well-differentiated. No two tools have overlapping functionality.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g. add_node, delete_connection, get_document_summary). Even utility tools like open_document and validate_trident adhere to this pattern, making the set predictable and easy to navigate.

Tool Count4/5

With 22 tools, the server is slightly above the typical well-scoped range (3-15). Each tool serves a specific purpose, covering CRUD for diagram elements, multiple read operations, and collaboration features, but the count feels a bit heavy for a focused diagramming tool.

Completeness4/5

The tool set provides comprehensive CRUD for core elements (nodes, containers, connections, annotations), multiple read methods, guides, and collaboration aids. Minor gaps exist: no bulk operations, no tool to create or manage documents themselves, but the core editing workflow is well-covered.