Skip to main content
Glama

sr_rescan

Destructive

Refresh a storage repository's metadata to resolve stale or inconsistent SR state. Preview changes with dry-run before applying; no data change or undo is recorded.

Instructions

[WRITE][risk=medium] Rescan an SR (metadata refresh — no data change, no undo).

Lowest-impact write in this tool, but a write nonetheless: it refreshes SR
metadata and records no undo (there is no prior state to restore).

Args:
    sr_id: SR uuid (see sr_list).
    dry_run: If True, preview without rescanning.
    target: Xen Orchestra target name from config; omit for the default.

Input Schema

NameRequiredDescriptionDefault
sr_idYes
targetNo
dry_runNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare it a non-read-only, non-idempotent write, and the description usefully reconciles this by stating nothing is destroyed ("no data change") and no undo record exists. It adds the dry_run preview mechanism, but it never explains idempotency, expected duration, or failure behavior, leaving some tension with destructiveHint=true unaddressed.

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 risk tag and purpose sentence are front-loaded, followed by a compact rationale and an Args block — a good structure. It is slightly repetitive, restating the "no undo" point twice ("no data change, no undo" and "records no undo (there is no prior state to restore)").

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

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, 3 parameters, and a mutation annotation set, the description covers the essentials: write class, destructiveness, undo, dry-run, and all parameters. What it omits — return shape, whether the rescan is long-running, and retry/idempotency expectations — is minor for a metadata refresh.

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

Parameters5/5

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

Schema description coverage is 0%, so the description carries the full burden and does: sr_id is typed as an SR uuid with a cross-reference to sr_list, dry_run is described as a non-destructive preview, and target is explained as an XO target name sourced from config with an omit-for-default behavior.

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 and resource ("Rescan an SR") and immediately qualifies scope with "metadata refresh — no data change, no undo," plus a [WRITE][risk=medium] tag that separates it from the read-only siblings like sr_list/sr_get. It does not explicitly name a competing sibling to route against (e.g., sr_usage_rca), so it falls just short of the top band.

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?

Usage is only implied: the tool is framed as the "lowest-impact write" for refreshing metadata, and the dry_run argument hints at a preview-then-commit workflow. There is no explicit "use this when X / use Y instead" and no exclusions relative to sr_list, sr_get, or sr_usage_rca.

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