Skip to main content
Glama

Edit Keyword

edit_keyword
DestructiveIdempotent

Replace a keyword's text while keeping its ID, re-grade it, and synchronize matching rules and alerts. Use it to correct or update tracked terms without losing keyword history or monitoring.

Instructions

Replace a keyword's text while keeping its ID. Edits are unlimited. The new value is re-graded and replaces its matching rules; an active keyword stays active, while other keywords become active only if the current plan has space. Activating a suspended keyword also queues public-network searches and ranking checks. Monitoring alerts are synchronized. Case-only changes are a no-op; duplicate values on the same website fail. Previous text and matching rules are overwritten.

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": {
      "keywordId": "<keywordId>",
      "value": "<value>"
    },
    "name": "edit_keyword"
  }
}

Input Schema

NameRequiredDescriptionDefault
valueYesThe new word or phrase to look for, e.g. "acme crm". RedReplier trims and lowercases it. Another keyword on the same website with the same text makes the call fail
keywordIdYesID of the keyword to change, from the keywords list in list_websites or get_website
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 / keywordId / description
      Previous value: -"Keyword ID (UUID)"New value: +"ID of the keyword to change, from the keywords list in list_websites or get_website"
    • addedInput schema / properties / keywordId / format
      Added value: +"uuid"
    • changedInput schema / properties / value / description
      Previous value: -"New keyword text; trimmed and lowercased, must not duplicate another keyword on the same website"New value: +"The new word or phrase to look for, e.g. \"acme crm\". RedReplier trims and lowercases it. Another keyword on the same website with the same text makes the call fail"
    • addedInput schema / properties / value / minLength
      Added value: +1
    • 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 updated keyword with its new value and resulting status (ACTIVE or PENDING)."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "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"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "id",
      +  "websiteId",
      +  "value",
      +  "status",
      +  "createdAt",
      +  "updatedAt"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. Changed2 schema fields changedv0.1.1
    • changedInput schema / properties / value / description
      Previous value: -"New keyword text"New value: +"New keyword text; trimmed and lowercased, must not duplicate another keyword on the same website"
    • changedOutput schema / properties / result / description
      Previous value: -"The updated keyword with its new value and status."New value: +"The updated keyword with its new value and resulting status (ACTIVE or PENDING)."
  3. First observedv0.1.0

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already flag destructive/openWorld/idempotent, and the description adds substantial context beyond them: previous text and matching rules are overwritten, the value is re-graded, activation queues public-network searches and ranking checks, and alerts are synchronized. This is exactly the kind of side-effect disclosure a mutation tool needs.

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?

Dense, front-loaded, and each sentence carries operational information. The closing sentence ('Previous text and matching rules are overwritten') slightly restates the earlier 'replaces its matching rules', a minor redundancy.

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?

With an output schema and annotations already present, the description covers the remaining burden: side effects, activation behavior, failure modes, and overwrite semantics. Nothing essential for a correct call is missing.

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%, and the value parameter's description already covers trimming, lowercasing, and the duplicate-value failure. The description adds no new per-parameter details, so the schema baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Replace a keyword's text while keeping its ID'), which immediately distinguishes it from delete_keyword/add_keywords. It does not explicitly name sibling tools, but the retained-ID framing makes the distinction clear.

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 concrete context on when edits succeed or fail: case-only changes are a no-op and duplicate values on the same website fail, along with what happens when the keyword is active, suspended, or over plan capacity. No explicit 'use X instead' routing, but the conditions for calling it are clear.

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