Post Mod Bug Report

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

Annotations already communicate that this is a non-read-only, non-idempotent mutation. The description adds genuinely useful behavioral context beyond those annotations: BBCode is allowed in the report body, and an authenticated web session is required. It does not disclose secondary effects such as notifications, but it covers the key runtime prerequisite.

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 three short sentences with no filler. The primary purpose is front-loaded, and the two supporting details (BBCode, login requirement) each add real value without bloating the text.

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 straightforward creation tool, the description covers the action, the UI location, formatting rules, and the critical authentication prerequisite. The input schema handles parameter constraints, and since there is no output schema, the description is not obligated to detail the return value. A small gap is that it never says what indicates success, but this is not blocking.

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 only 50%, and the tool description does little to compensate. It mentions BBCode, which relates to text/title, but it does not clarify the meaning of mod_id, title, text, or the relationship between game and mod_id. The schema describes game, dry_run, and private, but leaves title, text, and mod_id undocumented in both places.

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 states a specific verb and resource: 'File a new bug report on a mod' with the UI location '(Bugs tab → Report a bug)'. The word 'new' clearly distinguishes it from sibling tools like reply_mod_bug or delete_mod_bug.

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?

It provides a clear usage context: you use this when you want to file a new bug report, and it names the precondition 'Needs a logged-in web session'. It does not explicitly contrast with reply_mod_bug or get_mod_bugs, but the action described is unambiguous enough to route an agent correctly.

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