b24_documentgenerator_add

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

The description discloses the return format and indicates it creates a document. Annotations show readOnlyHint=false and destructiveHint=false, consistent with creation. No contradictions. Some side effects (e.g., portal storage) are implied but not detailed.

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: first states purpose, second lists return fields. No unnecessary words, front-loaded with key info.

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 parameter count and schema richness, the description is adequate. It mentions output fields, but lacks error conditions or limitations. Still complete enough for common use.

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%, and the schema already explains each parameter well (e.g., entity_type_id with examples). The description adds no further parameter info beyond the 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?

The description clearly states the tool generates a document from a template and CRM record, and lists the return fields (id, downloadUrl, pdfUrl). This distinguishes it from siblings like b24_documentgenerator_templates which only list 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?

The description implies usage for document generation from a template and record, but does not explicitly state when to use it versus alternatives or provide exclusions. The context with sibling tools makes it reasonably clear.

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