Skip to main content
Glama

get_pipeline_batches

Read-onlyIdempotent

Retrieve recent CDC batches for a named pipeline to inspect throughput and sync progress; exclude QRep.

Instructions

Get recent CDC batches to inspect throughput and sync progress; not for QRep.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
limitNo
before_idNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile needs no restating. The description only adds that the payload is CDC batch data rather than QRep, and says nothing about cursor/pagination behavior implied by before_id or about volume controls.

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?

A single compact sentence with the action and resource front-loaded and the QRep exclusion trailing. No filler, though the QRep clause assumes domain familiarity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return-value explanation is unnecessary, and annotations cover the safety profile. What remains missing is parameter-level guidance for a tool whose schema documents nothing, leaving an agent without direction on how many batches are returned or how to page.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description carries the full burden for name, limit and before_id, yet it explains none of them. It does not clarify that 'name' is the pipeline identifier, nor that limit caps batch count or that before_id is a backward pagination cursor.

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?

States a specific verb+resource (get recent CDC batches) plus the reason for doing so (inspect throughput and sync progress), and scopes out QRep replication. It is distinguishable from siblings like get_pipeline_status or get_pipeline_errors because it targets batch-level CDC data, though no sibling is named directly.

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?

Gives a clear usage context (throughput and sync progress inspection) and an explicit exclusion ('not for QRep'), which is meaningful guidance. It stops short of naming which tool to use instead for QRep data, so it is not a full when/when-not/alternative statement.

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