Skip to main content
Glama

read_events

Retrieve buffered OPC UA subscription events oldest first, removing returned items from the buffer and reporting dropped or remaining events so you can track completeness.

Instructions

Read the events buffered by subscribe_events, oldest first. The events returned are removed from the buffer, so a second call returns only what has arrived since. If the buffer overflowed in the meantime, the result says how many were dropped rather than quietly skipping them — in the structured result's completeness, which also says whether more are still buffered.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of events to return (default 50).
node_idNoThe subscribed notifier node to read from, as passed to subscribe_events. Defaults to the Server object 'ns=0;i=2253'.

Output Schema

NameRequiredDescriptionDefault
resultYes
completenessYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations declare readOnlyHint=false and idempotentHint=false, and the description explains exactly why: returned events are removed from the buffer, making the call non-idempotent. It further discloses overflow behavior and points at the `completeness` field in the structured result, adding real behavioral context beyond the annotations.

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?

Three sentences, each carrying distinct information: source and ordering, drain semantics, and overflow reporting. Front-loaded with the core action and no redundant restatement of the tool name.

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?

For a two-optional-parameter read tool with an output schema, the description covers the essential non-obvious behavior: buffer draining, ordering, and where overflow/drop counts appear. Nothing an agent needs in order to call it correctly is missing.

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 description coverage is 100%, so `limit` and `node_id` are already documented in the schema. The description adds no additional meaning about parameter behavior or interactions, which is acceptable given the schema does the heavy lifting, but it does not exceed the baseline.

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 and resource ('Read the events buffered by subscribe_events') plus ordering semantics ('oldest first'), which cleanly separates this from history-oriented siblings like read_event_history. An agent can tell what it returns and where the data comes from without opening the schema.

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?

The description makes the prerequisite explicit by tying the tool to subscribe_events, and clarifies the calling pattern ('a second call returns only what has arrived since'). It does not explicitly contrast with read_event_history or state when to prefer one over the other, so it is clear context without full exclusion guidance.

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