Set workspace brand terms
Add, remove, or replace a workspace's confirmed brand aliases.
Tool name: set_workspace_brand_terms
Cost: Free - not billed, and does not draw on a plan quota.
Writes data - confirmation required
This tool creates or changes data. It is not annotated readOnlyHint, so
your MCP client prompts you before it runs, and the server asks for an
explicit confirmation describing exactly what will change. Declining cancels
the call cleanly.
Add, remove, or replace a workspace's confirmed brand aliases. These decide which queries analyze_branded_vs_nonbranded counts as branded and which ones find_low_hanging_keywords excludes, and they are also the term set the AI-answer mention monitor scans for - so widening them changes reported visibility, not just this session's output. Call get_workspace_brand_terms first and show the user the current terms.
replace sets the list outright and cannot be combined with add/remove. Removals are matched case-insensitively and are applied before additions, so renaming a term is one call. An alias that fails vetting (too short, longer than four words, a duplicate, or over the eight-alias cap) is returned in rejected with a reason while the rest of the write still applies - always report those back to the user. Aliases need not resemble the workspace title: a former name or an unrelated acronym is exactly what this is for.
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 Schema
{
"$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 Schema
{
"$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
}