Skip to main content
Glama

findBranding

Find a Payload global singleton configuration.

Single source of truth for brand identity, voice, business facts and site identity — READ FIRST when drafting content or answering about the business. Groups: voice (voiceTone, forbiddenTerms, allowedVariants, terminology) · business identity (businessType, served areas, availabilityStatus, pricing — when priceItems exist, quote them and never answer "price on request") · contact + emergencyContact · visual assets (logoLight/logoDark/favicon/defaultOgImage = upload IDs; ready-made URLs in /brand.json as logo_url/og_image_url/…) · imageStyleProfiles = the image-style canon, read it BEFORE generating images (scoping/fallback and prompt guidance are described on the fields; resolve reference-image binaries via brand find/get) · specDocs = brand/styleguide DOCUMENTS as bare upload IDs (logo files, a UI-spec HTML, web-font files). The IDs alone say nothing — resolve them via brand find/get to read filename, description and URL, and consult them when you need the visual canon (spacing, type scale, component look) that the token list does not cover. Editor usage rules often sit in the asset description ("NICHT auf weissem Hintergrund"). · htmlElements snippet templates (ready-made, brand-styled HTML/Markdown to copy and adapt — check here before hand-rolling markup) · aiAgentSystemPrompt (public bot persona, served at /brand.txt + /brand.json) · newsletter signup form copy. Field-level meaning: call getResourceSchema "branding" — fields carry editor descriptions. UPDATE POLICY (human-curated SSoT): change ONLY the specific field(s) you were explicitly asked to change — never bulk-rewrite, never "improve" neighboring fields. Many fields are localized: write per target locale, sequentially (one locale per call). branding global (singleton). Public read: yes via /api/agents/global. MCP capabilities: find, update. Fields: logoLight (upload: brand|media), logoDark (upload: brand|media), logoSquare (upload: brand|media), favicon (upload: brand|media), defaultOgImage (upload: media|brand), separator, specDocs (upload: brand), imageStyleProfiles (array), htmlElements (array), addressing (enum: du (You (informal))|sie (You (formal))), companyName, legalName, siteName (localized, required), tagline (localized), allowedVariants (textarea), responsiblePerson, founders (rel-array: team), shortDescription (localized), longDescription (richText, localized), vision (textarea, localized), values (textarea, localized), targetAudience (textarea, localized), usps (textarea, localized), notOffered (textarea, localized), voiceTone (enum-array: professional|casual|matter-of-fact|heartfelt|technical|clear|+21), voiceDescription (textarea, localized), forbiddenTerms (textarea, localized), exampleQuotes (textarea, localized), terminology (textarea, localized), industry (localized), businessType (enum-array: Electrician|Plumber|HVACBusiness|HousePainter|RoofingContractor (Roofing Contractor (roofer, roof repair))|GeneralContractor|+63), foundingYear (number), teamSize (localized), location (localized), softwareApplication (group), serviceRadiusKm (number, ≥0), servedAreas (textarea, localized), servedPostalCodes (textarea), availabilityStatus (enum: accepting (Accepting new clients)|limited (Limited capacity)|waitlist|notAccepting), availabilityNote (textarea, localized), priceItems (array), priceRange, priceNote (textarea, localized), brands (textarea), partners (textarea), certificates (textarea, localized), spokenLanguages (textarea), brandOs (richText, localized), vatId, taxId, chamberOfCommerce, reaNumber, shareCapital (localized), sdiCode, pecEmail, hostingProvider (textarea, localized), mailProvider (textarea, localized), storageProvider (textarea, localized), paymentMethods (localized), paymentTerms (number), jurisdiction (localized), email, phone, address (textarea, localized), emergencyContact (group), geoLatitude (number, -90–90), geoLongitude (number, -180–180), bookingUrl, bookingCtaText (localized), bookingNote (localized), whatsappUrl, contactMessage (textarea, localized), socialLinks (textarea), contactPage (rel: pages), aboutPage (rel: pages), weekly (array), businessHoursNote (textarea, localized), formsSubmitDefault (localized), formsSubmitting (localized), formsSelectPlaceholder (localized), formsThankYouHeadline (localized), formsThankYouBody (textarea, localized), formsGenericError (localized), enabled (boolean), checkboxLabel (localized), pendingNote (localized), alreadyActiveNote (localized), aiAgentSystemPrompt (textarea, localized), aiCatalogQueries (textarea, localized), aiSeoRules (textarea), internalLinkRules (array), internalLinkExclusions (rel-array: pages|glossary|jobs|posts|team), internalLinkMaxSuggestions (number, 1–20).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
depthNoDepth of population for relationships
localeNoOptional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields
selectNoOptional: define exactly which fields you'd like to return in the response (JSON), e.g., '{"title": true}'
fallbackLocaleNoOptional: fallback locale code to use when requested locale is not available

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and discloses substantial behavior: public read access via /api/agents/global, human-curated SSoT update policy, localized-field write constraints, and the need to resolve upload IDs separately. It also explains that fields carry editor descriptions accessible via getResourceSchema. This is rich behavioral context for a read tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the tool's purpose but is very long and includes an exhaustive field list with types that may duplicate what getResourceSchema provides. While it is structured with separators, several sentences could be trimmed without losing essential guidance.

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?

Given the complexity of a branding singleton with many fields, no annotations, and no output schema, the description provides a complete picture: what the resource contains, how to use it for content and image decisions, how to resolve upload IDs, and what the update policy is. Nothing critical for correct invocation appears 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?

Schema description coverage is 100%, so the four input parameters (depth, locale, select, fallbackLocale) are fully documented in the schema. The description does not add any syntax or meaning beyond what the schema provides for these parameters. 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 opens with a specific verb and resource: 'Find a Payload global singleton configuration.' It then identifies the resource as the brand identity singleton, which clearly distinguishes it from sibling tools like findFaqs, findMedia, and findPages. An agent can tell it apart 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 Guidelines4/5

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

It gives explicit usage direction: 'READ FIRST when drafting content or answering about the business' and 'read it BEFORE generating images.' It also points to alternatives for resolving upload IDs via 'brand' find/get. However, it does not explicitly state when not to use it or compare against the other find siblings.

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