Skip to main content
Glama

Rapier

Return a visual observation

document.visual_ack

Returns the editor-rendered observation for one exact visual request.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
factYes
documentYesThe MCP document capability from rapier.open. Keep it private and pass it to later calls.
visualIdYes
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 declare readOnlyHint=false and idempotentHint=false, so an agent knows this is a non-idempotent, state-affecting call. The description's 'Returns' framing does not explain what the acknowledgement mutates, how expectedRevision is enforced, or what happens on a mismatch, leaving the non-destructive but write-ish semantics unexplained.

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, front-loaded sentence with no filler. It is efficient, though its brevity is partly the cause of the missing guidance rather than a strength of precision.

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 tool with 5 required parameters, nested objects, an output schema, and a non-idempotent annotation profile, the description is far too thin. It omits the revision-matching contract and the acknowledgement semantics an agent would need to call it correctly.

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 40% across 5 required parameters, and the description adds zero parameter meaning. It does not clarify the roles of expectedRevision, visualId, or the nested 'fact' object, so it fails to compensate for the coverage gap.

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 gives a verb+resource ('Returns the editor-rendered observation') and a scope ('for one exact visual request'), which is more than a tautology. However, 'observation' and 'visual request' are abstract, and it does not distinguish itself from close siblings like document.view_ack or document.inspect_visual.

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 statement of when to call this tool, what triggers an 'ack', or which sibling alternative to use. The 'one exact visual request' phrase hints at a matching precondition but never states it, so usage must be inferred.

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.