Skip to main content
Glama

Rapier

Discuss inspected work

document.comment
Destructive

Creates, replies to, resolves or reopens a discussion on the person's work, anchored to an inspected passage, drawing object or the whole document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textNo
agentNoThis assistant's display name.
actionYes
anchorNo
documentYesThe MCP document capability from rapier.open. Keep it private and pass it to later calls.
editorKeyNoThe editor key from the Apps UI resource, held by the host and editor alone.
object_idNo
recipientNo
thread_idNo
operation_idYesA fresh random id for this call (a UUID works). Resend it only to retry this call; the retry replays the recorded result.
context_handleNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
causeNo
reasonNo
outcomeYes
pendingNo
changeIdNo
documentNoThe MCP document capability from rapier.open. Keep it private and pass it to later calls.
reviewIdNo
threadIdNo
editCountNo
messageIdNo
structureNo
documentIdNo
transactionNo
representationNo
documentRevisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and readOnlyHint=false, so the mutation/state-change profile is covered structurally. The description adds the anchoring concept (passage/drawing/document) but does not explain what resolve/reopen alter, permission requirements, or that retries replay via operation_id (which lives only in the schema). Adds modest value beyond annotations, no contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single well-formed sentence with the action verbs front-loaded and no wasted filler. It is dense but appropriately sized for the tool's scope; it could trade a few words for the missing routing/parameter context, but as written it is efficient.

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?

An output schema exists, so return values need no explanation, and annotations cover the safety profile. Still, for an 11-parameter tool the description omits how the required document/operation_id and the optional thread_id/recipient relate to the create vs reply vs resolve actions, leaving meaningful 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 low (36%), so the description is expected to compensate. It usefully glosses the action enum (create/reply/resolve/reopen) and the anchor enum (passage/drawing/document), but leaves 9 other parameters – text, agent, recipient, thread_id, object_id, editorKey, context_handle, and the required document – with no natural-language explanation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives specific verbs (creates, replies to, resolves, reopens) and a clear resource (a discussion/comment) plus its scope (anchored to a passage, drawing object, or whole document). An agent can map the four actions onto the action enum. It does not, however, name the sibling that handles reading comments (document.list_comments), so sibling differentiation is only implied.

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?

The description enumerates the actions but never states when to choose this tool over alternatives such as document.list_comments for reading threads, nor any preconditions or exclusions. Usage context is left entirely to inference from the action names.

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.