Skip to main content
Glama

Poll Premium Stream Events

sap_premium_stream_poll

Long-poll buffered premium stream events for an active session. Returns events that have been delivered to the server-side event buffer since the last poll. This is the MCP-compatible alternative to holding open an SSE connection — call this tool periodically to drain the event buffer. This tool is transport-agnostic: because it is a standard MCP tool call (request/response), it works over any MCP transport including stdio, streamable-http, and WebSocket-based MCP transports. There is no need for a separate WebSocket endpoint — this poll tool IS the WebSocket-compatible consumption path. Events are returned oldest-first. Use the sinceEventId cursor from the last poll to fetch only new events. If no events are available, the tool will wait up to waitMs (default 15s, max 30s) for events to arrive before returning an empty array — this gives near-real-time delivery without repeated polling. Set waitMs=0 for instant return.

SAP MCP execution guidance: Intent: SAP MCP tool workflow. Pricing: free; call directly without x402. Routing: free hosted call; call directly and keep it small/exact when possible. Signer boundary: hosted reads/builders never receive keypair bytes; value-moving results must be finalized locally when signing is required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
waitMsNoLong-poll wait timeout in milliseconds. If no events are available, the tool waits up to this duration for events to arrive before returning. Default: 15000 (15s). Max: 30000 (30s). Set to 0 for instant return.
eventTypeNoOptional event type filter. Only events matching this type are returned.
maxEventsNoMaximum number of events to return in a single poll. Default: 10, max: 100.
sessionIdYesActive premium session id whose stream events should be polled.
sinceEventIdNoOptional event id cursor. Only events delivered after this event id are returned. Use the last event id from the previous poll to paginate.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
hintNoOptional hint message, e.g. when delivery loop was just auto-started and no events have arrived yet.
eventsYesBuffered premium events matching the poll query, ordered oldest-first.
hasMoreYesTrue if more events are available in the buffer beyond this batch. Call again to drain remaining events.
sessionStatusYesCurrent session status (active, closed, not_found).
unitsRemainingNoRemaining billable units in the session quota, if the session is active.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / waitMs
      Added value: +{
      +  "description": "Long-poll wait timeout in milliseconds. If no events are available, the tool waits up to this duration for events to arrive before returning. Default: 15000 (15s). Max: 30000 (30s). Set to 0 for instant return.",
      +  "maximum": 30000,
      +  "minimum": 0,
      +  "type": "number"
      +}
    • addedOutput schema / properties / hint
      Added value: +{
      +  "description": "Optional hint message, e.g. when delivery loop was just auto-started and no events have arrived yet.",
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • changedInput schema / description
      Previous value: -"Poll Premium Stream Events input schema. Intent: SAP MCP tool workflow. Pricing: paid read-premium; estimate first, then use sap_payments_call_paid_tool when the runtime cannot replay x402 natively. Routing: paid hosted call; call sap_estimate_tool_cost first, then use sap_payments_call_paid_tool if the runtime cannot handle x402 natively. Signer boundary: hosted reads/builders never receive keypair bytes; value-moving results must be finalized locally when signing is required. Use exact field names from this schema; do not guess aliases or include private key material."New value: +"Poll Premium Stream Events input schema. Intent: SAP MCP tool workflow. Pricing: free; call directly without x402. Routing: free hosted call; call directly and keep it small/exact when possible. Signer boundary: hosted reads/builders never receive keypair bytes; value-moving results must be finalized locally when signing is required. Use exact field names from this schema; do not guess aliases or include private key material."
  3. Added

TDQS

A4.4/5.0
Behavior4/5

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

The description adds valuable behavioral context beyond annotations: long-poll mechanics, event ordering, waitMs semantics, and transport-agnostic property. It does not contradict annotations (readOnlyHint=false, openWorldHint=true).

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?

The description is front-loaded with purpose and well-structured. It contains some verbosity (SAP guidance repeats schema notes) but remains efficient. Could trim slightly without losing value.

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?

Given the presence of an output schema, the description fully covers usage: polling mechanism, cursor, timeout, transport, and filter options. No gaps remain for an agent to invoke correctly.

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

Parameters4/5

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

Schema coverage is 100%, so baseline 3. The description enhances understanding with defaults, maximums, and usage patterns (e.g., 'Use the last event id from the previous poll').

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 uses specific verbs ('long-poll', 'drain') and identifies the resource ('premium stream events for an active session'). It distinguishes itself from SSE and alternative transports, making the tool's role clear among siblings.

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 explicitly advises periodic calls and provides cursor-based pagination guidance. It contrasts with SSE and notes transport-agnostic usage. However, it lacks explicit when-not-to-use scenarios or direct alternatives.

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.