stop_stream

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

With no annotations, the description bears full responsibility for behavioral disclosure. It only states 'stop', which implies halting the stream without deletion, but omits side effects, permissions required, or consequences for ongoing jobs or data. The description does not elaborate on what happens to the stream's resources.

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 extremely concise, consisting of a single sentence that is front-loaded and contains no redundant information. Every word earns its place, making it easy to parse quickly.

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?

Given the simple nature of the tool (one required parameter, no nested objects), the description should still cover preconditions, return values, and side effects. The presence of an output schema is not mentioned, and the description fails to inform the agent about what to expect after stopping the stream, such as whether the stream can be restarted or if any data is lost.

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?

The input schema has a single required parameter stream_name, but the description adds no additional meaning. Schema coverage is 0%, and the description does not explain the parameter's purpose, format, or constraints beyond what the schema already provides. A baseline of 2 is appropriate given the minimal compensation.

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 clearly states the action ('stop') and the resource ('a SQL stream'), making the tool's purpose immediately apparent. It also distinguishes itself from sibling tools like start_stream and delete_stream, though it could be more specific about what 'stop' entails in terms of stream lifecycle.

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?

No guidance is provided on when to use this tool versus alternatives such as delete_stream or stop_job. There is no mention of prerequisites, such as the stream needing to be in a running state, or context about when the tool is applicable.

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