Skip to main content
Glama

revise_proposal

Replace all pending proposal shapes with a validated new set in one all-or-nothing, undoable journal step, leaving accepted shapes untouched.

Instructions

Replace EVERY still-pending shape in a proposal with a new set, as ONE journal step (#365) — the move for "I re-measured and got a better batch". The old pending shapes go, the replacements commit under the same proposal, and undo_last puts the previous batch back exactly. All-or-nothing: the whole replacement is validated (sheet, scale, vertex count, a height for surface_area) before the first pending shape is removed, so a malformed last shape leaves the batch untouched and the error says which entry and why. Shapes the estimator already accepted are ink — they stay, and they are not part of what this replaces. verts are image px like every other tool; roles and minimums match the measure tools (floor_area/deduct ≥3, linear/surface_area ≥2, count 1). An empty shapes list is refused — withdraw_proposal is the verb for that. Coordinates are image px at render scale 2.0: PDF pt × 2, origin top-left, y down (the browser canvas's native space). Sheet payloads carry dims in both px and pt.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shapesYes
proposal_idYesThe batch, from propose_takeoff

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYes
labelYes
replacedYesPending shapes removed from the batch
committedYesReplacement shapes committed, all attached to the same batch
shape_idsYes
proposal_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.21

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and delivers: atomic all-or-nothing validation before any removal, the exact validation checks (sheet, scale, vertex count, height for surface_area), error reporting ('which entry and why'), undo_last restoring the prior batch exactly, and that accepted shapes are untouched. This is unusually complete behavioral disclosure.

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?

The core action is front-loaded in the first clause, and nearly every sentence earns its place. It is dense and long with stacked parentheticals, which slightly hurts scannability but not correctness.

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

Completeness5/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 the description fully covers the mutation's transactional semantics, validation rules, coordinate space, and role constraints. Nothing an agent needs to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 50%, so the description must compensate and does: it specifies verts are image px, role minimums per role type (floor_area/deduct >=3, linear/surface_area >=2, count 1), and the coordinate convention (scale 2.0, pt x 2, origin top-left, y down). This adds real meaning beyond the schema, though proposal_id is only lightly addressed.

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

Purpose5/5

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

States a precise verb+resource+scope: 'Replace EVERY still-pending shape in a proposal with a new set, as ONE journal step.' It distinguishes itself from siblings by naming what it is not (accepted shapes stay; empty list routes to withdraw_proposal) so an agent can tell it apart from propose_takeoff and withdraw_proposal.

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

Usage Guidelines5/5

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

Gives the explicit condition for use ('I re-measured and got a better batch') and the explicit exclusion ('An empty shapes list is refused — withdraw_proposal is the verb for that'), which routes the agent to the correct alternative verb by name.

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