get_plan
Show a plan's diff and status to review proposed changes before approval.
Instructions
Show a plan's diff and status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes |
Show a plan's diff and status to review proposed changes before approval.
Show a plan's diff and status.
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already establishes the safety profile. The description adds what is returned ('diff and status'), which is useful behavioral context beyond the annotation, but it omits auth requirements, pagination, or any detail about what the diff represents.
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?
A single six-word sentence with no waste, and the core action is front-loaded. It is appropriately sized for a simple read operation.
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 one-parameter read-only tool with no output schema, the description is minimally adequate. It states the return content but does not explain how to obtain plan_id or what the diff and status mean in context, leaving gaps for an agent to infer.
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 description coverage is 0%, and the description does not document plan_id at all. It only weakly implies that the parameter identifies a plan; no format, source, or constraints are given, so it fails to compensate for the absent schema documentation.
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?
States a specific verb ('Show') and resource ('a plan's diff and status'). It does not explicitly name or distinguish itself from sibling tools like list_plans, but the mention of diff and status gives enough specificity to separate it from list operations.
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 when-to-use or when-not-to-use guidance is provided. The description only states what the tool does, leaving the agent to infer context from the name and sibling tools such as list_plans or propose_*.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.