List GitHub App Repository Branches

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the basic safety profile is clear. The description does not add additional behavioral context beyond the 'reveal' parameter's audit note in the schema. The 'instance' parameter's effect on target environment is mentioned but already covered in schema.

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, which is concise, but it lacks specificity about the required parameters and the relationship between the GitHub App and the repo. It could be slightly more verbose to improve clarity without becoming wordy.

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?

The description covers the basic purpose but does not mention the response format (e.g., list of branch names). With no output schema, the agent lacks information on what to expect. The 'reveal' and 'instance' parameters are explained in schema, so not a gap. Overall adequate for a simple list tool but could be more 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?

Schema coverage is 100% with clear descriptions for all parameters. The description adds minimal extra meaning beyond the schema, such as implying the GitHub App access context. Baseline is appropriate as schema carries the load.

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 (list) and resource (branches) and ties it to a GitHub App. However, it does not explicitly mention that the owner and repo parameters are required, nor does it differentiate from sibling tool 'coolify_list_github_app_repos' which lists repos instead of branches.

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?

No guidance is provided on when to use this tool versus alternatives like 'coolify_list_github_app_repos' or when a specific GitHub App context is needed. The description implies usage after obtaining a repo, but no explicit context.

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