stream_stop
Stop a polling stream and optionally remove its in-memory buffer.
Instructions
Stop a polling stream and optionally remove its in-memory buffer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Returned job or stream ID | |
| remove | No |
Stop a polling stream and optionally remove its in-memory buffer.
Stop a polling stream and optionally remove its in-memory buffer.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Returned job or stream ID | |
| remove | No |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already disclose that this is a non-read-only, non-idempotent, non-destructive operation. The description adds useful context that remove optionally clears the in-memory buffer, but it does not explain irreversibility, behavior when the stream is already stopped, or any authentication constraints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single front-loaded sentence with no wasted wording. It states the action and the optional buffer-removal behavior efficiently.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple two-parameter stream-control tool with annotations and no output schema, the description is largely complete. It could mention return behavior or error conditions, but it covers the core action and optional cleanup needed to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 50%, and the remove parameter has an empty schema description. The description compensates by explaining that remove deletes the in-memory buffer and that it is optional, while id is already documented in the schema as the stream/job ID.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: stop a polling stream. It also states the optional buffer-removal effect, making the operation unambiguous and distinguishable from stream_start, stream_poll, and stream_list.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The purpose implies when to use it, but there is no explicit guidance on when not to use it, when to set remove=true, or how it relates to the sibling stream tools. The usage is inferable but not spelled out.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.