InkRoom

generation_status

DestructiveIdempotent

Read or cancel one owned taskId. Returns that task: taskId, status, and images or error/settlement when present. Use wait_images for bounded waiting and image pagination; do not repeatedly poll get. Use batch_generate for several generation jobs, not this tool. Cancellation does not authorize a paid retry.

Input Schema

Name	Required	Description	Default
`action`	No	get reads one task; cancel stops that task. Default get; use wait_images to await image delivery.
`taskId`	Yes	Owned task ID returned by generation; not a requestId or batchId.

Output Schema

Name	Required	Description
`error`	No
`images`	No
`notice`	No
`status`	Yes	Current task state, including running and terminal success, failure or cancellation.
`taskId`	Yes	Existing owned task ID.
`timing`	No
`failure`	No
`lineage`	No
`generation`	No
`settlement`	No
`failedImages`	No
`imageProgress`	No
`deliveryStatus`	No
`outputContract`	No
`cancelRequested`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 22, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "cancelRequested": {
+      "type": "boolean"
+    },
+    "deliveryStatus": {
+      "type": "string"
+    },
+    "error": {
+      "type": "string"
+    },
+    "failedImages": {
+      "items": {
+        "properties": {
+          "error": {
+            "type": "string"
+          },
+          "failure": {
+            "properties": {
+              "code": {
+                "type": "string"
+              },
+              "nextAction": {
+                "type": "string"
+              },
+              "retryable": {
+                "type": "boolean"
+              }
+            },
+            "required": [
+              "code",
+              "retryable",
+              "nextAction"
+            ],
+            "type": "object"
+          },
+          "index": {
+            "type": "integer"
+          },
+          "settlement": {
+            "properties": {
+              "chargedPoints": {
+                "minimum": 0,
+                "type": "number"
+              },
+              "estimatedMaxPoints": {
+                "minimum": 0,
+                "type": "number"
+              },
+              "netChargedPoints": {
+                "minimum": 0,
+                "type": "number"
+              },
+              "quotedMaxPoints": {
+                "minimum": 0,
+                "type": "number"
+              },
+              "refundedPoints": {
+                "minimum": 0,
+                "type": "number"
+              },
+              "status": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "status"
+            ],
+            "type": "object"
+          }
+        },
+        "required": [
+          "index",
+          "error"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "failure": {
+      "properties": {
+        "code": {
+          "type": "string"
+        },
+        "nextAction": {
+          "type": "string"
+        },
+        "retryable": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "code",
+        "retryable",
+        "nextAction"
+      ],
+      "type": "object"
+    },
+    "generation": {
+      "type": "object"
+    },
+    "imageProgress": {
+      "properties": {
+        "failed": {
+          "type": "integer"
+        },
+        "pending": {
+          "type": "integer"
+        },
+        "ready": {
+          "type": "integer"
+        },
+        "total": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "total",
+        "ready",
+        "failed",
+        "pending"
+      ],
+      "type": "object"
+    },
+    "images": {
+      "items": {
+        "properties": {
+          "deliveryStatus": {
+            "type": "string"
+          },
+          "expired": {
+            "type": "boolean"
+          },
+          "expiresAt": {
+            "type": "string"
+          },
+          "height": {
+            "type": "integer"
+          },
+          "index": {
+            "type": "integer"
+          },
+          "linkExpiresAt": {
+            "type": "string"
+          },
+          "mimeType": {
+            "type": "string"
+          },
+          "retainedUntil": {
+            "type": "string"
+          },
+          "revisedPrompt": {
+            "type": "string"
+          },
+          "width": {
+            "type": "integer"
+          }
+        },
+        "required": [
+          "index"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "lineage": {
+      "type": "object"
+    },
+    "notice": {
+      "type": "string"
+    },
+    "outputContract": {
+      "type": "object"
+    },
+    "settlement": {
+      "properties": {
+        "chargedPoints": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "estimatedMaxPoints": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "netChargedPoints": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "quotedMaxPoints": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "refundedPoints": {
+          "minimum": 0,
+          "type": "number"
+        },
+        "status": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "status"
+      ],
+      "type": "object"
+    },
+    "status": {
+      "description": "Current task state, including running and terminal success, failure or cancellation.",
+      "type": "string"
+    },
+    "taskId": {
+      "description": "Existing owned task ID.",
+      "type": "string"
+    },
+    "timing": {
+      "type": "object"
+    }
+  },
+  "required": [
+    "taskId",
+    "status"
+  ],
+  "type": "object"
+}

Changed2 schema fields changedOct 21, 2026

addedInput schema / properties / action / description

Added value: +"get reads one task; cancel stops that task. Default get; use wait_images to await image delivery."

addedInput schema / properties / taskId / description

Added value: +"Owned task ID returned by generation; not a requestId or batchId."

First observedOct 16, 2026

TDQS

A4.4/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true and idempotentHint=true, so the bar is lower. The description still adds real context: cancellation does not authorize a paid retry, and repeated polling is discouraged — non-obvious consequences the annotations do not convey. It stops short of describing rate limits or exactly what cancellation destroys on an in-flight task.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Every sentence earns its place: purpose and return shape first, then routing to wait_images, then the polling prohibition, then the cancellation caveat. No filler and no repetition of schema detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists so return values needn't be fully spelled out, and the description still summarizes the key ones (status, images, error/settlement). Routing and cancellation caveats are covered; only ownership/auth expectations are left implicit.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, including an enum on action and a note distinguishing taskId from requestId/batchId, so the schema already carries the semantics. The description only reinforces the 'owned, single task' scoping; baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb set (read/cancel) and resource (one owned taskId), plus the exact return payload. It explicitly names the sibling tools it is not (wait_images, batch_generate), so an agent can route without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit alternatives and conditions: wait_images for bounded waiting and image pagination, batch_generate for multiple jobs, and an explicit 'do not repeatedly poll get' prohibition. This is a complete when/when-not map.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All InkRoom tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?