Skip to main content
Glama

Subscribe Events

subscribe_events

Register the session to receive server-push notifications when catchup downloads finish, fail, or are cancelled; call once after connecting and again after reconnecting.

Instructions

Register this session for server-push download events.

Call once after connecting (and again after reconnecting; repeat calls are harmless). When a download finishes, fails or is cancelled, the server pushes an MCP log notification with logger="events" and a payload like {"event": "download_finished", "title": ..., "output": ..., "message": ...}. The first subscription from a client covers downloads that end from then on; later ones also catch up on any that ended while disconnected. Requires a persistent session (stdio).

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses idempotency, the stdio persistent-session prerequisite, the notification channel (logger="events"), the payload shape with concrete keys, and the catch-up semantics on reconnect. That is exactly the mutation/side-effect context annotations would otherwise supply.

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?

Front-loaded with the action, then timing, payload, and reconnect semantics, with essentially no filler. Minor deduction because the hard prerequisite ('Requires a persistent session (stdio)') is buried in the final line rather than surfaced early where a failure would be caught.

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?

Covers everything an agent needs for a zero-param subscription tool: when to call, what arrives asynchronously, the payload contract, and the environment constraint. The output schema plus the described push payload leave no ambiguity about return behavior.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline applies. It does not need to compensate for any schema gap here.

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 ('Register this session for server-push download events'), which cleanly separates it from the polling-style siblings such as download_status, list_downloads and download_programme. An agent can tell this is a subscription/registration call rather than a query.

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?

Gives explicit timing ('Call once after connecting', 'again after reconnecting') and reassures that repeat calls are harmless. It stops short of naming an alternative or a when-not-to-use condition, e.g. it never says whether this replaces or complements polling via download_status.

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