Check Deploy Status

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

Discloses that it returns job status without streaming logs, and provides detailed explanation of response timestamps (updated_at for semantic changes, last_refresh_at for oracle decode). This adds significant context beyond the readOnlyHint and openWorldHint 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?

Front-loaded with 'MONITORING' label and concise main purpose. Includes a detailed 'LIVENESS' section that adds value but adds length. Overall, every sentence contributes to clarity, though it could be slightly shorter.

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 no output schema, the description adequately explains return values (job status, job_id, metadata, timestamps). It covers required session_id, optional job_id, and how to interpret timestamps. The description 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?

Schema coverage is 100%, so baseline is 3. Description adds valuable context: session_id must include the token suffix and never be stripped, and job_id can be discovered via tfruns. This improves parameter understanding 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 clearly states the tool checks the status of Terraform deployments, specifying it returns job status, job_id, and metadata. It distinguishes itself from siblings by referencing tflogs for streaming logs and tfruns for discovering IDs.

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 states when to use ('quickly check if a deployment is running, completed, or failed'), when not to use (use tflogs for logs), and prerequisites (session_id from convoopen). Also provides alternatives for discovering job IDs and streaming logs.

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