Skip to main content
Glama

Annotate a handover artifact

handover.annotate

Add a durable comment anchored to selected text or lines in an immutable artifact revision. Read the artifact first and preserve the exact quote and surrounding context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesActionable annotation body in plain text or Markdown.
targetYesImmutable artifact location to anchor this annotation.
handoverIdYesHandover containing the artifact being annotated.
mentionPrincipalIdsNoCollaborator principal IDs to mention and notify.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changed
    • addedInput schema / properties / body / description
      Added value: +"Actionable annotation body in plain text or Markdown."
    • addedInput schema / properties / handoverId / description
      Added value: +"Handover containing the artifact being annotated."
    • addedInput schema / properties / mentionPrincipalIds / description
      Added value: +"Collaborator principal IDs to mention and notify."
    • addedInput schema / properties / target / description
      Added value: +"Immutable artifact location to anchor this annotation."
    • addedInput schema / properties / target / properties / artifactId / description
      Added value: +"Artifact containing the selected text or code."
    • addedInput schema / properties / target / properties / revisionId / description
      Added value: +"Immutable revision containing the annotated artifact."
    • addedInput schema / properties / target / properties / selector / description
      Added value: +"Exact quote plus optional position and surrounding context."
    • addedInput schema / properties / target / properties / selector / properties / endLine / description
      Added value: +"Zero-based line where the selection ends."
    • addedInput schema / properties / target / properties / selector / properties / endOffset / description
      Added value: +"Zero-based character offset immediately after the selection."
    • addedInput schema / properties / target / properties / selector / properties / startLine / description
      Added value: +"Zero-based line where the selection starts."
    • addedInput schema / properties / target / properties / selector / properties / startOffset / description
      Added value: +"Zero-based character offset where the selection starts."
    • addedInput schema / properties / target / properties / targetKind / description
      Added value: +"Rendering context used to relocate and display the annotation."
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The description adds behavioral context beyond annotations by stating the comment is 'durable' and the revision is 'immutable', implying persistence and anchoring stability. It also instructs to preserve exact quote and context. Annotations are all false and do not contradict the description.

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 sentences, front-loaded with the action, and no wasted words. It states the action and the key prerequisite in a compact format.

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 tool has a complex nested target object, but the description gives essential guidance (read first, exact quote). It does not cover return values or error cases, but with no output schema and high schema coverage, that is not a significant gap.

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?

Schema coverage is 100%, but the description adds valuable meaning by saying to 'preserve the exact quote and surrounding context', which directly informs how to populate the target.selector fields. This goes beyond the schema's basic description.

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 ('Add') and resource ('durable comment anchored to selected text or lines in an immutable artifact revision'). It clearly distinguishes from siblings like handover.comment by emphasizing the anchored/selected-text nature.

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 instruction 'Read the artifact first' provides a clear prerequisite and context for use. However, it does not explicitly mention alternatives or when not to use this tool, so it stops short of a 5.

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.