Set workspace brand terms
The tool adds, removes, or replaces a workspace's confirmed brand aliases. These aliases decide which queries analyze_branded_vs_nonbranded counts as branded, and which ones find_low_hanging_keywords leaves out. They are also the terms the AI-answer mention monitor scans for, so a wider list changes reported visibility. Call get_workspace_brand_terms first and show the user the current terms. replace sets the list outright. It cannot be combined with add or remove. Removals ignore case, and they are applied before additions, so renaming a term is one call. An alias that fails the checks comes back in rejected with a reason, and the rest of the write still applies. Always report the rejected aliases. An alias fails if it is too short, longer than four words, a duplicate, or past the cap of eight aliases. An alias does not have to resemble the workspace title. A former name or an unrelated acronym is a normal use.
set_workspace_brand_termsThe tool adds, removes, or replaces a workspace's confirmed brand aliases.
These aliases decide which queries analyze_branded_vs_nonbranded counts as branded, and which ones find_low_hanging_keywords leaves out. They are also the terms the AI-answer mention monitor scans for, so a wider list changes reported visibility. Call get_workspace_brand_terms first and show the user the current terms.
replace sets the list outright. It cannot be combined with add or remove. Removals ignore case, and they are applied before additions, so renaming a term is one call.
An alias that fails the checks comes back in rejected with a reason, and the rest of the write still applies. Always report the rejected aliases. An alias fails if it is too short, longer than four words, a duplicate, or past the cap of eight aliases.
An alias does not have to resemble the workspace title. A former name or an unrelated acronym is a normal use.
Parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
workspaceId | string (uuid) | Yes | — |
add | string[] | No | Aliases to add to the confirmed set. |
remove | string[] | No | Aliases to drop, matched case-insensitively. |
replace | string[] | No | Set the confirmed aliases to exactly this list. Cannot be combined with add or remove. |
Full input JSON SchemaTypes, defaults and validation rules
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "add": { "description": "Aliases to add to the confirmed set.", "type": "array", "items": { "type": "string" } }, "remove": { "description": "Aliases to drop, matched case-insensitively.", "type": "array", "items": { "type": "string" } }, "replace": { "description": "Set the confirmed aliases to exactly this list. Cannot be combined with add or remove.", "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId" ]}Response
Full output JSON SchemaEvery field the response can contain
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "title": { "type": "string" }, "brandTerms": { "type": "array", "items": { "type": "string" } }, "aliases": { "type": "array", "items": { "type": "object", "properties": { "alias": { "type": "string" }, "origin": { "type": "string" } }, "required": [ "alias", "origin" ], "additionalProperties": {} } }, "candidates": { "type": "array", "items": { "type": "string" } }, "rejected": { "type": "array", "items": { "type": "object", "properties": { "alias": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "alias", "reason" ], "additionalProperties": {} } } }, "required": [ "workspaceId", "title", "brandTerms", "aliases", "candidates", "rejected" ], "additionalProperties": false}