Get fix plan
get_fix_planReturn the stored AI fix plan of a task, with its steps and when it was generated.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes | The task id, as returned by list_tasks. |
get_fix_planReturn the stored AI fix plan of a task, with its steps and when it was generated.
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes | The task id, as returned by list_tasks. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is covered. The description adds that the plan is stored and includes generation timing, which is useful, but it does not address edge cases such as a missing plan or error behavior.
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?
One sentence, front-loaded with the action and resource, with no filler or repetition.
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 retrieval tool, the description covers what is returned (steps and generation time) and the annotations cover safety. No output schema exists, but the description gives enough for an agent to invoke it correctly.
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 task_id is fully documented in the schema with a clear description ('as returned by list_tasks'). The tool description adds no additional parameter-level detail, so the schema carries the burden.
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 uses a specific verb ('Return') and names a concrete resource ('stored AI fix plan of a task'), and clarifies the content ('steps and when it was generated'). This distinguishes it from sibling tools like get_fix_catalog or get_fix_changes, which concern different fix-related artifacts.
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 makes the tool's context clear: use it to retrieve an existing fix plan for a task. It does not explicitly name alternatives or state when not to use it, so it stops short of full routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.