Skip to main content
Glama

Iminify

by com.iminify
OverviewDiscussionsAdmin

Get a page scan

get_scan
Read-onlyIdempotent

One page scan with every image it found, newest first, and the totals saved. Poll this, a few seconds apart, while a scan runs: it is done once its status is no longer queued or scanning and images_in_progress is 0. To download every finished image at once, call create_zip with the scan's id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe scan's id.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoThe scan's id.
urlNoThe page scanned.
hintNoWhat to do next, while the scan or its images are still running.
noteNoWhat the scan found, or why it stopped.
imagesNoThe images the scan found, newest first.
statusNo
settingsNo
created_atNo
updated_atNo
saved_bytesNo
images_countNo
original_sizeNoBytes, over the finished images.
saved_percentNo
optimized_sizeNoBytes, over the finished images.
images_finishedNo
images_in_progressNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "created_at": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "hint": {
+      "description": "What to do next, while the scan or its images are still running.",
+      "type": "string"
+    },
+    "id": {
+      "description": "The scan's id.",
+      "type": "string"
+    },
+    "images": {
+      "description": "The images the scan found, newest first.",
+      "items": {
+        "properties": {
+          "created_at": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "hint": {
+            "description": "What to do next, when the status alone does not say.",
+            "type": "string"
+          },
+          "id": {
+            "description": "The image's id.",
+            "type": "string"
+          },
+          "name": {
+            "description": "The name the optimized copy downloads under.",
+            "type": "string"
+          },
+          "optimized": {
+            "description": "Null until the image has finished.",
+            "properties": {
+              "download_url": {
+                "description": "Works without a token for an hour.",
+                "type": "string"
+              },
+              "format": {
+                "type": "string"
+              },
+              "height": {
+                "type": "integer"
+              },
+              "name": {
+                "type": "string"
+              },
+              "size": {
+                "description": "Bytes.",
+                "type": "integer"
+              },
+              "width": {
+                "type": "integer"
+              }
+            },
+            "required": [
+              "name",
+              "format",
+              "size",
+              "width",
+              "height",
+              "download_url"
+            ],
+            "type": [
+              "object",
+              "null"
+            ]
+          },
+          "original": {
+            "properties": {
+              "download_url": {
+                "description": "Works without a token for an hour.",
+                "type": "string"
+              },
+              "format": {
+                "type": "string"
+              },
+              "height": {
+                "type": "integer"
+              },
+              "name": {
+                "type": "string"
+              },
+              "size": {
+                "description": "Bytes.",
+                "type": "integer"
+              },
+              "width": {
+                "type": "integer"
+              }
+            },
+            "required": [
+              "name",
+              "format",
+              "size",
+              "width",
+              "height",
+              "download_url"
+            ],
+            "type": "object"
+          },
+          "saved_bytes": {
+            "description": "Negative when the optimized copy is larger.",
+            "type": [
+              "integer",
+              "null"
+            ]
+          },
+          "saved_percent": {
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "scan_id": {
+            "description": "The page scan that found it, if one did.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "settings": {
+            "properties": {
+              "height": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              },
+              "keep_metadata": {
+                "type": "boolean"
+              },
+              "level": {
+                "enum": [
+                  "none",
+                  "lossless",
+                  "ultra",
+                  "smart",
+                  null
+                ],
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "scale": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              },
+              "width": {
+                "type": [
+                  "integer",
+                  "null"
+                ]
+              }
+            },
+            "required": [
+              "level",
+              "keep_metadata",
+              "width",
+              "height",
+              "scale"
+            ],
+            "type": "object"
+          },
+          "share_url": {
+            "description": "Its public page, once shared.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "status": {
+            "enum": [
+              "queued",
+              "optimizing",
+              "completed",
+              "failed",
+              "already-optimized",
+              "cancelled"
+            ],
+            "type": "string"
+          },
+          "updated_at": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "status",
+          "name",
+          "original",
+          "optimized",
+          "saved_bytes",
+          "saved_percent",
+          "settings",
+          "scan_id",
+          "share_url",
+          "created_at",
+          "updated_at"
+        ],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "images_count": {
+      "type": "integer"
+    },
+    "images_finished": {
+      "type": "integer"
+    },
+    "images_in_progress": {
+      "type": "integer"
+    },
+    "note": {
+      "description": "What the scan found, or why it stopped.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "optimized_size": {
+      "description": "Bytes, over the finished images.",
+      "type": "integer"
+    },
+    "original_size": {
+      "description": "Bytes, over the finished images.",
+      "type": "integer"
+    },
+    "saved_bytes": {
+      "type": "integer"
+    },
+    "saved_percent": {
+      "type": [
+        "number",
+        "null"
+      ]
+    },
+    "settings": {
+      "properties": {
+        "format": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "height": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
+        "keep_metadata": {
+          "type": "boolean"
+        },
+        "level": {
+          "enum": [
+            "none",
+            "lossless",
+            "ultra",
+            "smart"
+          ],
+          "type": "string"
+        },
+        "scale": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
+        "width": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        }
+      },
+      "required": [
+        "level",
+        "format",
+        "keep_metadata",
+        "width",
+        "height",
+        "scale"
+      ],
+      "type": "object"
+    },
+    "status": {
+      "enum": [
+        "queued",
+        "scanning",
+        "completed",
+        "failed",
+        "no-image-found",
+        "cancelled"
+      ],
+      "type": "string"
+    },
+    "updated_at": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "url": {
+      "description": "The page scanned.",
+      "type": "string"
+    }
+  },
+  "type": "object"
+}
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering safety. The description adds valuable behavioral context beyond annotations: the polling pattern, the completion condition (status not queued/scanning and images_in_progress=0), and the 'newest first' ordering. It does not contradict annotations.

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?

The description is two sentences with no redundancy. The core purpose is front-loaded in the first sentence, and the second sentence packs essential polling instructions and an alternative tool reference. Every word earns its place.

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

Completeness5/5

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

With an output schema present, return values are covered. The description covers purpose, usage, polling behavior, and completion criteria. For a single-parameter read operation, nothing an agent needs to call it correctly is missing.

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?

The only parameter, id, is fully described in the schema as 'The scan's id.' Schema description coverage is 100%, so the description adds no additional parameter semantics. Baseline 3 is appropriate since the schema handles parameter documentation.

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?

The description clearly states the tool returns 'One page scan with every image it found, newest first, and the totals saved.' This specifies the verb (get), the resource (scan), and the output contents, distinguishing it from siblings like get_image, list_images, and scan_page.

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?

The description provides explicit usage guidance: 'Poll this, a few seconds apart, while a scan runs' and defines the completion condition. It also directs to an alternative: 'To download every finished image at once, call create_zip with the scan's id.' This clearly tells when to use this tool versus another.

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

All Iminify toolsInspect
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