acedatacloud_create_announcement

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

With no annotations, the description must disclose all behavioral traits. It reveals the superuser requirement, locale handling (Chinese source-of-truth, auto-translation), and confirm requirement. Missing details about the output or side effects, but the core mutation behavior is disclosed.

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?

Three sentences, no fluff. The first sentence front-loads purpose and auth requirement, followed by key behavioral details. Every sentence adds value.

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 auth, locale, and confirm constraints, but omits the published parameter behavior (draft vs immediate), rank/tags, and output details. Given 6 parameters and an output schema, the description is incomplete but not critically lacking.

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%, so baseline is 3. The description adds useful context about the content parameter (locale behavior) and reinforces confirm, but does not explain rank, tags, or published parameters beyond what the schema already provides.

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: 'Publish a platform announcement' (specific verb+resource) and includes a critical access restriction (SUPERUSER token only). It distinguishes from sibling tools like list_announcements and other create tools.

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 the tool is for superusers and requires confirm=true, providing clear context for when to use it. However, it does not explicitly state when not to use it or mention alternatives, but since it is the only announcement creation tool, this is adequate.

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