oci_kafka_get_connection_info

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

No annotations are provided, so the description carries the full burden. It discloses that the password is masked and mentions the 'configured' field in the output. While it does not cover all possible behavioral aspects (e.g., authorization requirements), it provides key behavioral details beyond the tool's basic function.

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 at six sentences, well-structured with a clear first sentence stating the main purpose, followed by bullet-pointed use cases, and ending with a conditional action. Every sentence adds value with 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?

Given that there are no parameters and an output schema exists (implied but not shown), the description provides sufficient context: it explains the tool's purpose, key output elements (configured, masked password), and when to use an alternative tool. This is complete for the tool's complexity.

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 tool has no parameters, so the input schema is empty with 100% coverage. The description does not need to add parameter semantics, and it correctly omits any param details. The baseline for zero parameters is 4.

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 'Show' and the resource 'current Kafka connection configuration'. It lists specific use cases such as checking if a cluster is configured, verifying the connected cluster, and confirming security settings, effectively distinguishing it from sibling tools like oci_kafka_configure_connection.

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 tells when to use the tool: 'Check whether a cluster is already configured before calling other tools.' It also provides an alternative action: if 'configured' is false, call oci_kafka_configure_connection first. This offers clear guidance on usage context.

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