Skip to main content
Glama

Add Keywords

add_keywords

Add keywords to a monitored website so the system tracks mentions and queues ranking checks; terms are normalized, deduplicated, and activated within your current plan.

Instructions

Add keywords to a monitored website. Values are trimmed, lowercased and deduplicated; active values are skipped and disabled values may be proposed again. New keywords start pending, then those within the existing plan become active without a charge. Activation updates monitoring alerts and queues public-network searches and ranking checks. Keywords beyond the current entitlement stay pending. Returns the whole website with its updated keyword list. Use edit_keyword to change existing text.

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": {
      "websiteId": "<websiteId>",
      "keywords": "<keywords>"
    },
    "name": "add_keywords"
  }
}

Input Schema

NameRequiredDescriptionDefault
keywordsYesWords or phrases whose mentions to look for, e.g. ["my product", "competitor name"]
websiteIdYesID of the website to add the keywords to, from list_websites or the id create_website returned
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv1.6.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / keywords / description
      Previous value: -"Keywords to add (e.g. [\"my product\", \"competitor name\"]); trimmed, lowercased, and de-duplicated, max 255 characters each"New value: +"Words or phrases whose mentions to look for, e.g. [\"my product\", \"competitor name\"]"
    • addedInput schema / properties / keywords / maxItems
      Added value: +100
    • changedInput schema / properties / websiteId / description
      Previous value: -"Monitored website ID (UUID)"New value: +"ID of the website to add the keywords to, from list_websites or the id create_website returned"
    • addedInput schema / properties / websiteId / format
      Added value: +"uuid"
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "description": "Workspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another",
      +  "type": "string"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / result / additionalProperties
      Added value: +true
    • removedOutput schema / properties / result / description
      Removed value: -"The whole website with its full keyword list (id, value, status), including the new keywords as ACTIVE or PENDING."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "accountGroupId": {
      +    "description": "Workspace the website belongs to",
      +    "type": "string"
      +  },
      +  "createdAt": {
      +    "description": "When the website was added, ISO 8601",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "description": {
      +    "description": "Context every new mention is scored against; null means new mentions go unscored",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "domain": {
      +    "description": "Domain taken from url; identifies the site in this account",
      +    "type": "string"
      +  },
      +  "id": {
      +    "description": "Website ID for the other tools",
      +    "type": "string"
      +  },
      +  "ignoredKeywords": {
      +    "description": "Lowercased words and phrases; mentions containing one are hidden",
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  },
      +  "keywords": {
      +    "description": "Every keyword on the website, in any status",
      +    "items": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "createdAt": {
      +          "description": "When the keyword was added, ISO 8601",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "id": {
      +          "description": "Keyword ID for edit_keyword, enable_keyword, disable_keyword and delete_keyword",
      +          "type": "string"
      +        },
      +        "status": {
      +          "description": "PENDING (saved, not monitored until the plan covers it), ACTIVE, DISABLED or SUSPENDED",
      +          "type": "string"
      +        },
      +        "updatedAt": {
      +          "description": "When the keyword last changed, ISO 8601",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "value": {
      +          "description": "Lowercased keyword text, the value list_mentions filters on",
      +          "type": "string"
      +        },
      +        "websiteId": {
      +          "description": "Website this keyword belongs to",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "websiteId",
      +        "value",
      +        "status",
      +        "createdAt",
      +        "updatedAt"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "name": {
      +    "description": "Display name; null when none was set",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "updatedAt": {
      +    "description": "When the website last changed, ISO 8601",
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "url": {
      +    "description": "Website address as saved",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "id",
      +  "accountGroupId",
      +  "domain",
      +  "url",
      +  "name",
      +  "description",
      +  "ignoredKeywords",
      +  "createdAt",
      +  "updatedAt",
      +  "keywords"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. Changed2 schema fields changedv0.1.1
    • changedInput schema / properties / keywords / description
      Previous value: -"Keywords to add (e.g. [\"my product\", \"competitor name\"])"New value: +"Keywords to add (e.g. [\"my product\", \"competitor name\"]); trimmed, lowercased, and de-duplicated, max 255 characters each"
    • changedOutput schema / properties / result / description
      Previous value: -"The added keywords with their IDs and resulting statuses (ACTIVE or PENDING)."New value: +"The whole website with its full keyword list (id, value, status), including the new keywords as ACTIVE or PENDING."
  3. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true) by disclosing normalization (trim/lowercase/dedupe), the pending-to-active lifecycle, billing behavior (no charge within plan, pending beyond entitlement), and downstream side effects (alert updates, queued public-network searches and ranking checks). None of that is derivable from structured fields.

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 action, then layered with normalization, lifecycle, billing, and side effects in compact sentences; the closing edit_keyword pointer is well placed. Slightly dense, and the return-value sentence is partly redundant with the existing output schema, but nothing is filler.

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?

Covers the mutation, its side effects, entitlement limits, and duplicate handling for a 3-parameter write tool, and an output schema already documents the returned website. An agent has everything needed to call it correctly and predict the outcome.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns extra credit by explaining how keyword values are normalized, deduplicated, and gated by entitlement, which is meaning the schema's array-of-strings does not convey. websiteId/workspaceId semantics are left entirely to the schema, which is acceptable at full coverage.

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 ('Add keywords to a monitored website') and explicitly separates itself from the sibling edit_keyword for changing existing text. An agent can distinguish it from enable/disable/delete_keyword without opening any 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?

Names the alternative for editing ('Use edit_keyword to change existing text') and explains what happens when values already exist (active skipped, disabled may be re-proposed). It stops short of a full when-not matrix, but the routing guidance is clear and actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.