Skip to main content
Glama

comment_on_document

Leave feedback on a document that is in review. Not an edit — use edit_document to change the document, and reply_to_thread to answer an existing comment. Pass documentId; this comments on the current review version and says so when there is none. Posted as the user's personal agent.

Input Schema

NameRequiredDescriptionDefault
commentYesThe comment text to post on the document
documentIdYesThe document to comment on. The server uses its current review version.
quotedTextNoOptional document text or exact custom-node HTML to anchor the comment to. Use one target, not both text and custom-node HTML.

Output Schema

NameRequiredDescriptionDefault
statusYes
threadIdYes
documentVersionIdYesThe review version the comment was posted on

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare the safety profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false), so the description's added value is the identity/attribution detail ("Posted as the user's personal agent") and the disclosed failure mode when the document has no current review version. That is meaningful context beyond the annotations, though return shape and permission requirements are left to the output schema.

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 the core action, then exclusions, then invocation detail. No filler and nothing repeated from the schema verbatim.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need not be explained. The description covers purpose, sibling alternatives, the required identifier, the review-version targeting rule, the empty-state behavior, and the posting identity — everything needed to call it correctly.

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 three parameters are already documented, including documentId's server-side resolution to the current review version. The description restates documentId behavior but adds nothing about quotedText anchoring semantics. Baseline 3 applies when the schema does the heavy lifting.

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 ("Leave feedback on a document") plus the scope qualifier "that is in review". It then names two siblings it is not — edit_document and reply_to_thread — so an agent can distinguish it without opening any schema.

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

Usage Guidelines5/5

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

Explicitly sets the boundary: not an edit (route to edit_document) and not a reply (route to reply_to_thread). It also states the invocation prerequisite ("Pass documentId") and the conditional behavior when no review version exists.

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.