Create Document from Template

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

Without annotations, the description bears full responsibility for behavioral disclosure. It mentions returning warnings for unfilled variables but omits side effects, permission requirements, error handling, or resource limits. The description implies mutation (cloning) but gives minimal safety context.

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?

Two sentences concisely convey the core action, key feature (variable substitution with warning), and optional linking. No redundant information; the description is appropriately brief and front-loaded.

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 tool with 5 parameters and no output schema, the description covers cloning, variable substitution, and linking but lacks details on return format (beyond warning), error conditions, behavior on missing template, or concurrency considerations. Adequate but not fully comprehensive.

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 input schema has 80% coverage; workspaceId lacks description. The description adds meaning by explaining the {{variable}} substitution syntax, the warning for unfilled variables, and optional parent doc linking, which goes beyond schema schema definitions.

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 tool clones a template doc, substitutes {{variable}} placeholders, returns warnings for unfilled variables, and optionally links to a parent doc. It distinguishes from siblings like create_doc, create_doc_from_markdown, and instantiate_template_native by specifying variable substitution and warning behavior.

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 alternatives such as create_doc or instantiate_template_native. It does not specify prerequisites or conditions for use.

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