plane-instance-update

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It reveals the tool updates settings and requires admin access, but omits details about side effects (e.g., whether domain changes propagate immediately), idempotency, or response behavior. The description is minimally transparent.

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, front-loaded sentence with no redundancy. It efficiently communicates the action and scope. While concise, it could be expanded with additional context (e.g., usage guidance) without becoming wordy. The structure is effective.

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 tool's simplicity (3 optional params, no output schema, no annotations), the description adequately covers basic purpose and access requirements. However, it lacks differentiation from similar config tools and does not explain behavior when no parameters are provided. This leaves the agent with incomplete context for decision-making.

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 schema provides 100% coverage with descriptions for all three parameters. The description's parenthetical (name, domain, telemetry) maps directly to these parameters but adds no new semantics beyond what the schema already offers. Baseline score of 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?

The description clearly states the tool updates instance settings and lists the specific settings (name, domain, telemetry). It uses a specific verb ('update') and resource ('instance settings'), distinguishing it from sibling tools like plane-instance-get (retrieval) and plane-instance-config-get/update (other 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 explicitly mentions 'Requires admin access,' which is a key usage guideline. However, it does not specify when to use this tool versus closely related siblings like plane-instance-config-update, nor does it state when not to use it. This omission reduces clarity for an AI agent selecting the correct tool.

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