stock_margin_sse

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

Annotations already declare read-only and idempotent behavior, so the description does not need to repeat that. It adds the return type (pandas.DataFrame) and the official SSE URL, providing some context about data source and format. However, it does not disclose potential rate limits, date restrictions, or payload structure beyond annotations.

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 compact and well-organized, with a title, URL, and docstring lines. There is no redundant text, and each element contributes useful information.

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?

As a simple two-parameter data retrieval tool with strong annotations, the description provides sufficient context: source exchange, URL, parameter meanings, and return type. It lacks detailed column information, but the title '融资融券汇总' conveys the content, making the description adequate for this complexity.

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 provides only parameter names and defaults with no descriptions, but the description includes a docstring that explains both start_date and end_date as transaction start and end dates. This adds meaning beyond the schema, though the date format (YYYYMMDD) is only implied by the defaults.

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 title and description clearly identify this as a Shanghai Stock Exchange margin trading summary data retrieval tool, with a source URL and parameter documentation. It distinguishes itself from sibling margin tools by specifying the exchange and summary granularity, though it lacks an explicit verb like 'fetch' or 'retrieve'.

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 provided on when to use this tool versus alternative margin data tools such as stock_margin_szse or stock_margin_detail_sse. The description only documents its own parameters and return type, leaving the agent to infer use cases from the title.

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