Skip to main content
Glama

Extract Brand Kit

extract_brand_kit
Idempotent

Queue brand-token extraction from a website URL — ASYNC: returns a jobId immediately; then wait_job(kind="brand_kit_extract", id=jobId) for the tokens (colors/fonts/title/description, fetched + regex-parsed from the site's HTML/CSS — NOT a screenshot/vision pass). It does NOT persist — review the tokens, then call create_brand_kit to save a kit. A blocked (private/SSRF), non-2xx, non-HTML, or slow (>20s) URL degrades to EMPTY token arrays (a succeeded job) rather than erroring — JS-rendered SPAs typically extract empty; author the kit manually from the compiled CSS in that case.

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": {
      "body": "<body>"
    },
    "name": "extract_brand_kit"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesPOST /brand-kits/extract body — the website URL to extract brand tokens from.
commandIdNoRetry identity. A call repeated with the same commandId returns the first result instead of acting twice.

Output Schema

NameRequiredDescriptionDefault
kindNoJob family, e.g. `verify` | `preview` | `brand_kit_extract`.
jobIdNoPoll GET /v1/jobs/{jobId} / wait_job until terminal.
jobKeyNoDeterministic identity of the work (content hash of every input the result depends on). Re-enqueueing the same key returns the same job while it runs; a failed key revives as a fresh attempt.
statusNorunning on a fresh/deduped enqueue; succeeded when an identical request already completed. Cancelled is part of the shared status vocabulary; identical cancelled work revives to running.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • addedInput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "format": "uri",
      +    "type": "string"
      +  },
      +  "__schema1": {
      +    "maxLength": 128,
      +    "minLength": 1,
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / body / properties / url / $ref
      Added value: +"#/$defs/__schema0"
    • removedInput schema / properties / body / properties / url / format
      Removed value: -"uri"
    • removedInput schema / properties / body / properties / url / type
      Removed value: -"string"
    • addedInput schema / properties / commandId / $ref
      Added value: +"#/$defs/__schema1"
    • removedInput schema / properties / commandId / maxLength
      Removed value: -128
    • removedInput schema / properties / commandId / minLength
      Removed value: -1
    • removedInput schema / properties / commandId / type
      Removed value: -"string"
  2. Changed1 schema field changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Retry identity. A call repeated with the same commandId returns the first result instead of acting twice.",
      +  "maxLength": 128,
      +  "minLength": 1,
      +  "type": "string"
      +}
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial context beyond annotations: async job semantics, the 20s timeout, SSRF/private-URL blocking, non-2xx and non-HTML handling, and the crucial non-obvious behavior that all these degrade to empty token arrays on a *succeeded* job rather than an error. That failure mode is exactly what an agent would otherwise misread as success with real data. Consistent with readOnlyHint=false (a job record is queued) and idempotentHint=true.

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 verb and the ASYNC warning, and every clause carries load-bearing information (job polling, no-persistence, degradation behavior). The long em-dash-and-parenthetical sentences are dense but not padded; slightly heavier parsing than necessary.

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?

Output schema exists so return shape needn't be explained, yet the description still tells the agent the immediate return is a jobId. Combined with the async polling instruction and the empty-tokens caveat, an agent has everything needed to call this correctly and interpret the result.

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 both url and commandId (including retry-replay semantics) are already documented in the schema. The description adds the nature of the URL (a website to parse, not an asset) but says nothing about commandId, so it adds only marginal meaning over the structured fields. Baseline 3.

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+resource ('Queue brand-token extraction from a website URL') and pins the exact scope: HTML/CSS regex parsing of colors/fonts/title/description, explicitly 'NOT a screenshot/vision pass'. It also distinguishes itself from the nearest sibling by name, noting it does not persist and that create_brand_kit does.

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 the full workflow: call this, then wait_job(kind="brand_kit_extract", id=jobId), then create_brand_kit to persist. It also names the when-not case ('JS-rendered SPAs typically extract empty; author the kit manually from the compiled CSS').

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.