update_config

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

Although no annotations are provided, the description discloses that the tool replaces the entire config file, implying destructive behavior. It does not mention authentication or rate limits, but given the context, the key behavioral trait is communicated.

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?

Two sentences, no wasted words. The purpose is front-loaded, and the important usage instruction follows immediately. Very efficient.

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 tool that replaces an entire config file, the description adequately covers the input requirement and the need to read first. No output schema is present, but a return value is not critical. Could be slightly more complete by mentioning that the operation is irreversible, but overall sufficient.

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% with one parameter described as 'The complete config.json object to write'. The description adds critical context: 'You must provide the FULL config object — it replaces the entire file', emphasizing the requirement for completeness 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 clearly states the verb 'Update' and the resource 'Homebridge config.json file'. It distinguishes from sibling tools like get_config, which is a read operation, and other siblings that deal with accessories or plugins.

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?

Provides explicit instructions: 'You must provide the FULL config object — it replaces the entire file. Use get_config first to read the current config, then modify and pass back the complete object.' This tells when to use it and mentions the prerequisite sibling tool.

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