yuque_create_doc_from_file

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

With no annotations, the description must carry the full burden of behavioral disclosure. It mentions 'attach to TOC' but omits crucial behaviors such as how file_path is read (local filesystem access), whether an existing slug is overwritten, what happens on missing files, or permission requirements.

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 a single sentence that is concise and front-loaded with the primary action. No words are wasted, and the structure is clear and scannable.

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?

Given the complexity (7 parameters, no annotations, no output schema), the description is grossly insufficient. It fails to explain what 'attach to TOC' means, how to specify the parent TOC node, what the format enum values imply, or how public/private settings work.

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 0%, and the description provides no meaning for any of the 7 parameters. It does not explain namespace, slug, title, format, public, parent_uuid, or even file_path semantics beyond the vague 'local file content'.

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 the verb (create), the resource (document), the source (local file content), and the additional action (attach to TOC). This distinguishes it from sibling tools like yuque_create_doc (which creates from provided content) and yuque_update_doc_from_file (which updates).

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 does not explicitly state when to use this tool versus alternatives. It only implies usage for local file content, but offers no exclusions or comparisons to yuque_create_doc or yuque_update_doc_from_file.

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