update_nginx_conf

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

No annotations are provided, so the description carries the full behavioral burden, and it does almost nothing. 'Update' implies a mutation, but it never says whether content fully replaces the existing configuration, whether a backup is created, whether a syntax check or reload occurs, or what permissions are required. Only the trivial fact of mutability is conveyed.

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?

It is a single, front-loaded sentence with no filler, which is structurally fine. The problem is under-specification rather than verbosity: four words cannot carry the burden of an undocumented, annotation-free mutation tool.

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?

This is a write tool with no annotations, no output schema, and both parameters undocumented in the schema, so the description should compensate heavily. Instead it provides only a restatement of the name, leaving the agent without the information needed to call it safely or 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?

Both parameters (id: number, content: string) have zero schema description coverage, and the description adds no meaning for either. It does not explain what the numeric id identifies (site, config record, server?) or that content is the raw configuration text that will be written, leaving the agent to guess entirely.

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 states a specific verb (Update) and resource (Nginx configuration), so the basic action is unambiguous. However, it is essentially an expansion of the tool name update_nginx_conf, and it does not distinguish itself from siblings such as get_nginx_conf or update_openresty_conf/update_openresty_by_file, nor does it say which parts of the configuration it touches.

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?

No guidance is given about when to use this tool versus alternatives like update_nginx_conf-style file editors or the OpenResty equivalents. There is also no mention of prerequisites such as whether the Nginx service must be reloaded afterward or whether the config is validated before being written.

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