opnsense_acme_renew_cert

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

No annotations are provided, and the description only says 'Trigger immediate renewal/signing', which is minimal. It does not disclose side effects (e.g., whether the certificate is applied, if services restart, or if the renewal is irreversible). The agent is left uninformed about important behavioral traits.

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 a single sentence of 9 words, front-loading the action and resource. No wasted words; it is appropriately concise.

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 simple 1-param tool, the description covers the basic purpose. However, given the lack of annotations and the potentially impactful nature of renewing certificates (affecting services), additional context about preconditions or post-effects would be beneficial.

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?

The schema covers 100% of parameters, already describing 'uuid' as 'UUID of the certificate to renew'. The description adds 'by UUID', which reinforces but does not add meaning beyond the 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 'Trigger immediate renewal/signing of an ACME certificate by UUID' clearly states the action (trigger renewal/signing) and the resource (ACME certificate). It distinguishes from sibling tools like opnsense_acme_create_cert (create) and opnsense_acme_list_certs (list).

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 implies usage by mentioning 'by UUID', but it does not explicitly state when to use this tool versus alternatives like creation or listing. No 'when to use' or 'when not to use' guidance is provided.

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