schematics_plan_workspace

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

With no annotations, the description carries full burden. It does not disclose that planning is a read-only operation (no side effects), nor does it mention potential waits for plan generation, required permissions, or output format. Agent lacks awareness of its non-destructive nature.

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 very concise (7 words) and no unnecessary text. However, it may be overly terse given the complexity of the operation; a slightly longer description could improve clarity without being verbose.

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 and no annotations, the description fails to provide sufficient context about what a Terraform plan entails (e.g., showing resource changes), the typical workflow (plan before apply), or the response structure. It is incomplete.

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 workspace_id has no description in schema (0% coverage). The description does not elaborate on its meaning, format, or how to obtain it (e.g., from schematics_list_workspaces). Relies solely on parameter name clarity.

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 action (generate) and resource (Terraform plan for a workspace). It effectively differentiates from sibling tools like schematics_apply_workspace by focusing on plan generation. However, it does not clarify that the plan is a preview/dry-run, which would improve agent understanding.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., schematics_apply_workspace). The description does not suggest a typical workflow, such as 'generate a plan before applying' or indicate prerequisites like workspace existence.

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