Check an import
deck_statusWhether a submitted deck is still importing, ready (with the editor link and the rendered pages, to check them), or failed (with the reason).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deck_id | Yes |
deck_statusWhether a submitted deck is still importing, ready (with the editor link and the rendered pages, to check them), or failed (with the reason).
| Name | Required | Description | Default |
|---|---|---|---|
| deck_id | Yes |
Changes observed during successful MCP inspections.
Input schema / properties / guest_tokenRemoved value: -{
- "description": "Only for a deck created WITHOUT an account: the guest_token create_deck returned.",
- "maxLength": 80,
- "type": "string"
-}Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), and the description adds meaningful behavioral context: the three terminal/transient states and what each carries (editor link, rendered pages for review, failure reason). It does not mention auth requirements or polling behavior, but the state enumeration is genuinely informative.
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 front-loaded sentence that leads with the question it answers ('whether a submitted deck is...'), with the outcome list parenthetically scoped. No wasted words; only the nested parenthetical slightly burdens readability.
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?
With no output schema, the description must carry return-value burden, and it does by enumerating the possible states and payloads. The only gap is that deck_id's provenance and format are never explained, which matters for correct invocation.
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?
Only one parameter, deck_id, and schema description coverage is 0%. The description implies the id refers to a submitted deck, adding a little semantic framing, but says nothing about the identifier's format or origin (e.g., returned by submit_deck). Baseline for a small schema is 3.
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 states exactly what the tool returns: the import state of a submitted deck, enumerated as importing, ready, or failed. It is distinguishable from siblings like see_deck or submit_deck, though it never names the retrieval verb or explicitly contrasts with them.
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 via 'a submitted deck' – the agent can infer this is called after submit_deck, but there is no explicit when-to-use statement and no named alternative. Adequate but leaves the agent to infer the lifecycle position.
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.