Skip to main content
Glama

Create book snapshot

create_book_snapshot

Seals one set of books as it stands through a date and keeps it, never changed: official results, such as a quarter close. The snapshot is the workspace's book for chart_id (as create_standard_book reads it): its chart and every current entry dated on or before as_of (every current entry when as_of is absent), sealed by this server. Corrections made later to that period are not in it; take another snapshot to capture them. Each call adds a snapshot; none is ever altered or removed. Open one with create_view_link and its snapshot_id; list them with list_book_snapshots. Durable mutation; no model and not metered.

Input Schema

NameRequiredDescriptionDefault
as_ofNoYYYY-MM-DD: the last day the snapshot covers, e.g. a quarter's end. Every current entry when absent.
labelYesWhat the snapshot is, as people will know it, e.g. "Q2 2026 close". At most 200 characters.
chart_idYesThe chart whose books to seal (list_charts).
workspace_tagYesActive workspace id (the workspace_tag create_workspace and list_workspaces return).

Output Schema

NameRequiredDescriptionDefault
bookYesWhich book was sealed: identity, chart_identity, name, reporting_currency and its counts, as verify_standard_document reports them.
as_ofNoThe last day it covers; null for every current entry.
labelYesThe snapshot's label.
engineYesStamped engine build/version identity for the tool result.
statusYesbook_snapshot_created on success.
chart_idYesThe chart sealed.
created_atYesWhen it was sealed.
snapshot_idYesThe snapshot: create_view_link takes it.
workspace_tagYesWorkspace scoped by the tool call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations it discloses the key behaviors: each call appends a new snapshot, none is ever altered or removed, and the sealed content is frozen at as_of. It also clarifies operational traits (durable mutation, no model, not metered) that the annotations cannot express, and its 'nothing destroyed' framing is consistent with destructiveHint=false.

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?

Front-loads the core definition before the mechanics and every sentence carries information. There is mild redundancy between 'keeps it, never changed' and 'none is ever altered or removed', and the trailing 'Durable mutation; no model and not metered' is terse to the point of being cryptic.

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?

For a non-idempotent mutation with an output schema, the description covers the mutation semantics, immutability guarantee, cutoff behavior, and downstream retrieval path. Return values are covered by the output schema, so nothing an agent needs to invoke it 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 100%, so the per-field descriptions already carry the basics; the description adds the interaction between chart_id and as_of (the chart whose books are sealed, cut off at as_of) and the default when as_of is absent. It does not add format or edge-case detail beyond that, so it sits just above the baseline.

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 (seals) and resource (a set of books through a date) with concrete scope: chart plus every current entry dated on or before as_of. It explicitly distinguishes itself from create_view_link (read/open) and list_book_snapshots (list), so the agent can place it without opening any schema.

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 trigger scenario (quarter close / official results), the exclusion (later corrections are not captured; take another snapshot), and the follow-up alternatives by name (create_view_link with snapshot_id, list_book_snapshots). Nothing is left to inference about when this is the right call.

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