create_outline_by_doc

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

With no annotations, the description carries the full burden and it delivers: format support (pdf non-scanned, doc/docx/txt/md), 10MB and 8000-character limits, and the AIPPT_APP_ID/AIPPT_API_SECRET prerequisite. It omits return shape and whether generation is synchronous or task-based.

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?

Front-loads the purpose in one sentence, then uses a compact numbered list for constraints. Slightly long, but each numbered item carries distinct operational information rather than filler.

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?

Covers prerequisites, input formats, limits, and the downstream create_ppt_by_outline handoff, which is what an agent needs to call it correctly. Without an output schema, the description could say more about the returned outline structure, but the workflow linkage largely compensates.

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 description coverage is 100%, so all six parameters are already documented in the schema. The description reinforces the file_url/file_path mutual-exclusivity and format constraints but adds no new syntax or semantics beyond the schema. Baseline 3 applies.

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?

States a specific verb+resource: creating a PPT outline from a document ('从文档创建PPT大纲'). The 'by_doc' input source is clear, but it never contrasts itself with the sibling create_outline, which likely produces an outline from scratch rather than a document.

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?

Gives explicit context: it is for generating outlines from document content, lists accepted formats, size/word limits, required env vars, and names the downstream consumer create_ppt_by_outline. It does not state when to prefer create_outline over this document-based variant.

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