oci_kafka_list_oci_clusters

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

No annotations are provided, so the description must fully disclose behavior. It does so by explaining the default compartment logic (env var then config file) and the return structure. While it doesn't explicitly state read-only or mention pagination, the list operation's implications are clear. A score of 4 acknowledges thoroughness with minor room for additional safety notes.

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 a few lines, uses a bullet list for return fields, and front-loads the core purpose. Every sentence adds information without 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?

For a straightforward list tool with one optional parameter and an output schema, the description is complete. It explains the action, the parameter semantics, the output fields, and typical usage context.

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 single parameter (compartment_id) has 0% schema description coverage, but the description thoroughly explains its meaning, default resolution from environment variables and config file, and optional nature. This adds significant value beyond the schema type definition.

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 lists all Kafka clusters in an OCI compartment and enumerates the returned fields. It distinguishes itself from sibling tools like get, delete, or create by positioning itself as a discovery tool, e.g., 'before calling oci_kafka_get_oci_cluster_info.'

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 explains when to use the tool: to discover clusters, check lifecycle states, or find OCIDs. It also provides an alternative call (oci_kafka_get_oci_cluster_info) and explains the default compartment resolution order, fulfilling both when-to-use and how-to-use guidance.

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