lookup_stock_code

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

No annotations provided, so the description carries full burden. It discloses caching behavior, re-download option, and strategic use. However, it does not explicitly state that it is a read-only operation, though 'diagnostic tool' implies safety.

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?

Well-structured with clear sections for purpose, strategy, critical rules, and args. Every sentence adds value, no fluff. Front-loaded with core purpose.

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 2-param diagnostic tool with an output schema, the description covers usage context, prerequisites, and behavior. It tells the agent exactly when and how to use it, which is complete for effective invocation.

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 0%, so the description adds full meaning: stock_code is a 5-digit HK stock code with examples, refresh is a boolean defaulting to false that forces re-download of mappings. Both parameters are adequately explained beyond the schema.

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 it looks up stockId mapping for a Hong Kong stock code, using specific verb 'look up' and resource 'HKEXnews stockId mapping'. It is distinctly a diagnostic tool, differentiating it from siblings like download or list announcements.

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?

Explicitly says 'Invoke ONLY when download/list returns Stock code not found' and provides a strategy to retry after success. Also gives a critical rule to prefer refresh=false first, offering clear when-to-use and when-not-to-use guidance.

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