tickerbot_subscribe_scan

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

With no annotations, the description carries the full burden. It discloses the trigger condition (matches change), default cadence (realtime/1m), throttling options (hourly or nyse_open), and delivery behavior (POST to target_url, Discord embed to discord_url, or in-app dashboard). It does not cover failure modes or auth details, but the main behavioral contract is clearly explained.

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 three sentences and front-loaded with the core purpose. Each sentence earns its place: the first defines the action, the second explains delivery options, the third covers cadence and the common use case. It is compact without losing necessary context.

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 this is an 8-parameter tool with no output schema, the description provides solid coverage of the main delivery modes (webhook, Discord, in-app) and cadence settings. However, it omits the mobile_push/device_id path and does not hint at what the response looks like, though those are schema-described and arguably secondary.

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 already covers 100% of parameters, giving baseline 3. The description adds value by explaining parameter relationships: 'Pass `target_url` for an https POST, or `channel:"discord"` + `discord_url` to post an embed to Discord; omit for in-app delivery.' This clarifies how channel, target_url, and discord_url interact beyond individual schema descriptions.

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 opens with 'Register a webhook that fires when matches for a scan query change,' which clearly states the verb (register), resource (webhook), and specific trigger condition (matches for a scan query change). This distinguishes it from sibling tools like tickerbot_scan or tickerbot_subscribe_ticker, making the purpose unmistakable.

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 final sentence provides explicit when-to-use guidance: 'Use to satisfy "alert me when this happens" prompts.' It also clarifies delivery-channel choices (webhook, Discord, in-app) but does not explicitly mention alternatives or when not to use this tool, so it falls just short of full exclusion guidance.

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