macro_china_market_margin_sh

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

Annotations already indicate read-only, idempotent, and non-destructive behavior. The description adds the data range and return type (DataFrame), but does not disclose additional behavioral nuances like column structure, pagination, or source specifics beyond the URL. It provides a minimal amount of extra context.

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 very short, with no wasted words, but it is under-specified. The inclusion of the source URL and the :return: pseudo-docstring provide some structure, yet the lack of essential detail (e.g., what columns or data fields are returned) makes it more of a stub than a well-structured description.

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 tool with no parameters and no output schema, the description carries the burden of explaining what the returned DataFrame contains. It only mentions 'margin trading report' and a data range, omitting any information about the columns, rows, or expected content. This is insufficient for an agent to know what to do with the output.

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?

There are zero parameters, so the input schema is trivially complete. The baseline for 0 params is 4, and the description does not introduce any confusing parameter-related information. There is nothing to compensate for, so the baseline stands.

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 identifies the tool as the Shanghai margin trading report ('上海融资融券报告') with a specific data range. It distinguishes from sibling tools like macro_china_market_margin_sz (Shenzhen) and stock_margin_sse (which is a different margin report). The resource and scope are explicit.

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 given on when to use this tool versus alternatives such as stock_margin_sse or macro_china_market_margin_sz. It only states the data range, without any context on selection criteria, prerequisites, or comparison with similar tools.

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