Customer portal

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

Annotations provide no safety flags, so description adds value by stating it returns HTML and optionally writes to media gallery. No contradictions.

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, well-structured sentence that front-loads purpose and adds essential details without redundancy.

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 key aspects: purpose, output (HTML), optional save, and linking hint. Lacks explanation of side effects beyond save, but adequate for a clear tool.

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?

Description adds context for 'company' by mentioning contacts and tickets, and 'save' behavior is explained. However, 'project' parameter is not described, and schema already covers 67% of parameters.

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?

Clearly states the tool builds a per-customer portal page with contacts and linked tickets, using specific verbs and resources. Distinguishes itself from sibling tools like list_companies or add_page.

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?

Implies usage context for building portals and mentions linking tickets with link_customer_ticket as a prerequisite. No explicit when-not or alternatives, but context is sufficient.

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