integration_preview

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

No annotations provided, so description carries full burden. States it's a preview without importing, implying read-only, but does not explicitly declare safety or side effects. Lacks disclosure on authentication or rate limits.

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?

Well-structured with a purpose sentence, summary, and list of arguments. Each sentence adds value, though slightly verbose. Front-loaded with key information.

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 purpose, workflow (preview then import), and parameter details. Mentions sibling tool by name. Doesn't address error handling or authentication, but given output schema exists and simplicity, it is fairly complete.

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?

Despite 0% schema coverage, description provides detailed explanations for all 5 parameters (integration, repo, state, labels, limit) including default behavior, filter logic, and valid ranges, fully compensating.

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 clearly states verb 'preview' and resource 'issues from a GitHub repository'. It distinguishes from sibling 'integration_sync' by specifying 'without importing' and referencing the import tool for later use.

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 when to use (preview before import) and directs to 'integration_sync' for import. Lacks mention of when not to use or alternatives like 'integration_preflight', but provides clear context.

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