plane-instance-config-update

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It mentions 'update' but does not disclose potential side effects, required permissions, or any destructive actions. For a config update that could include sensitive keys like GOOGLE_CLIENT_SECRET, this is insufficient.

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 concise with two main sentences plus a list of example keys. It front-loads the action clearly. The list is useful but slightly long; however, no waste is present.

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 low complexity (one parameter, no output schema), the description adequately covers the parameter format and provides examples. It does not explain return values or error handling, but those are less critical for a simple update tool.

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 already describes the 'config' object parameter, but the description adds significant value by listing concrete example keys (e.g., ENABLE_SIGNUP, LLM_API_KEY) and specifying the format as key-value pairs. This goes beyond the schema's generic 'additionalProperties' description.

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 explicitly states 'Update instance configuration keys' which is a specific verb-resource combination. It lists example keys, making it clear what is being updated, and distinguishes from sibling 'plane-instance-config-get' which retrieves config.

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 (update config keys) but does not explicitly state when to use this tool vs. alternatives like other update tools. No when-not or contextual triggers are provided.

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