Skip to main content
Glama

Cleotic

by io.github.generaldataworks
OverviewDiscussionsAdmin

Run readiness scan

run_readiness_scan

Start a full site readiness scan of the brand's website. Owners and admins only. Only the first scan, or a retry while none has completed, can be started by hand; later scans run weekly, and the call is then refused with scheduled_only and next_run_at (get_readiness shows can_start_scan). verify_readiness_fix re-checks one issue. Returns pending; follow it with get_operation or get_readiness. Cost: one full scan, counted for the month; scans have no monthly allowance.

Input Schema

NameRequiredDescriptionDefault
brandYesBrand or study: its ID from list_brands, or its exact name. A partial name is refused.
idempotency_keyYesA unique key for this intended action. Reuse it with identical arguments when retrying: the write is not made again, and the reply is the first call's resource as saved (replayed: true) with current status; read tools show the resource's current state. Use a new key for another action.

Output Schema

NameRequiredDescriptionDefault
dataYes
generated_atYesRFC 3339 time the response was made.
schema_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / data / properties / cost / properties / content_generations / description
      Previous value: -"Content Studio generations used from the plan's allowance."New value: +"Content Studio pages or outreach drafts used from the plan's allowance."
  2. Changed6 schema fields changed
    • changedInput schema / properties / brand / description
      Previous value: -"Brand or study: its ID from list_brands, or its name."New value: +"Brand or study: its ID from list_brands, or its exact name. A partial name is refused."
    • changedInput schema / properties / idempotency_key / description
      Previous value: -"A unique key for this intended action. Reuse it with identical arguments when retrying; use a new key for another action."New value: +"A unique key for this intended action. Reuse it with identical arguments when retrying: the write is not made again, and the reply is the first call's resource as saved (replayed: true) with current status; read tools show the resource's current state. Use a new key for another action."
    • changedOutput schema / properties / data / properties / brand / description
      Previous value: -"The brand written to; null for brand setup before approval."New value: +"The brand written to; null for start_brand_setup, which has no brand yet."
    • changedOutput schema / properties / data / properties / cost / properties / readiness_scans / description
      Previous value: -"Site readiness scans used from the plan's monthly allowance."New value: +"Full site readiness scans started; counted for the month, with no monthly allowance."
    • addedOutput schema / properties / data / properties / created_at
      Added value: +{
+  "description": "Set on a replay: when the original call was made.",
+  "type": "string"
+}
    • changedOutput schema / properties / data / properties / replayed / description
      Previous value: -"True when this repeats an earlier call with the same idempotency_key."New value: +"True when this repeats an earlier call with the same idempotency_key. The write is not made again: resource is as first saved, status, progress and message are current, and the read tools show the resource's current state."
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "additionalProperties": false,
+  "properties": {
+    "data": {
+      "additionalProperties": false,
+      "properties": {
+        "brand": {
+          "additionalProperties": false,
+          "description": "The brand written to; null for brand setup before approval.",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "name": {
+              "type": "string"
+            },
+            "url": {
+              "description": "The brand's website, or empty when none is set.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "url"
+          ],
+          "type": [
+            "null",
+            "object"
+          ]
+        },
+        "cost": {
+          "additionalProperties": false,
+          "description": "What the write used from the plan's capacity, allowances and model budget; null when nothing.",
+          "properties": {
+            "content_generations": {
+              "description": "Content Studio generations used from the plan's allowance.",
+              "type": "integer"
+            },
+            "model_budget": {
+              "description": "Whether the call spends the organisation's AI model budget.",
+              "type": "boolean"
+            },
+            "note": {
+              "type": "string"
+            },
+            "prompt_capacity": {
+              "description": "Active prompts added against the plan's prompt limit.",
+              "type": "integer"
+            },
+            "queued_model_runs": {
+              "description": "Answer collections queued; each uses model budget.",
+              "type": "integer"
+            },
+            "readiness_checks": {
+              "description": "Readiness re-checks used from the plan's monthly allowance.",
+              "type": "integer"
+            },
+            "readiness_scans": {
+              "description": "Site readiness scans used from the plan's monthly allowance.",
+              "type": "integer"
+            }
+          },
+          "required": [
+            "model_budget",
+            "content_generations",
+            "readiness_scans",
+            "readiness_checks",
+            "prompt_capacity",
+            "queued_model_runs",
+            "note"
+          ],
+          "type": [
+            "null",
+            "object"
+          ]
+        },
+        "message": {
+          "description": "What happens next.",
+          "type": "string"
+        },
+        "operation_id": {
+          "description": "Pass to get_operation to follow the write.",
+          "type": "string"
+        },
+        "poll_after_seconds": {
+          "description": "While pending, how long to wait before calling get_operation; 0 otherwise.",
+          "type": "integer"
+        },
+        "progress": {
+          "additionalProperties": false,
+          "description": "Set while the work runs.",
+          "properties": {
+            "done": {
+              "type": "integer"
+            },
+            "message": {
+              "type": "string"
+            },
+            "stage": {
+              "type": "string"
+            },
+            "total": {
+              "description": "0 when the total is not known.",
+              "type": "integer"
+            }
+          },
+          "required": [
+            "stage",
+            "done",
+            "total",
+            "message"
+          ],
+          "type": [
+            "null",
+            "object"
+          ]
+        },
+        "replayed": {
+          "description": "True when this repeats an earlier call with the same idempotency_key.",
+          "type": "boolean"
+        },
+        "resource": {
+          "additionalProperties": false,
+          "properties": {
+            "page_limit": {
+              "type": "integer"
+            },
+            "scan_id": {
+              "type": "string"
+            },
+            "status": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "scan_id",
+            "status",
+            "page_limit"
+          ],
+          "type": "object"
+        },
+        "status": {
+          "description": "completed: done. pending: saved, with work still running; call get_operation after poll_after_seconds. failed: the work after the write failed; message says why.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "operation_id",
+        "status",
+        "replayed",
+        "brand",
+        "resource",
+        "progress",
+        "poll_after_seconds",
+        "message",
+        "cost"
+      ],
+      "type": "object"
+    },
+    "generated_at": {
+      "description": "RFC 3339 time the response was made.",
+      "type": "string"
+    },
+    "schema_version": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "schema_version",
+    "generated_at",
+    "data"
+  ],
+  "type": "object"
+}
  4. Added

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations: annotations only cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), while the description discloses the authorization requirement (owners/admin), the refusal mode with concrete error fields, the async pattern (returns pending, poll with get_operation/get_readiness), and the quota cost of one scan counted against the month with no monthly allowance.

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

Conciseness4/5

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

Dense and front-loaded: purpose first, then eligibility, then refusal/limits, then follow-up. Almost every clause carries information, though the mid-section compresses several distinct rules (scheduling cadence, refusal fields, sibling pointer) into a single run-on sentence that is slightly harder to parse than it needs to be.

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?

For a mutating, quota-consuming, asynchronous tool, the description covers everything the agent needs before calling: who may call, when the call is refused, the async follow-up path, and the cost. Return-value details are rightly left to the existing output schema.

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 description coverage is 100%, so both parameters (brand, idempotency_key) are already fully documented in the schema. The description adds only indirect context about retries that touches the idempotency key, but no new syntax or format detail; baseline 3 is correct when the schema does the heavy lifting.

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+resource with scope: 'Start a full site readiness scan of the brand's website.' It also distinguishes itself from the two closest siblings by name — get_readiness (status) and verify_readiness_fix (re-checks one issue) — so an agent can route without opening any 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?

Explicit eligibility and preconditions: owners/admins only, and the call is permitted only for a first scan or a retry while none has completed; otherwise it is refused with scheduled_only and next_run_at. It also names the follow-up alternatives (get_operation, get_readiness) for the pending result.

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

All Cleotic 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