Skip to main content
Glama

Topic offsets

topic_offsets
Read-onlyIdempotent

Retrieve earliest and latest offsets for each partition of a topic to assess message backlog and consumer progress.

Instructions

Earliest and latest offsets per partition for a topic (message backlog view).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYesTopic name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare the operation read-only, idempotent, and non-destructive, so the description's main contribution is the per-partition, earliest/latest offset semantics. It adds useful context but does not disclose additional behavioral details such as error handling or partition ordering.

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

Conciseness5/5

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

The description is a single, information-dense sentence with no filler. The core output semantics are front-loaded and the parenthetical clarifies the purpose efficiently.

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?

This is a simple one-parameter, read-only tool with strong annotation coverage. The description adequately explains the result shape—earliest and latest offsets per partition—which is sufficient even without an output schema.

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% for the single required topic parameter, and the schema already describes it as 'Topic name'. The description does not need to add parameter detail and provides none beyond the context that the topic's offsets are returned.

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 clearly states the tool returns earliest and latest offsets per partition for a topic. This distinguishes it from siblings like list_topics and describe_topic, which focus on metadata or enumeration rather than offsets/backlog.

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 phrase 'message backlog view' implies this tool is for backlog/consumer-lag analysis, but it does not explicitly state when to use it versus alternatives or when not to use it. Usage context is implied rather than stated.

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