oci_kafka_configure_connection

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

No annotations provided, so description carries full burden. It reveals that the new connection takes effect immediately, no restart required, and all existing clients are reset and will reconnect. Also mentions persistence behavior. This is thorough and 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?

Well-structured: purpose sentence, bullet-pointed usage scenarios, behavioral note, then clear parameter list. Every sentence provides necessary information with no redundancy or filler.

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 runtime behavior, immediate effect, client reset, and persistence. While output schema exists (not shown), the description doesn't mention return values or error handling. For a tool with 7 parameters and runtime effects, it is largely complete but could mention success/error responses.

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 has 0% description coverage, but description provides detailed explanations for all 7 parameters, including examples, defaults, and conditions (e.g., ssl_ca_location fallback). This adds high value 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?

Description starts with a specific verb 'Configure or update' and resource 'Kafka cluster connection details at runtime'. It clearly distinguishes from sibling tools that manage clusters, topics, etc., by focusing solely on connection configuration.

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 lists three 'Use this tool when' scenarios (no cluster configured, switch cluster, new credentials). Could be improved by also stating when not to use, but the guidance is clear and helpful.

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