Skip to main content
Glama

List book snapshots

list_book_snapshots
Read-onlyIdempotent

Lists the workspace's book snapshots, oldest first: each one's snapshot_id (which create_view_link takes), chart_id, label, as_of, the sealed book's identity and entry count, and when it was sealed. Read-only and not metered.

Input Schema

NameRequiredDescriptionDefault
workspace_tagYesActive workspace id (the workspace_tag create_workspace and list_workspaces return).

Output Schema

NameRequiredDescriptionDefault
engineYesStamped engine build/version identity for the tool result.
statusYesbook_snapshots_listed on success.
row_countYesHow many snapshots.
snapshotsYesEach snapshot: snapshot_id, chart_id, label, as_of, book_identity, entry_count, created_at.
workspace_tagYesWorkspace scoped by the tool call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the bar is lower; the description still adds real value with the ordering guarantee ("oldest first") and the metering note ("not metered"), which annotations do not cover. It omits any pagination or result-size behavior, which is the main remaining gap for a list tool.

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?

One front-loaded sentence with the verb first, no filler, and every clause carrying information (ordering, field list, cross-tool link, metering). Nothing could be removed without losing signal.

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?

An output schema exists, so the field enumeration is partly redundant, but it usefully highlights snapshot_id as the handoff value for create_view_link. An agent has everything needed to call this correctly; only pagination/result limits are unaddressed.

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% and the single workspace_tag parameter is already documented as the active workspace id returned by create_workspace and list_workspaces. The description adds no further parameter semantics, so the baseline of 3 applies.

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 ("Lists the workspace's book snapshots") with scope and ordering ("oldest first") plus the fields returned. An agent can immediately distinguish it from create_book_snapshot or list_charts without opening a schema.

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

Usage Guidelines4/5

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

The parenthetical "each one's snapshot_id (which create_view_link takes)" gives a concrete downstream reason to call this tool, effectively naming the follow-up tool. It stops short of explicit when-not guidance or naming list_events/list_review_items as alternatives, but the usage context is clear.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources