Skip to main content
Glama

Cleotic

by io.github.generaldataworks
OverviewDiscussionsAdmin

Approve brand setup

approve_brand_setup

Create the brand from a ready setup's proposals. List exactly the competitor and prompt proposals to keep; an empty list keeps none of that kind, and the primary brand is always kept. Confirm the brand's market with the user first and pass it as market; get_brand_setup's segment.market and market_label give its code and label. Cost: a brand, a segment and the kept prompts from plan capacity; model budget for each prompt's first answers and the site's first readiness scan.

Input Schema

NameRequiredDescriptionDefault
marketNoThe market the user confirmed: kind country with its code, region with key and country_codes, or global. Start from get_brand_setup's segment.market and market_label.
setup_idYesSetup ID from start_brand_setup.
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.
accepted_brand_proposal_idsYesCompetitor proposal IDs to keep, from get_brand_setup. [] keeps none.
accepted_prompt_proposal_idsYesPrompt proposal IDs to keep, from get_brand_setup. [] keeps none.

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. Changed8 schema fields changed
    • 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."
    • changedInput schema / properties / market / description
      Previous value: -"The market the user confirmed for this brand."New value: +"The market the user confirmed: kind country with its code, region with key and country_codes, or global. Start from get_brand_setup's segment.market and market_label."
    • 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."
    • addedOutput schema / properties / data / properties / resource / properties / brand_name
      Added value: +{
+  "type": "string"
+}
    • changedOutput schema / properties / data / properties / resource / required
      Previous value: -[
-  "setup_id",
-  "status",
-  "brand_id",
-  "segment",
-  "prompts"
-]New value: +[
+  "setup_id",
+  "status",
+  "brand_id",
+  "brand_name",
+  "segment",
+  "prompts"
+]
  3. Changed4 schema fields changed
    • changedInput schema / properties / accepted_brand_proposal_ids / description
      Previous value: -"Competitor proposal IDs to keep, from get_brand_setup."New value: +"Competitor proposal IDs to keep, from get_brand_setup. [] keeps none."
    • changedInput schema / properties / accepted_prompt_proposal_ids / description
      Previous value: -"Prompt proposal IDs to keep, from get_brand_setup."New value: +"Prompt proposal IDs to keep, from get_brand_setup. [] keeps none."
    • changedInput schema / required
      Previous value: -[
-  "idempotency_key",
-  "setup_id"
-]New value: +[
+  "idempotency_key",
+  "setup_id",
+  "accepted_brand_proposal_ids",
+  "accepted_prompt_proposal_ids"
+]
    • 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": {
+            "brand_id": {
+              "type": "string"
+            },
+            "prompts": {
+              "items": {
+                "additionalProperties": false,
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "text": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "text"
+                ],
+                "type": "object"
+              },
+              "type": "array"
+            },
+            "segment": {
+              "additionalProperties": false,
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "name": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ],
+              "type": [
+                "null",
+                "object"
+              ]
+            },
+            "setup_id": {
+              "type": "string"
+            },
+            "status": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "setup_id",
+            "status",
+            "brand_id",
+            "segment",
+            "prompts"
+          ],
+          "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.3/5.0
Behavior4/5

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

Goes beyond the annotations (readOnlyHint=false, openWorldHint=true, destructiveHint=false, idempotentHint=false) by disclosing real cost/resource implications: plan capacity consumption (a brand, a segment, kept prompts) plus model budget for first answers and the first readiness scan. It also clarifies the keep/drop semantics of the accepted lists, which is behavioral context the annotations do not provide.

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?

Front-loaded with the core action, then proposal semantics, then market guidance, then cost. Every sentence carries information, though the final cost sentence is dense and the overall text is long for a five-parameter tool.

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 need not be described, and the description covers creation semantics, required pre-confirmation, and cost. It stops short of stating preconditions explicitly (that the setup must be in a ready state) and of naming the initiating sibling start_brand_setup.

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 baseline is 3, but the description adds meaning beyond the schema: it explains that an empty accepted list keeps none of that kind, that the primary brand is always kept, and that market must be user-confirmed before being passed. Those are semantic constraints not fully spelled out in the field descriptions.

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 the brand from a ready setup's proposals.' An agent can distinguish this from get_brand_setup (retrieve), start_brand_setup (initiate), and save_competitor/save_prompt (manual writes) 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 Guidelines4/5

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

Gives clear workflow context: it names get_brand_setup as the source of segment.market/market_label and instructs confirming the market with the user first. It implies the post-setup stage but does not explicitly name start_brand_setup as the prerequisite or state exclusions, so it falls short of a full when/when-not routing rule.

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