APIbase

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

With no annotations provided, the description carries full burden and discloses key behavioral traits: creates a persistent resource ('Published at reference.{domain}/{slug}'), specifies content structure (decision question, CTA, comparison), and implies mutation via 'Generates'. Minor gap on reversibility/idempotency.

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?

Efficiently front-loaded with critical prerequisites first, followed by action, output location, and optional parameter usage. Every sentence delivers unique value with no redundancy or filler.

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 complex creation tool with no output schema, description adequately covers the physical result (page structure, publish URL) and prerequisites. Minor gap on explicit return value structure (e.g., does it return the URL, full HTML, or success boolean?).

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?

While schema has 100% coverage, description adds valuable semantic context: explicitly notes keyword is 'Optional' (complementing schema's required array) and clarifies it 'targets specific search intent', adding purpose beyond the schema's basic definition.

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?

Description uses specific verb 'Generates' with clear resource 'AI-optimized HTML page' and distinguishes from siblings like aipush.pages.list (which lists) by specifying this creates content structured for 'AI assistant answer compilation' with specific sections (decision question, FAQ, etc.).

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?

Explicitly states prerequisites 'Requires mip_status='ready' and cf_hostname_status='active'' and provides clear workflow guidance 'check website_status first', effectively defining when to use vs when to call aipush.website.status instead.

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