Skip to main content
Glama

Rapier

Acknowledge editor presentation

document.view_ack

Reports whether the requested passage or difference was presented.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
reasonNo
statusYes
viewIdYes
documentYesThe MCP document capability from rapier.open. Keep it private and pass it to later calls.
editorKeyYesThe editor key from the Apps UI resource, held by the host and editor alone.
expectedRevisionYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
causeNo
reasonNo
outcomeYes
documentNoThe MCP document capability from rapier.open. Keep it private and pass it to later calls.
reviewIdNo
documentIdNo
representationNo
documentRevisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.4/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and idempotentHint=false, so the safety/mutation profile is covered. The description adds nothing beyond that and, if anything, uses read-only language ('Reports') that sits awkwardly against the non-readOnly annotation. No auth requirements, side effects, or state changes are disclosed.

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

Conciseness3/5

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

It is a single sentence with no padding, so it is concise. But it is under-specified rather than well-structured, and there is no front-loaded framing of the action or its prerequisites.

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

Completeness2/5

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

For a six-parameter, five-required tool that mutates acknowledgement state, the description is too thin. An output schema exists so return values need not be explained, but usage context, status semantics, and relationship to visual_ack are all absent.

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 only 33% – four of six parameters (reason, status, viewId, expectedRevision) are undocumented. The description compensates for none of them; phrases like 'requested passage or difference' only loosely gesture at viewId/status and give no enum meaning or format detail.

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

Purpose3/5

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

The description states a verb ('Reports') and an object ('whether the requested passage or difference was presented'), so the purpose is decipherable. However, it is soft and passive, and it does not distinguish this tool from its near-twin sibling document.visual_ack, nor does it clearly convey the 'acknowledge' action implied by the title.

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?

There is no when-to-use guidance, no when-not-to-use, and no mention of the closely related document.visual_ack sibling. The agent is left to infer when this ack is appropriate versus the many other document.* tools.

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.