Skip to main content
Glama

Broadcast a step

broadcast_step

Send one step: action (what you did; for web include url and title), observation, command (with output and ok or exit_code), edit (with files: path, change, diff), test (with ok and output), decision (what you chose and why), milestone, note or error. The response includes new comments from watchers.

Input Schema

NameRequiredDescriptionDefault
idYes
okNoDid it succeed
keyYes
urlNo
textYese.g. "Added the Stripe webhook route" or "Clicked Add to cart"
typeNoaction
filesNo
titleNo
outputNoCommand or test output (trimmed)
exit_codeNo
screenshotNoBase64 PNG or JPEG

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare that this is a non-read-only, open-world, non-idempotent, non-destructive mutation. The description adds useful behavioral context by stating that the response includes new comments from watchers, which is not covered by the annotations or an output schema. It does not describe the broader effect of broadcasting a step or any auth/permission requirements, so it only partially exceeds the annotation baseline.

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 the core action ('Send one step') and then compactly enumerates the step payloads in one dense sentence, followed by a focused note about the response. Every sentence earns its place, though the long enumeration makes it slightly harder to scan than a structured list would be.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 11-parameter, non-idempotent, open-world tool with only 36% schema description coverage and no output schema, the description is reasonably complete on step-type payloads and response content. It leaves important gaps: the meanings of required id, key, and text are not explained, screenshot is undocumented, and the consequences of broadcasting are not described.

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 description coverage is only 36%, so the description must carry significant parameter meaning. It does this well for type-specific payloads: action steps can include url and title, command steps use output plus ok or exit_code, edit steps use files with path/change/diff, and test steps use ok and output. However, the required parameters id, key, and text are not explained, and screenshot is left unmentioned.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action—'Send one step'—and enumerates the kinds of steps (action, observation, command, edit, test, decision, milestone, note, error), so an agent can immediately tell what the tool does. It does not explicitly distinguish itself from siblings such as `comment` or `broadcast_settings`, which keeps it just short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description lists step types but gives no explicit guidance on when to use this tool versus alternatives like `comment`, `broadcast_settings`, or `end_broadcast`. The type enumeration implies how to categorize content, but there are no when-to-use or when-not-to-use instructions.

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.

Resources