Get work template

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

No annotations provided. Description mentions included structure (task and section) but does not disclose idempotency, auth requirements, or other behavioral traits beyond what 'get' implies. Adequate for a simple read operation, but more transparency could help.

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?

Single sentence, front-loaded with key action and resource, includes both purpose and scope. No unnecessary words.

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?

Without output schema, description compensates by noting included structure (task and section). Adequate for a simple retrieval tool with one parameter. Could specify return format but not necessary given simplicity.

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 has 100% description coverage for the single parameter 'workTemplateKey'. Description adds no additional meaning beyond the schema's 'The Karbon WorkTemplateKey'. Baseline score of 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?

Clear verb 'get', specific resource 'work template', retrieval method 'by WorkTemplateKey', and additional context about included content 'task and section structure'. Distinct from sibling list_work_templates.

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?

Missing explicit when-to-use or alternatives, but straightforward: use to fetch a single template by key with its structure. Sibling list_work_templates serves listing, making guidance implicit.

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