Skip to main content
Glama
jdzhrch

OpenCivicQuery

by jdzhrch

pin_snapshot

Preserves a temporary query snapshot indefinitely so a published story can cite auditable, frozen evidence from the snapshot URI returned by query_dataset.

Instructions

Preserve a temporary query snapshot indefinitely for a published story. Use the snapshot URI returned by query_dataset.

Input Schema

NameRequiredDescriptionDefault
snapshot_uriYesThe snapshot URI that query_dataset returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose the key trait — a temporary snapshot becomes permanent/indefinite — but omits permissions required, what happens if the snapshot has already expired, and whether the pin is reversible.

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?

Two sentences, both earning their place, with the action and durability effect front-loaded followed by the provenance hint. Nothing is padded, though it is terse enough that slightly more behavioral detail could have fit.

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?

A one-parameter, non-read-only action with full schema coverage and no output schema needs little prose, and the description covers the core effect. Missing only edge-case behavior such as expiry or permission failures, which is a modest gap rather than a blocking one.

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 snapshot_uri is already documented in the schema. The description only restates its provenance ('returned by query_dataset'), which is minor added value; baseline 3 applies when the schema does the heavy lifting.

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 (preserve/pin) plus resource (temporary query snapshot) and the resulting effect (indefinitely). The qualifier 'for a published story' narrows scope, and the mention of query_dataset clearly separates it from the retrieval sibling get_snapshot.

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 description implies usage ('Use the snapshot URI returned by query_dataset') but never states when a caller should pin versus leave a snapshot temporary, nor does it mention any alternative or inverse operation. A usable hint exists, but the when/when-not decision is left to inference.

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