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

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

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. 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."
  2. 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."
  3. 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"
      +}
  4. 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=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context by saying it exposes the current state before changes and listing the settings returned, though it does not cover auth or rate-limit details.

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?

The description is two tight sentences, front-loads what settings are returned, then gives usage and sibling routing. Every clause earns its place and nothing is redundant.

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 need not explain return structure. It provides enough purpose, usage, and sibling differentiation for a one-parameter read tool whose annotations already cover safety.

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%, and the single brand parameter is fully documented in the schema as an ID from list_brands or an exact/unique-prefix name. The description adds no additional parameter syntax or format detail beyond what the schema already provides, so the baseline 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?

The description uses a specific verb (“Read”) and resource (“brand's settings”) and enumerates the exact contents: primary brand, competitors, segments, site tracking/CMS status, brand voice, and Content Studio skills. It explicitly distinguishes itself from get_brand_overview by saying metrics belong there, so an agent can select it correctly among siblings.

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?

It states concrete uses: finding competitor_id and segment values other tools take, and checking current state before changing a setting. It also names the alternative for metrics (“For metrics use get_brand_overview”), giving explicit routing guidance.

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