create_announcement

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

Annotations only indicate readOnlyHint=false, idempotentHint=false, destructiveHint=false – they don't specify side effects. The description adds that it posts to the Announcement Center, optionally triggers activities, notifications, and emails, and requires admin privileges. This is valuable behavioral context beyond what annotations provide.

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 well-structured: a summary sentence, an effect explanation, an Args block, and a Returns line. It is slightly longer than necessary but every sentence adds value, and the core purpose is front-loaded. The parameter list is formatted for quick scanning.

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 an 8-parameter tool, the description covers every parameter with explanations, states the admin requirement, and outlines side effects. The output schema exists, so a high-level 'Returns: JSON object' is sufficient. Nothing essential is missing for an agent to call this tool correctly.

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 carries full responsibility for parameter meaning. It explains all 8 parameters: subject, message, plain_message, groups, activities, notifications, emails, and comments – each with purpose, defaults, and in some cases formats (e.g., Markdown, group ID list). This far exceeds the schema's bare types and defaults.

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?

States a specific verb and resource: 'Create a new announcement in Nextcloud.' This clearly distinguishes it from siblings like list_announcements and delete_announcement. The scope is unambiguous.

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 indicates when to use it (to create an announcement) and includes a prerequisite ('Requires admin privileges'). It does not explicitly mention alternatives or when not to use it, but the purpose is so clear that usage is effectively implied. A slightly stronger explicit contrast with list/delete would make it a 5.

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