Skip to main content
Glama

perch_write

Replace an entire pane's document with new content, enabling agents to overwrite Perchance generator source or output text.

Instructions

Replace an entire pane's document with new content.

Input Schema

NameRequiredDescriptionDefault
paneNoDefault output
settleNoSettle Yjs sync after write. Default true
contentYesFull new document text

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations, the description carries the full burden and it does disclose the key behavioral trait: this is a destructive wholesale overwrite of the pane's document. It omits everything else an agent would want — reversibility/undo, whether existing history is preserved, permission or session requirements, and return behavior.

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?

A single sentence with zero filler, and the destructive scope ('entire') is front-loaded where an agent will see it first. Nothing to trim.

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?

For a 3-parameter, fully documented mutation tool with no output schema and no annotations, the description covers the core action but is thin on the two things the structured fields cannot supply: sibling selection guidance and behavioral/safety traits.

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 panes, settle, and content semantics are already documented in the schema. The description adds no syntax, format, or default-caveat information beyond that, so baseline 3 applies.

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?

States a specific verb ('Replace') and resource ('an entire pane's document'), which is enough for an agent to know this is a full-document overwrite. It does not, however, name or contrast with the obvious siblings perch_edit/perch_patch/perch_copy_lines that also write content, so differentiation is only implicit.

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

Usage Guidelines3/5

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

The word 'entire' implies the when-to-use condition (whole-document replacement rather than incremental editing), but no alternative is named and no prerequisites or exclusions are stated. Usage is inferable rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.