deploy_or_update_napcat

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

With no annotations, the description carries the full burden and does well: it discloses the two-phase confirmation gate, that confirmed=False is preview-only and confirmed=True actually downloads/extracts, and that sources are either a GitHub Release or a local offline package. It omits failure behavior, permissions, and side effects on an existing installation.

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 core purpose and the safety rule are front-loaded, with the warning marker drawing attention to the confirmation protocol. It is somewhat redundant because the :param block duplicates schema descriptions, but nothing is confusing or buried.

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 mutation tool with no annotations and no output schema, the description covers purpose, source options, and the execution gate well, and it hints at the preview return. It stops short of describing what the preview contains or what success/failure reporting looks like, which is the remaining gap.

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 the schema already documents all four parameters. The description's :param block essentially restates the schema text (action, confirmed, use_local_zip_if_available, target_uin) without adding format, default, or interaction details, so baseline 3 is appropriate.

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 compound verb (deploy/update) and resource (NapCat runtime environment), plus scope details: GitHub Release download or local offline zip extraction and OneBot port auto-configuration. This clearly separates it from start_napcat_service / restart_napcat_service / check_napcat_environment, though it never names a sibling explicitly.

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?

Gives an explicit workflow: first call with confirmed=False to get a preview plan, present it to the user, then re-call with confirmed=True. That is real when-to-use guidance. It does not, however, clarify deploy vs update selection or when this tool is preferable to the adjacent environment/service management tools.

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