Skip to main content
Glama

Rapier

Refresh the editor

document.sync
Read-onlyIdempotent

Returns this editor's workspace snapshot, or unchanged while afterRevision and afterVersion still hold.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
afterVersionNo
afterRevisionNo

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

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds one genuine behavioral trait beyond them: the call can return 'unchanged' when afterRevision/afterVersion still hold, implying a snapshot-diff/conditional-refresh semantic. It says nothing about latency, blocking/waiting, or the sensitivity of editorKey, so it lands at an adequate 3.

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 compact sentence, front-loaded with the primary return behavior. The second clause is awkwardly worded ('or unchanged while afterRevision and afterVersion still hold'), which costs a point, but there is no filler.

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 not be described, and the description does cover the conditional unchanged case. However, for a 4-parameter, 2-required tool with 50% schema coverage and no usage framing against 27 sibling document tools, the definition leaves the agent guessing about when to choose this over the other context/read tools.

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 coverage is only 50%: afterVersion and afterRevision have no schema descriptions at all, and document/editorKey do. The description's clause about those two parameters still 'holding' hints that they act as cursor/version tokens for the unchanged-return condition, which is real added meaning, but it is ambiguous phrasing that never states they are cursors from a prior response.

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 states a specific verb and resource: 'Returns this editor's workspace snapshot.' That is clear enough to distinguish a read/snapshot tool from write siblings like document.apply_edits or document.commit. It does not name any sibling explicitly, so it stops short of a 5.

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 versus alternatives such as document.get_context, document.read_context, or document.find. The trailing clause implies a polling/no-op condition but never frames it as usage guidance or an exclusion. An agent must infer the call context entirely.

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.