Skip to main content
Glama

Get catalog stats

estuary_get_catalog_stats
Read-only

Get usage/throughput stats for one catalog entity — bytes & docs read/written (both directions), usage_seconds, warnings/errors/failures, and txn_count — per time grain. Optionally bound by a timestamp range. Estuary control-plane view catalog_stats. PostgREST: GET /catalog_stats.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
grainNoTime grain of each stats row (default daily).
limitNoMax rows to return (PostgREST limit).
ts_endNoFilter: stats at/before this ISO 8601 timestamp (ts lte).
ts_startNoFilter: stats at/after this ISO 8601 timestamp (ts gte).
catalog_nameYesThe exact catalog name to report stats for.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description goes further by disclosing the returned metric set, the per-time-grain aggregation, and the optional timestamp bounding — valuable behavioral context given there is no output schema. It stops short of covering ordering or pagination behavior beyond the limit param.

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?

Three compact sentences, front-loaded with what is returned before the optional filtering and provenance details. The PostgREST endpoint mention is marginally useful but is the one element that could be trimmed.

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?

No output schema exists, but the description compensates by naming the returned fields, and annotations cover the read-only safety profile. Remaining gaps (row ordering, whether limit defaults, behavior with no matching rows) are minor for a read-only stats query.

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 coverage is 100%, so grain, limit, ts_start/ts_end and catalog_name are already documented with formats and defaults. The description only restates that results are per time grain and optionally time-bounded, adding no syntax or edge-case detail beyond the schema — baseline 3 is appropriate.

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 (get) and resource (catalog stats) and enumerates the exact metrics returned — bytes/docs read/written, usage_seconds, errors, txn_count — so an agent can distinguish it from estuary_get_catalog_spec or estuary_list_catalog at a glance. Names the backing view and endpoint, reinforcing scope.

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?

Usage is implied rather than stated: it retrieves per-grain usage stats for one entity, optionally time-bounded. There is no explicit when-to-use/when-not guidance or routing to siblings (e.g., use get_catalog_spec for configuration), so an agent must infer the boundary itself.

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.