Create Coolify GitHub App

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

Annotations indicate a write operation with potential side effects, but the description adds no behavioral details (e.g., idempotency, error handling, or what happens on duplicate). The 'reveal' parameter note is in the schema, not the description, so the description itself is lacking.

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?

The description is a single sentence of 9 words, which is concise but at the expense of necessary detail. It is not structured to provide quick reference to key aspects.

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 15 parameters, 9 required, and no output schema, the description is far too sparse. It omits return values, error conditions, and the relationship to other tools, leaving the agent underinformed.

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?

With only 33% schema description coverage and no parameter explanations in the description, the agent must guess the meaning of 10 parameters including 'name', 'app_id', 'client_secret', etc. The description does not compensate for this low coverage.

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 ('Register') and the resource ('a GitHub App as a Coolify deployment source'). It distinguishes the tool's scope from siblings like 'coolify_create_application_githubapp', but does not explicitly call out the difference, leaving some ambiguity.

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 provides no guidance on when to use this tool versus alternatives (e.g., coolify_create_application_githubapp) or any prerequisites. The agent receives no context about whether it should be used before creating applications or what prior steps are needed.

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