Update Coolify GitHub App

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

Annotations already provide behavioral hints (idempotent, non-destructive). The description only adds 'Only supplied fields change,' which aligns but does not disclose additional traits like secret handling or audit logging (partially covered in schema for 'reveal'). Limited added value.

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, minimal waste. Every word serves a purpose: states action and key constraint. Highly efficient.

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 high complexity (16 params, no output schema) and low schema coverage, the description is insufficient. It omits prerequisites, parameter relationships, and operational context that would help an agent invoke the tool correctly.

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 description coverage is very low (19%). The description provides no parameter-level information, leaving 13 parameters without any guidance beyond what the sparse schema offers.

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 action ('Update fields') and the resource ('GitHub-App integration'). It distinguishes from siblings like 'coolify_create_github_app' and 'coolify_delete_github_app'.

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 gives no guidance on when to use this tool vs alternatives (e.g., vs create or get). No context for prerequisites or scenarios.

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