Skip to main content
Glama

read_stream_state

Read-only

Read a stream's current state, its current cued message, and event count. Read-only — does NOT advance the stream or consume a cue. Use it between feedback turns to inspect where a patient is in their federally-sourced, audience-safety-checked sequence.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
stream_idYesThe stream_id returned by create_patient_stream.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
_metaYesLegal/disclosure block returned on every 2xx (A1 §6.7).
stateYes
stream_idYes
rate_limitNoDiscovery monthly cue-cap headroom. Absent on non-Discovery tiers (no cap).
current_cueNo
template_idNo
events_countNo
next_cue_eligibleNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already state readOnlyHint=true, so the read-only trait is covered. The description adds valuable behavioral context by stating it does not advance the stream or consume a cue, and it mentions event count. It does not discuss auth or rate limits, but given the read-only annotation, this is sufficient.

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 two sentences, front-loaded with the primary function and a clear behavioral caveat. It provides contextual detail ('federally-sourced, audience-safety-checked sequence') without verbosity. Every sentence earns its place.

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?

The tool is simple with one parameter and an output schema. The description covers the operation scope, when to use it, and what it returns. It is complete enough for an agent to correctly invoke it, especially with the output schema providing return structure.

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% with one parameter, stream_id, well described as 'The stream_id returned by create_patient_stream.' The description does not add extra meaning about the parameter beyond the schema, and it does not mention parameter syntax or formats. It earns the baseline 3 due to full schema coverage.

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 reads a stream's current state, current cued message, and event count. It is distinct from siblings like get_next_cued_message (which likely advances) and create_patient_stream (which creates). The explicit phrase 'does NOT advance the stream or consume a cue' further distinguishes its non-mutating behavior.

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

Usage Guidelines5/5

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

The description gives explicit when-to-use guidance: 'between feedback turns to inspect where a patient is.' It also provides a when-not: 'does NOT advance the stream or consume a cue,' implying that advancing tools like get_next_cued_message should be used elsewhere. This is a clear usage directive.

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