tf_workspace

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

No annotations are provided, so the description must fully disclose effects. It mentions operations but does not clarify that 'select' changes the active workspace (a side effect) or that 'new' creates a workspace (a mutation). The description lacks detail on permissions, prerequisites (e.g., terraform init), or error conditions.

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 extremely concise (two sentences with bullet points) and front-loaded with the core purpose. Every word contributes information; no fluff or 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?

The tool supports four operations with three parameters and no output schema. While the description covers the operations, it omits details about return values (e.g., format of list output), constraints (e.g., 'select' requiring an existing workspace), and error handling. Adequate for simple usage but not fully complete.

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% with descriptions for all parameters, earning a baseline of 3. The description adds marginal value by naming operations but does not elaborate on parameter usage beyond what the schema already provides.

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 explicitly states 'Manage Terraform workspaces' and lists four specific operations (list, show, select, new), clearly identifying the resource and actions. This effectively distinguishes it from sibling tools like tf_apply or tf_plan, which focus on other Terraform lifecycle steps.

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 lists operations but provides no explicit guidance on when to use this tool versus alternatives (e.g., for workspace management vs. resource provisioning). Context is implied by the tool name and sibling list, but no when-to-use or when-not-to-use instructions are given.

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