update_setting

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It only says 'update' without mentioning side effects, permissions, idempotency, or error handling (e.g., what happens if the key does not exist). Minimal behavioral context beyond the action itself.

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 that is clear and to the point. No unnecessary words, but it could be slightly more structured with additional context while remaining 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?

Given the lack of annotations, output schema, and incomplete parameter documentation, the description is too brief. It does not cover return values, error states, prerequisites, or behavior for missing keys. For a simple update tool, it is minimally complete but lacks depth.

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 input schema has 2 parameters: 'key' (with a description) and 'value' (without). The description adds no additional meaning beyond 'by key', and does not explain the 'value' parameter. Schema description coverage is 0% at the top level, and the description does not compensate for the missing parameter documentation.

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 'a single Metabase setting by key', distinguishing it from sibling tools like 'bulk_update_settings' which updates multiple settings.

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 for updating one setting by key, but does not explicitly specify when to use this tool vs alternatives like 'get_setting' to view a setting or 'bulk_update_settings' for batch updates. No exclusion criteria or context provided.

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