Create Broadcast Message

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

Annotations are all false (readOnlyHint, destructiveHint, idempotentHint), yet the description adds no behavioral details beyond admin requirement. Does not disclose idempotency, side effects, or return behavior, leaving the agent uninformed.

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 concise sentences: one for purpose, one for prerequisite. Front-loaded and efficient with no extraneous 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?

Despite well-documented schema, the description omits return value, error handling, and any behavioral context for a creation tool with 11 parameters. Unusual userCredentials field is not explained.

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 100%, so baseline is 3. The description adds no extra parameter meaning beyond what the schema already provides; it does not mention any parameters.

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?

Clearly states 'Create a GitLab broadcast message' with a specific verb and resource. Mentions required admin privileges, effectively differentiating it from sibling tools like delete, update, list, and get.

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?

Only notes 'Requires administrator privileges,' which is a prerequisite but lacks guidance on when to use this tool versus alternatives (e.g., update_broadcast_message). No explicit when/when-not context.

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