Skip to main content
Glama

Add comment

add_comment

Add a comment to an annotation’s thread, e.g. to record what you changed. Notifies the team.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesThe comment text.
annotation_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNo
bodyNo
created_atNo
annotation_idNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Adds the behavioral detail that the tool notifies the team, which goes beyond annotations that only indicate non-read-only and non-destructive. No contradictions.

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 concise sentences front-loading the action, example, and side-effect. No unnecessary words.

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?

Provides purpose, usage example, and notification side-effect. With output schema present, the description is adequate for a simple write tool, though it could mention required permissions or valid annotation_id.

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

Parameters2/5

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

Schema description coverage is 50% (annotation_id lacks description). The tool description does not mention or clarify parameters, adding no meaning beyond the schema.

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?

Clearly states verb 'Add' and resource 'comment to an annotation’s thread', with an example use case. Differentiates from sibling list_comments (reading) and other tools.

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

Usage Guidelines3/5

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

Provides an example 'e.g. to record what you changed' which implies usage context, but lacks explicit when-to-use or when-not-to-use guidance compared to alternatives.

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.