stock_margin_szse

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint false, so the safety profile is covered. The description adds value by stating the return type (pandas.DataFrame) and the official source URL, which clarifies the data origin and output format.

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 concise and well-structured as a docstring, including the source URL, parameter documentation, and return type. Every element serves a purpose without unnecessary fluff.

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 tool with one parameter and no output schema, the description provides the essential details: data source, parameter meaning, and return type. It does not enumerate the columns of the summary DataFrame, but this is not critical given the tool's simplicity and the presence of sibling tools for more specific margin data.

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 schema has no parameter descriptions (0% coverage), so the description must compensate. It does provide a docstring for the 'date' parameter ('交易日', meaning trading day) and its type, which gives semantic meaning. However, it does not specify the date format, though the default '20240411' in the schema hints at it. This is helpful but minimal.

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 retrieves SZSE margin trading summary data (融资融券汇总), with a specific source URL. The tool name and description together distinguish it from sibling tools like stock_margin_sse and stock_margin_detail_szse by exchange and summary-level scope.

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 description implies usage context: it is for querying Shenzhen Stock Exchange margin summary data for a given trading day. However, it does not explicitly mention alternatives or when not to use it, though the differentiation is apparent from the tool name and siblings.

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