Update client

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

Discloses that it's a write operation and idempotent, matching the annotations. Adds that only supplied fields change and describes the return type (confirmation message or reason string). No contradiction with annotations.

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?

Four concise sentences, each adding value: purpose, partial update, prerequisite advice, return info. No redundancy.

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?

Covers purpose, behavior, prerequisites, and return type. Adequate for a tool with 5 parameters and no output schema, especially with good annotations.

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%, so baseline is 3. The description adds operational context but doesn't significantly enhance individual parameter meanings beyond the schema's own good descriptions.

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', the resource 'existing client', and the specific fields (enabled flag, public flag, redirect URIs, web origins). It distinguishes from sibling tools like keycloak_client_create and keycloak_client_get.

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?

Explicitly advises using keycloak_client_list or keycloak_client_get to find the client first, providing clear when-to-use guidance. Also explains partial update behavior.

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