Cancel Platform Research Workflow
ata_cancel_research_workflowCancel a platform-managed research workflow. Cancellation is terminal until the client or user explicitly resumes it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflowJobId | Yes |
ata_cancel_research_workflowCancel a platform-managed research workflow. Cancellation is terminal until the client or user explicitly resumes it.
| Name | Required | Description | Default |
|---|---|---|---|
| workflowJobId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds the meaningful behavioral detail that cancellation is 'terminal until the client or user explicitly resumes it,' which the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=true) do not convey. This clarifies the lifecycle consequence and implicitly points to the sibling ata_resume_research_workflow, adding value beyond the 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?
Two sentences with zero wasted words: the first states the action and scope, the second adds the single most important behavioral caveat. Both sentences earn their place and the key action is front-loaded.
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 simple one-parameter tool with no output schema, the description covers purpose and the critical terminality behavior. However, given the sibling context containing two other cancellation tools and a resume tool, it is missing an explicit pointer distinguishing workflow-level cancellation from job/task-level cancellation, which an agent would need to route 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?
Schema description coverage is 0%, so the description carries the full burden for parameter semantics, but it never explains workflowJobId beyond what the property name implies. The field name is self-descriptive and it is the only required parameter, but the description adds no information about its origin, format, or relationship to the workflow.
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 ('Cancel') and a specific resource ('platform-managed research workflow'), which clearly conveys the action. The qualifier 'platform-managed' and the word 'workflow' conceptually differentiate it from the sibling tools ata_cancel_research_job and ata_cancel_research_task, though it never names them explicitly.
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?
There is no guidance on when to choose this tool over ata_cancel_research_job or ata_cancel_research_task, nor any mention of prerequisites or where the workflowJobId comes from. The second sentence describes the consequence of cancellation, not the conditions that should lead an agent to invoke this tool.
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.