Skip to main content
Glama

Onboard Brand

onboard_brand

Create or onboard a brand from user-selected website, Instagram, or file sources. This starts asynchronous Brand Skill creation in the selected workspace and stores supplied files in private brand storage. If a website or Instagram source matches an existing brand, the tool returns that match instead unless the user explicitly allows a duplicate. Returns the new Brand session ID and brand URL with status analyzing, or the matching brands with status duplicate.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sources": "<sources>"
    },
    "name": "onboard_brand"
  }
}

Input Schema

NameRequiredDescriptionDefault
sourcesYesRequired ordered Brand evidence: up to one website, one Instagram account, and files. File sources accept either a public HTTPS URL or a completed temporary upload ID.
llm_modelNoThe model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics.
instructionsNoGuidance for how the Brand Agent should interpret the supplied evidence during this creation run.
workspace_idNoWorkspace ID. Omit (or pass null) to default to the caller's personal workspace.
allow_duplicateNoAllow creation when a website or Instagram source matches an existing brand in the selected workspace. Set to true only after explicit user intent to create another brand. Defaults to false.
idempotency_keyNoRetry key for recovering the original Brand creation after an uncertain response. Reuse it with the same request; choose a new key when intentionally creating another Brand.

Output Schema

NameRequiredDescriptionDefault
statusYesanalyzing when creation started. duplicate when an existing brand matched and no brand was created.
matchesNoExisting brands that matched. Present when status is duplicate.
brand_urlNoLink to the new brand. Present when status is analyzing.
brand_session_idNoBrand session ID of the new brand. Present when status is analyzing.
message_for_assistantNoContext, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already flag a non-read-only, open-world, non-idempotent write, and the description adds real context beyond them: creation is asynchronous, files land in private brand storage, and matching sources short-circuit to a duplicate result. It does not explain what happens to the session on failure or how long 'analyzing' typically lasts.

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?

Four dense sentences, front-loaded with the action and sources, then behavior, then return shape. No filler, though the duplicate clause is stated twice (once in prose, once implicitly via the return status).

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, yet the description still summarizes both return shapes (new session ID + brand URL with status analyzing, or matching brands with status duplicate), which is exactly what an agent needs to branch on. Async and storage side effects are covered; only failure/retry edge cases are left implicit.

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 coverage is 100%, so the schema already documents every parameter including allow_duplicate and idempotency_key. The description reinforces the duplicate-suppression default and the retry-key intent, but adds little beyond what the schema text already says, so the baseline 3 applies.

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 onboard a brand') plus the accepted source types (website, Instagram, file), which cleanly separates it from the sibling edit/version tools like create_brand_edit and apply_brand_edit.

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 conditions: use when the user has selected website/Instagram/file sources, and only set allow_duplicate after explicit user intent. It does not name sibling alternatives (e.g., get_brand for lookup or create_brand_edit for later changes), so routing is implied rather than explicit.

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