github_create_release

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

No annotations are provided, so the description must disclose behavioral traits. It only states the action and lists parameters with defaults. It does not mention permissions, side effects (like creating tags), error conditions, or idempotency. The mutation aspect is implicit but not elaborated.

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 front-loaded with the purpose, followed by a well-structured Args list. The list is slightly long (10 items) but each line is informative and without fluff. It earns its place given the schema has no descriptions.

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 10-parameter tool with an output schema, the description covers all parameters, defaults, and the main action. It lacks some operational context (e.g., whether the tag must already exist, behavior on duplicate releases), but the presence of an output schema and detailed parameter explanations make it mostly 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 description coverage is 0%, so the description is the sole source of parameter meaning. It provides clear semantics for every parameter, including defaults (name defaults to tag_name, target defaults to default branch) and formats (e.g., tag_name example 'v1.0.0', body markdown). This fully compensates for the silent schema.

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 opens with a clear, specific verb+resource statement: 'Create a new release with auto-generated or custom release notes.' This distinguishes it from sibling tools like create_tag or create_repo. The scope is well-defined.

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?

There is no explicit guidance on when to use this tool versus alternatives. While it is clear this tool creates releases, there is no mention of prerequisites (e.g., tag existence), exclusions, or comparison to related tools like github_create_tag or github_update_release.

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