Skip to main content
Glama

aiworkhub_dashboard_storage_restore

USER WRITE: restore a quarantined worker-worktree batch back to the repository worktree root.

Instructions

USER WRITE: restore a quarantined worker-worktree batch back to the repository worktree root.

Use this to roll back a quarantine batch listed by aiworkhub_dashboard_storage_retention_preview; use aiworkhub_dashboard_storage_purge to permanently delete an expired batch instead. Requires confirm=True, moves quarantined directories back without overwriting existing paths, reinstates Git worktree registrations when applicable, updates the batch manifest and audit log, and invalidates storage telemetry.

Input Schema

NameRequiredDescriptionDefault
confirmNobool (default False); must be True to execute the restore.
batch_idYesstr identifier of the storage quarantine batch to restore.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.12.62
    • addedInput schema / properties / batch_id / description
      Added value: +"str identifier of the storage quarantine batch to restore."
    • addedInput schema / properties / confirm / description
      Added value: +"bool (default False); must be True to execute the restore."
  2. First observedv0.1.0

TDQS

A4.6/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 does so: it declares the confirm=True gate, that existing paths are not overwritten, that Git worktree registrations are reinstated, that the batch manifest and audit log are updated, and that storage telemetry is invalidated. These are non-obvious side effects an agent could not infer from the schema.

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 lead sentence front-loads the operation, and the following sentence packs the routing rule and side effects without filler. The second sentence is dense with several clauses, but each clause carries information an agent needs.

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 not be explained. Given the absence of annotations and the mutation's complexity, the description covers the safety gate, collision behavior, registration handling, and bookkeeping updates – enough for an agent to call it correctly.

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 100%, so both parameters are already documented in the schema. The description restates the confirm=True requirement and implies batch_id identifies the quarantine batch, adding no format, ID-shape, or sourcing detail beyond the structured fields – baseline 3 is appropriate.

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 specific verb and resource with scope: 'restore a quarantined worker-worktree batch back to the repository worktree root'. It also distinguishes itself from the two nearest siblings, retention_preview and purge, by name.

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?

Explicitly says to use it 'to roll back a quarantine batch listed by aiworkhub_dashboard_storage_retention_preview' and to use 'aiworkhub_dashboard_storage_purge to permanently delete an expired batch instead'. Both the when and the when-not are given with the alternative named.

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

Deploy Server

Other Tools