Skip to main content
Glama

Read model snapshot

layerz_read
Read-only

Returns a UID-native snapshot of a model: model (name, timelines, lists, branches), items (flat, parent_uid carries the hierarchy, each with role, formula, check, note) and revision_id / version_number. Filters: uids, roles, include_children. with_values: true adds the computed series v aligned with the periods p (periods for explicit labels of mixed grains, else granularity), variance adds vv, per_element adds ve for list-mode items, health adds the check report, branch_id computes v and health under one branch's [base, branch] checkout instead of the stacked view. The check report is judged on a branch checkout, not the stacked view: without branch_id, a multi-branch model reports the branch it opens on (health.branch_id) and every branch under health.by_branch. When the response leads with computable: false, errors[] names the broken dependencies (e.g. CIRCULAR_DEPENDENCY) and every series is a zero-filled placeholder.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidsNoFilter by item UIDs
rolesNoFilter by role
healthNoAlso returns the `health` block: non-blocking check violations (lines flagged `check`), evaluated at the finest active grain under a branch checkout rather than the stacked view: the `branch_id` requested, else on a multi-branch model the branch the model opens on (`health.branch_id`) with every branch's verdict under `health.by_branch`. `with_values: true` already includes `health` when the model has checks; this flag returns `health` without the full value series.
periodsNoPeriod labels to scope values to
model_idNoTarget model UUID. Required for user-scoped API keys; validated against the bound model for model-scoped keys.
varianceNoAlso return the variance series `vv` (stacked-all view − base baseline), aligned with `v`. Requires with_values.
branch_idNoBranch whose `[base, branch]` checkout the values `v` and the check report `health` are computed under, instead of the stacked-all view (base-vs-overlay audit); `default` = the base plan alone. An unknown id is rejected. Requires with_values or health.
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. Changed2 schema fields changed
    • changedInput schema / properties / branch_id / description
      Previous value: -"Branch whose `[base, branch]` checkout the values are computed under, instead of the stacked-all view (base-vs-overlay audit); `default` = the base plan alone. Requires with_values."New value: +"Branch whose `[base, branch]` checkout the values `v` and the check report `health` are computed under, instead of the stacked-all view (base-vs-overlay audit); `default` = the base plan alone. An unknown id is rejected. Requires with_values or health."
    • changedInput schema / properties / health / description
      Previous value: -"Also returns the `health` block: non-blocking check violations (lines flagged `check`), evaluated at the finest active grain. `with_values: true` already includes `health` when the model has checks; this flag returns `health` without the full value series."New value: +"Also returns the `health` block: non-blocking check violations (lines flagged `check`), evaluated at the finest active grain under a branch checkout rather than the stacked view: the `branch_id` requested, else on a multi-branch model the branch the model opens on (`health.branch_id`) with every branch's verdict under `health.by_branch`. `with_values: true` already includes `health` when the model has checks; this flag returns `health` without the full value series."
  2. Changed3 schema fields changed
    • changedInput schema / properties / branch_id / description
      Previous value: -"Compute 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."New value: +"Branch whose `[base, branch]` checkout the values are computed under, instead of the stacked-all view (base-vs-overlay audit); `default` = the base plan alone. Requires with_values."
    • changedInput schema / properties / health / description
      Previous value: -"Also return the `health` block: non-blocking check violations (lines flagged `check`). Checks are evaluated at the finest active grain. `with_values: true` already includes `health` when the model has checks; set this to get `health` without the full value series."New value: +"Also returns the `health` block: non-blocking check violations (lines flagged `check`), evaluated at the finest active grain. `with_values: true` already includes `health` when the model has checks; this flag returns `health` without the full value series."
    • changedInput schema / properties / model_id / description
      Previous value: -"Target model UUID. Required for user-scoped API keys; ignored (or validated against scope) for model-scoped keys."New value: +"Target model UUID. Required for user-scoped API keys; validated against the bound model for model-scoped keys."
  3. Changed1 schema field changed
    • changedInput schema / properties / health / description
      Previous value: -"Also 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."New value: +"Also return the `health` block: non-blocking check violations (lines flagged `check`). Checks are evaluated at the finest active grain. `with_values: true` already includes `health` when the model has checks; set this to get `health` without the full value series."
  4. First observed

TDQS

A3.9/5.0
Behavior5/5

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

Annotations already declare readOnlyHint/destructiveHint=false, and the description still adds substantial behavior: the branch-checkout vs stacked-view distinction for health, the multi-branch health.branch_id / health.by_branch fallback, rejection of unknown branch ids, and the failure contract where computable:false pairs errors[] (e.g. CIRCULAR_DEPENDENCY) with zero-filled placeholder series. That is exactly the kind of beyond-annotation context this dimension rewards.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Content is dense but load-bearing, and the return-shape sentence is correctly front-loaded ahead of the flag semantics. It is nonetheless one undivided wall of text with heavily nested clauses, and the health/branch material is duplicated nearly verbatim from the schema, so it is not efficiently structured.

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?

With no output schema, the description carries the full burden of describing returns and does so thoroughly: top-level keys, series naming (v, p, vv, ve), health evaluation semantics, and the error/degraded-computation path. An agent can predict the response shape and failure mode without any other source.

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 schema text is itself verbose (branch_id, health, per_element, granularity all carry their own detailed descriptions), so the schema already does the heavy lifting. The prose largely restates those same semantics rather than adding new ones, which lands at the documented baseline of 3.

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?

The opening clause gives a concrete verb and resource ('Returns a UID-native snapshot of a model') and enumerates the payload shape (model, items, revision_id/version_number), so the agent knows exactly what comes back. It never distinguishes itself from the sibling layerz_get_model or explains which read tool to pick, leaving that gap against a crowded read-side family.

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 gives strong intra-tool conditions ('variance requires with_values', 'branch_id requires with_values or health', 'granularity ignored when periods are provided'), which is real conditional guidance. It offers no when-to-use versus alternatives, however: nothing tells the agent when to choose layerz_read over layerz_get_model, layerz_diff, or layerz_dependencies.

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