Skip to main content
Glama

Read model snapshot

layerz_read
Read-only

Read model snapshot (items + optional computed values). Filter by UIDs or roles. Pass with_values=true to compute. If the response leads with computable: false, the DAG is broken (see errors[], e.g. CIRCULAR_DEPENDENCY): every series is a degenerate zero-fill — fix the model before reasoning on values.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidsNoFilter by item UIDs
rolesNoFilter by role
healthNoAlso return the `health` block: non-blocking business-monitor violations. Monitors are evaluated at the finest active grain. `with_values: true` already includes `health` when the model has monitors; set this to get `health` without the full value series.
periodsNoPeriod labels to scope values to
model_idNoTarget model UUID. Required for user-scoped API keys; ignored (or validated against scope) for model-scoped keys.
varianceNoAlso return the variance series `vv` (stacked-all view − base baseline), aligned with `v`. Requires with_values.
branch_idNoCompute values under a single branch's `[base, branch]` checkout instead of the stacked-all view — lets you audit base-vs-overlay (e.g. confirm the budget on the base, or what one branch changed). Pass `default` for the base plan alone. Requires with_values.
granularityNoGrain for `v`/`p` when no explicit `periods` are given. 'native' = finest active dated grain (monthly>quarterly>yearly). Default: 'yearly'. Ignored when `periods` are provided (each label resolves its own grain).
per_elementNoAlso return `ve`: per-element series for list-mode items, keyed `ve[itemUid][elementLabel]` and aligned with `p` (e.g. payroll split by Business Unit). Without it, `v` only carries the aggregate. Requires with_values.
with_valuesNoCompute and return values for matched items
include_listsNoWhich named lists to embed in `model.lists`: 'referenced' (default — only lists used by the returned items via liste_ref), 'all', or 'none'.
include_childrenNoInclude descendants of filtered containers

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is known. The description adds significant behavioral context: the `computable: false` response leading indicator, the meaning of a broken DAG (CIRCULAR_DEPENDENCY), and the degenerate zero-fill behavior. It also explains the effect of with_values and branch_id on computation. This goes well beyond the annotations.

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 description is compact and front-loaded with the core purpose. The second sentence about `computable: false` is valuable but slightly dense; it could be split for readability. Overall, every sentence earns its place, and the structure is efficient.

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?

Given the tool's complexity (12 params, no output schema), the description covers the key behavioral edge case (broken DAG) and the main computation flags. It doesn't explain return value structure in detail, but with no output schema, the description could do more to describe what the response looks like. However, the description's focus on the critical failure mode and parameter interactions makes it largely complete 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 description coverage is 100%, so the schema already documents all 12 parameters. The description adds some context (e.g., 'with_values=true to compute', 'branch_id lets you audit base-vs-overlay'), but most parameter semantics are already in the schema. Baseline 3 is appropriate because the description doesn't need to compensate for missing schema docs.

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?

The description states a specific verb ('Read') and resource ('model snapshot'), and clarifies it returns items plus optional computed values. It distinguishes itself from siblings by mentioning filtering by UIDs or roles and the optional with_values computation, which is unique among the listed tools.

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 description gives clear context on when to use this tool: to read a model snapshot, filter by UIDs/roles, and compute values. It doesn't explicitly name alternatives or exclusions, but the sibling list shows many other tools (e.g., layerz_get_model, layerz_dependencies) and the description's focus on snapshot reading with optional computed values implies when it's appropriate. It lacks explicit 'use X instead' guidance, so not a 5.

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