Skip to main content
Glama

Cleotic

by io.github.generaldataworks
OverviewDiscussionsAdmin

Save segment

save_segment

Add a segment (a market and language to track), or with segment edit one or pause and resume it. Cost: an active segment is plan capacity and collects from every plan model on Mondays, Wednesdays and Fridays, using model budget. Resuming one answers prompts that missed the latest collection straight away.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
geoNoCountry code, for example GB, or global: where this segment's answers are collected from.
nameNo
brandYesBrand or study: its ID from list_brands, or its exact name. A partial name is refused.
statusNo
segmentNoEdit this segment (ID or name). Leave out to add one.
languageNoLanguage code, for example en.
prompt_limitNo
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

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
generated_atYesRFC 3339 time the response was made.
schema_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 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 / geo / description
      Previous value: -"Country code, for example GB."New value: +"Country code, for example GB, or global: where this segment's answers are collected from."
    • 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."
  2. Changed1 schema field changed
    • changedOutput schema / properties / data / properties / resource / properties / status / description
      Previous value: -"active segments collect daily; paused ones do not."New value: +"active segments collect on Mondays, Wednesdays and Fridays; paused ones do not."
  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": {
+            "id": {
+              "type": "string"
+            },
+            "language": {
+              "description": "Language code, or empty for the market's default.",
+              "type": "string"
+            },
+            "market": {
+              "description": "Country code, or global.",
+              "type": "string"
+            },
+            "models": {
+              "description": "The AI models the segment collects from: every model the plan covers.",
+              "items": {
+                "additionalProperties": false,
+                "properties": {
+                  "model": {
+                    "description": "Model family key.",
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "model",
+                  "name"
+                ],
+                "type": "object"
+              },
+              "type": "array"
+            },
+            "name": {
+              "type": "string"
+            },
+            "prompt_count": {
+              "type": "integer"
+            },
+            "prompt_limit": {
+              "type": "integer"
+            },
+            "status": {
+              "description": "active segments collect daily; paused ones do not.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "status",
+            "market",
+            "language",
+            "prompt_limit",
+            "prompt_count",
+            "models"
+          ],
+          "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

A3.7/5.0
Behavior4/5

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

The description goes beyond the annotations (readOnlyHint=false, idempotentHint=false) by disclosing operational cost semantics: active segments consume plan capacity, collect from all plan models on specific days, and use model budget. It also explains that resuming triggers immediate collection of missed prompts. This is valuable context not present in the schema or annotations.

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?

The description is concise, front-loading the primary action ('Add a segment') before detailing edit/pause/resume and cost implications. Every sentence adds value about behavior or cost. It could be slightly more structured with bullets, but it remains readable.

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?

Given the tool's complexity (multi-mode operation, cost model, scheduling) and the presence of an output schema (which needn't be explained), the description covers key behavioral aspects: creation, editing, pausing/resuming, and cost/collection details. It omits explicit mention of required parameters `brand` and `idempotency_key`, but these are documented in the 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 63%, meaning some parameters (e.g., `name`, `prompt_limit`, `language`) lack descriptions. The tool description does not add semantic detail for these parameters. It does clarify the role of `segment` (edit vs. add) and `status` (pause/resume), but this is largely inferable from the schema. Baseline 3 is appropriate.

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

Purpose4/5

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

The description clearly states the tool's multi-modal purpose: add a segment by default, or edit/pause/resume an existing one when the `segment` parameter is supplied. It names the specific resource ('segment') and distinguishes the create and update modes. However, it doesn't differentiate from all siblings like save_competitor or save_prompt, though these are clearly different resources.

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

Usage Guidelines3/5

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

The description implies when to use create vs. edit/pause/resume based on whether the `segment` parameter is provided, but it doesn't explicitly state when to use this tool versus alternatives like update_brand or set_primary_brand. No explicit exclusions or prerequisites are given beyond the cost/routing note.

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