get_money_flow

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

No annotations provided, but the description fully discloses that the tool returns buy/sell volumes, counts, and net volume split by investor type. It is a read operation with no destructive behavior indicated. Missing some details like data freshness or auth requirements, but sufficient for a simple data retrieval.

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?

Two short sentences front-loaded with core concept. Includes Persian terminology relevant to users. No redundant or unnecessary text.

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?

No output schema, but the description explains return fields: buy/sell volumes, counts, and legal_net_volume. Covers the key output. Could mention time period or data source, but adequate for a 1-param tool.

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?

Only one parameter 'symbol' with 0% schema description coverage. The description does not elaborate on the symbol parameter beyond context, but it is self-explanatory. Could specify format or allowed values, but the lack is not critical.

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?

Clearly states it returns individual vs institutional money flow for one symbol, with specific verb 'get' and resource 'money flow'. Distinguishes from siblings like get_quote or get_price_history by focusing on this specific metric.

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?

Implied usage for 'smart money' reads but no explicit when-to-use or when-not-to-use. No comparison with alternatives provided. Usage guidance is minimal.

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