Skip to main content
Glama

Get brand settings

get_brand_settings
Read-onlyIdempotent

Read the brand's settings: primary brand, competitors, segments (market, language, models), site tracking and CMS status, brand voice, and Content Studio skills. Use it to find the competitor_id and segment values other tools take, and to see the current state before changing a setting. For metrics use get_brand_overview.

Input Schema

NameRequiredDescriptionDefault
brandYesBrand or study: its ID from list_brands, or its name (exact or a unique prefix).

Output Schema

NameRequiredDescriptionDefault
dataYes
generated_atYesRFC 3339 time the response was made.
schema_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / properties / data / properties / segments / items / properties / audience
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "The buyer the segment's prompts are asked as, or null when answers are collected for an anonymous user.",
      +  "properties": {
      +    "age_band": {
      +      "type": "string"
      +    },
      +    "archetype": {
      +      "type": "string"
      +    },
      +    "budget": {
      +      "type": "string"
      +    },
      +    "company_complexity": {
      +      "type": "string"
      +    },
      +    "company_size": {
      +      "type": "string"
      +    },
      +    "expertise": {
      +      "type": "string"
      +    },
      +    "gender": {
      +      "type": "string"
      +    },
      +    "home": {
      +      "type": "string"
      +    },
      +    "household": {
      +      "type": "string"
      +    },
      +    "industry": {
      +      "type": "string"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "label": {
      +      "type": "string"
      +    },
      +    "occupation": {
      +      "type": "string"
      +    },
      +    "priorities": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "role": {
      +      "type": "string"
      +    },
      +    "seniority": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "kind"
      +  ],
      +  "type": [
      +    "null",
      +    "object"
      +  ]
      +}
    • addedOutput schema / properties / data / properties / segments / items / properties / audience_text
      Added value: +{
      +  "description": "The 'About me' line sent with every prompt in the segment; empty without an audience.",
      +  "type": "string"
      +}
    • changedOutput schema / properties / data / properties / segments / items / properties / models / description
      Previous value: -"The AI models the segment collects from: every model the plan covers."New value: +"The AI models the segment collects from: every model the plan covers, except Google AI Overviews and AI Mode for a segment with an audience."
    • changedOutput schema / properties / data / properties / segments / items / required
      Previous value: -[
      -  "id",
      -  "name",
      -  "status",
      -  "market",
      -  "language",
      -  "prompt_limit",
      -  "prompt_count",
      -  "models"
      -]New value: +[
      +  "id",
      +  "name",
      +  "status",
      +  "market",
      +  "language",
      +  "audience",
      +  "audience_text",
      +  "prompt_limit",
      +  "prompt_count",
      +  "models"
      +]
  2. Changed1 schema field changed
    • changedOutput schema / properties / data / properties / segments / items / properties / status / description
      Previous value: -"active segments collect on Mondays, Wednesdays and Fridays; paused ones do not."New value: +"active segments collect daily; paused ones do not."
  3. Changed1 schema field changed
    • changedOutput schema / properties / data / 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."
  4. Changed1 schema field changed
    • changedOutput schema / properties / data / properties / segments / items / 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."
  5. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / brand / minLength
      Added value: +1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "brand": {
      +          "additionalProperties": false,
      +          "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": "object"
      +        },
      +        "brand_voice": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "tone": {
      +              "description": "professional, confident, educational, conversational, executive, technical, or persuasive; empty when no default is set.",
      +              "type": "string"
      +            },
      +            "updated_at": {
      +              "description": "Empty when the tone was never set.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "tone",
      +            "updated_at"
      +          ],
      +          "type": "object"
      +        },
      +        "competitors": {
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "aliases": {
      +                "description": "Other names answers use for the brand.",
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "id": {
      +                "type": "string"
      +              },
      +              "name": {
      +                "type": "string"
      +              },
      +              "status": {
      +                "description": "active or paused. A paused competitor is not tracked.",
      +                "type": "string"
      +              },
      +              "url": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "name",
      +              "url",
      +              "aliases",
      +              "status"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "kind": {
      +          "type": "string"
      +        },
      +        "primary_brand": {
      +          "additionalProperties": false,
      +          "description": "The brand being tracked; null until it is set.",
      +          "properties": {
      +            "aliases": {
      +              "description": "Other names answers use for the brand.",
      +              "items": {
      +                "type": "string"
      +              },
      +              "type": "array"
      +            },
      +            "id": {
      +              "type": "string"
      +            },
      +            "name": {
      +              "type": "string"
      +            },
      +            "status": {
      +              "description": "active or paused. A paused competitor is not tracked.",
      +              "type": "string"
      +            },
      +            "url": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "name",
      +            "url",
      +            "aliases",
      +            "status"
      +          ],
      +          "type": [
      +            "null",
      +            "object"
      +          ]
      +        },
      +        "reanalysis": {
      +          "additionalProperties": false,
      +          "description": "Set while answers are being re-read after a brand or competitor change.",
      +          "properties": {
      +            "job_id": {
      +              "type": "string"
      +            },
      +            "message": {
      +              "type": "string"
      +            },
      +            "status": {
      +              "description": "queued, running, or failed.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "status",
      +            "message"
      +          ],
      +          "type": [
      +            "null",
      +            "object"
      +          ]
      +        },
      +        "segments": {
      +          "items": {
      +            "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"
      +          },
      +          "type": "array"
      +        },
      +        "site": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "cms": {
      +              "description": "Content Studio publishing to a CMS: off, on, or needs_attention.",
      +              "type": "string"
      +            },
      +            "last_visit_at": {
      +              "description": "Latest tracked visit.",
      +              "type": "string"
      +            },
      +            "tracking": {
      +              "description": "AI traffic tracking: off, setup (installed, no signal yet), listening, on, or paused.",
      +              "type": "string"
      +            },
      +            "url": {
      +              "description": "The brand's website, or empty when none is set.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "url",
      +            "tracking",
      +            "last_visit_at",
      +            "cms"
      +          ],
      +          "type": "object"
      +        },
      +        "skills": {
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "excerpt": {
      +                "description": "The start of the skill's instructions.",
      +                "type": "string"
      +              },
      +              "id": {
      +                "type": "string"
      +              },
      +              "name": {
      +                "type": "string"
      +              },
      +              "scope": {
      +                "description": "organisation: applies to every brand. brand: this brand only.",
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "name",
      +              "scope",
      +              "excerpt"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "status": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "brand",
      +        "kind",
      +        "status",
      +        "primary_brand",
      +        "competitors",
      +        "segments",
      +        "site",
      +        "brand_voice",
      +        "skills",
      +        "reanalysis"
      +      ],
      +      "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"
      +}
  6. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered and the bar is lower. The description adds useful framing as a state-inspection read used to source IDs for other tools, but offers nothing on rate limits, auth scopes, or payload shape beyond the output schema.

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?

Two tightly packed sentences with the scope front-loaded before the routing hint, and every clause (settings list, ID lookup, pre-change inspection, metrics alternative) carries distinct information.

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, the description is not obligated to describe return values, and it covers purpose, usage trigger, sibling routing, and the pre-mutation inspection role completely. Nothing an agent needs to call this 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?

There is a single 'brand' parameter with 100% schema description coverage that already explains ID vs. exact/unique-prefix name resolution. The description adds no syntax or format detail beyond the schema, so the baseline of 3 is appropriate.

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 ('Read the brand's settings') and enumerates exactly which settings are returned (primary brand, competitors, segments, tracking/CMS status, brand voice, Content Studio skills). It also explicitly differentiates itself from the metrics sibling by naming get_brand_overview, so an agent can select it without opening the 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?

Gives explicit positive triggers ('find the competitor_id and segment values other tools take') and a clear workflow role ('see the current state before changing a setting'), plus an explicit exclusion routing metrics queries to get_brand_overview. Nothing is left to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources