zju_get_transcript

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

No annotations provided, so description carries full burden. States '只读' (read-only), which is transparent. Mentions output format (time-stamped segments) and optional parameters (max_segments, with_translation). Lacks details on error handling, rate limits, or behavior when sub_id is invalid. Adequate but not comprehensive.

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?

Very concise: three sentences covering purpose, prerequisites, and condition. Front-loaded with main action. No redundant words. Efficient and clear.

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 provided, yet description only vaguely describes output as '带时间戳的逐段中文文本'. Does not specify structure (e.g., array of objects with fields), possible limits on segments, or handling of missing data. with_translation parameter hints at extra field but not described. Incomplete for a tool without output schema.

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 coverage is 100% for all three parameters. Description mentions sub_id and its source but adds no extra meaning beyond the schema. No additional context for max_segments or with_translation. Baseline 3 is appropriate as parameters are well-documented in 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?

Description explicitly states the tool retrieves speech recognition transcripts for a class from 智云课堂, including time-stamped Chinese text. It mentions the prerequisite sub_id from sibling tool zju_get_schedule and condition that only '回放' status classes have transcripts. Clearly distinguishes from siblings like zju_get_schedule and homework tools.

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?

Provides explicit prerequisites (needs sub_id from zju_get_schedule) and condition (only '回放' status). Implicitly guides when not to use (missing sub_id or non-playback status). Does not explicitly list alternatives or exclusions, but context is clear enough.

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