Skip to main content
Glama

Cleotic

by io.github.generaldataworks
OverviewDiscussionsAdmin

Set primary brand

set_primary_brand

Create or edit the brand being tracked: its name, domain, and aliases. Pass at least one; what you leave out stays as it is. To add a competitor use save_competitor; to rename a brand or study, or pause it, use update_brand. A change to how answers name the brand re-reads existing answers automatically; it returns pending until that finishes. Free.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoThe brand's name as answers name it.
brandYesBrand or study: its ID from list_brands, or its exact name. A partial name is refused.
domainNoThe brand's website domain, for example example.com.
aliasesNoThe full list of other names answers use for the brand. Replaces the current aliases, so include the existing ones; [] clears them.
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. Changed2 schema fields changed
    • addedInput schema / properties / domain / description
      Added value: +"The brand's website domain, for example example.com."
    • addedInput schema / properties / name / description
      Added value: +"The brand's name as answers name it."
  2. Changed8 schema fields changed
    • changedInput schema / properties / aliases / description
      Previous value: -"Other names answers use for the brand."New value: +"The full list of other names answers use for the brand. Replaces the current aliases, so include the existing ones; [] clears them."
    • 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."
    • changedOutput schema / properties / data / properties / resource / properties / reanalysis / properties / status / description
      Previous value: -"queued, running, or failed."New value: +"queued, running, or failed; done once a write's operation shows the re-read finished."
  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": {
+            "aliases": {
+              "description": "Other names answers use for the brand.",
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "id": {
+              "type": "string"
+            },
+            "name": {
+              "type": "string"
+            },
+            "reanalysis": {
+              "additionalProperties": false,
+              "properties": {
+                "job_id": {
+                  "type": "string"
+                },
+                "message": {
+                  "type": "string"
+                },
+                "status": {
+                  "description": "queued, running, or failed.",
+                  "type": "string"
+                }
+              },
+              "required": [
+                "status",
+                "message"
+              ],
+              "type": [
+                "null",
+                "object"
+              ]
+            },
+            "status": {
+              "description": "active or paused. A paused competitor is not tracked.",
+              "type": "string"
+            },
+            "url": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "url",
+            "aliases",
+            "status",
+            "reanalysis"
+          ],
+          "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. Changed7 schema fields changed
    • addedInput schema / properties / aliases
      Added value: +{
+  "description": "Other names answers use for the brand.",
+  "items": {
+    "maxLength": 4096,
+    "minLength": 1,
+    "type": "string"
+  },
+  "maxItems": 100,
+  "type": "array"
+}
    • addedInput schema / properties / brand
      Added value: +{
+  "description": "Brand or study: its ID from list_brands, or its name.",
+  "minLength": 1,
+  "type": "string"
+}
    • addedInput schema / properties / domain
      Added value: +{
+  "maxLength": 2048,
+  "type": "string"
+}
    • removedInput schema / properties / input
      Removed value: -{
-  "additionalProperties": false,
-  "minProperties": 1,
-  "properties": {
-    "aliases": {
-      "items": {
-        "maxLength": 4096,
-        "minLength": 1,
-        "type": "string"
-      },
-      "maxItems": 100,
-      "type": "array"
-    },
-    "domain": {
-      "maxLength": 2048,
-      "type": "string"
-    },
-    "name": {
-      "maxLength": 4096,
-      "minLength": 1,
-      "type": "string"
-    }
-  },
-  "type": "object"
-}
    • addedInput schema / properties / name
      Added value: +{
+  "maxLength": 4096,
+  "minLength": 1,
+  "type": "string"
+}
    • removedInput schema / properties / project_id
      Removed value: -{
-  "maxLength": 4096,
-  "minLength": 1,
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "idempotency_key",
-  "project_id",
-  "input"
-]New value: +[
+  "brand",
+  "idempotency_key"
+]
  5. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare write/not-read-only, non-destructive, open-world, and non-idempotent. The description adds genuinely non-structured behavior: editing how answers name the brand triggers an automatic re-read of existing answers and the call returns 'pending' until it completes, plus that it is free. It does not restate annotation-covered facts.

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?

Four tight sentences, front-loaded with the action and the partial-update rule, followed by sibling routing and the async/status caveat. No filler or redundancy.

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?

Output schema exists so return values need no explanation, and the description covers the async 'pending' lifecycle and cost. For a mutation tool, the remaining gap is the unresolved overlap with update_brand on renaming, which an agent may need to disambiguate.

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

Parameters4/5

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

Schema coverage is 100%, so the schema baseline is 3, but the description adds PATCH-style semantics not present in the schema: 'Pass at least one; what you leave out stays as it is.' That meaningfully changes how an agent constructs the args beyond the field-level docs.

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 and resource — create or edit the tracked brand — and enumerates the editable surface (name, domain, aliases). It explicitly distinguishes itself from save_competitor and update_brand by name, so an agent can separate it from siblings without opening schemas.

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

Usage Guidelines4/5

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

Names two alternatives with explicit routing conditions ('to add a competitor use save_competitor; to rename a brand or study, or pause it, use update_brand'). However, this leaves a real ambiguity: the description also says this tool edits the brand's name, while update_brand is said to rename a brand — the boundary between the two is not fully resolved.

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