peek_changes

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

With no annotations, description fully discloses behavior: deterministic, wraps pg_logical_slot_peek_changes (peek variant), does not advance slot, returns up to limit rows, data rendering depends on output plugin, and deployment on publisher.

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

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

Three sentences, front-loaded with purpose, no wasted words. Each sentence adds unique value: purpose, determinism+function, return format+deployment.

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

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

Given output schema exists, description still explains return structure (lsn, xid, data) and dependencies. Covers all key aspects for a peek tool.

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

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

Schema has no descriptions (0% coverage). Description adds meaning by explaining 'limit' (up to limit rows, default 20) and implies slot_name via context. Could be more explicit about slot_name but sufficient.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states the verb 'Peek' and resource 'pending changes in a slot', and specifies it does not consume changes. It distinguishes from siblings like 'advance_slot' and 'drop_slot' by focusing on non-destructive inspection.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states to run on the publisher and clarifies that peeking does not advance the slot or consume changes. While no explicit when-not or alternatives among siblings, the context is sufficient for correct use.

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