devtools_install_gitops_operator

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

With no annotations, the description carries the burden of behavioral disclosure. It does state 'Modifies the cluster' and lists outputs (status, stdout, stderr, exit_code), which are valuable. However, it does not mention idempotency, required permissions, side effects on existing ArgoCD installs, or whether the tool waits for readiness. The mutating nature is disclosed, but significant behaviors remain implicit.

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 concise first sentence followed by structured key-value metadata. Every line has a purpose: display, usecase, input, output, example, prerequisite, related tools. There is mild redundancy between DISPLAY_NAME and the opening sentence, but the overall structure is efficient and the core purpose is front-loaded.

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 low complexity (one optional boolean parameter) and the presence of an output schema, the description covers the essential context: what is installed, why, the confirm requirement, prerequisites, example usage, and related tools. Missing details like target namespace or behavior when the operator already exists are minor and do not prevent correct selection/invocation.

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 has one boolean param with 0% description coverage, so the description must compensate. The INPUT_DESCRIPTION line does exactly that: 'confirm (bool) — must be true.' This adds critical semantic meaning beyond the schema by telling the agent the operation will not proceed without confirmation. It stops short of explaining what happens if false or why confirmation is required, but for a single-param tool this is sufficient.

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 opens with a specific verb and resource: 'Install the OpenShift GitOps (ArgoCD) operator.' The USECASE line adds context ('Install ArgoCD used to deploy RHOSO via GitOps'), and the RELATED_TOOLS list separates it from sibling configuration/enable steps. An agent can clearly identify this as the operator-installation tool.

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 USECASE and PREREQUISITES lines give clear context: use when installing ArgoCD for RHOSO deployment, and ensure the cluster is reachable. RELATED_TOOLS names the alternatives, but it does not explicitly state 'use this instead of devtools_enable_argocd when...' or provide exclusions. This is clear context without full when/when-not guidance.

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