Read preparation job
read_preparation_jobRead a saved preparation job status; never schedules work or calls paid providers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | ||
| workspace | No |
read_preparation_jobRead a saved preparation job status; never schedules work or calls paid providers.
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | ||
| workspace | No |
Changes observed during successful MCP inspections.
Input schema / properties / actionIdRemoved value: -{
- "type": "string"
-}Input schema / properties / idempotencyKeyRemoved value: -{
- "type": "string"
-}Input schema / properties / jobId / patternAdded value: +"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"Input schema / properties / workspace / maxLengthAdded value: +100Input schema / properties / workspace / minLengthAdded value: +1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent and non-destructive, so the safety profile is covered. The description still earns credit by adding a cost/side-effect guarantee the annotations do not express: it never schedules work and never calls paid providers. It omits what a 'status' actually contains, but with no output schema that gap is real.
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 the non-obvious constraint appended. No filler and nothing repeated from annotations or schema.
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?
A two-parameter tool with no output schema and no parameter documentation needs the description to explain what jobId identifies, how workspace scopes the lookup, and roughly what a status response contains. None of that is present, so an agent cannot call it confidently beyond guessing.
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 must carry both parameters. It says nothing about jobId (a UUID the agent must obtain somehow) or about the optional workspace scoping parameter. The agent is left to infer semantics entirely from types and patterns.
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 names a specific verb ('Read') and resource ('a saved preparation job status'), so an agent can distinguish this from cancel_preparation_job or prepare_page_changes. It stops short of naming any sibling or clarifying how it differs from read_preparation_action(s), which sit in the same family.
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?
Usage is only implied: it reads an existing job, as opposed to scheduling one. There is no explicit 'use this when…' or any pointer to an alternative for starting or cancelling a job, even though cancel_preparation_job and prepare_page_changes are obvious neighbours.
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.