Skip to main content
Glama

Add keywords

add_keywords

Add one or more keywords to a Bisibility project, with optional tags, target URL, location, and schedule, to track their search rankings.

Instructions

Add one or more keywords to a project, optionally with tags, target URL, and schedule. Use search_locations and pass its location_key verbatim; an @language qualifier selects a non-default language for that location.

Input Schema

NameRequiredDescriptionDefault
cityNo
tagsNo
topicNo
deviceNoDevice whose search or ranking data is being selected.
intentNo
countryNo
keywordsYesKeyword phrases or keyword objects to add to the project.
locationNo
scheduleNo
project_idYesIdentifier of the bisibility project to operate on; list_projects returns valid project ids.
target_urlNoCanonical destination URL or site-relative path to associate with the keyword.
location_keyNoCanonical country, region, or city key. Append @language for a non-default language pair; an unqualified key uses the country's default language.
idempotency_keyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.17.1
    • changedInput schema / properties / keywords / items / anyOf
      Previous value: -[
      -  {
      -    "maxLength": 180,
      -    "minLength": 1,
      -    "type": "string"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "city": {
      -        "anyOf": [
      -          {
      -            "maxLength": 120,
      -            "minLength": 1,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "country": {
      -        "maxLength": 120,
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "device": {
      -        "description": "Device whose search or ranking data is being selected.",
      -        "enum": [
      -          "desktop",
      -          "mobile"
      -        ],
      -        "type": "string"
      -      },
      -      "intent": {
      -        "anyOf": [
      -          {
      -            "maxLength": 80,
      -            "minLength": 1,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "keyword": {
      -        "description": "Search phrase to add to the project.",
      -        "maxLength": 180,
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "location": {
      -        "maxLength": 120,
      -        "minLength": 1,
      -        "type": "string"
      -      },
      -      "location_key": {
      -        "pattern": "^[A-Z]{2}(\\/[^/]{1,80}){0,2}$",
      -        "type": "string"
      -      },
      -      "schedule": {
      -        "additionalProperties": false,
      -        "properties": {
      -          "cron_expression": {
      -            "anyOf": [
      -              {
      -                "maxLength": 120,
      -                "minLength": 1,
      -                "type": "string"
      -              },
      -              {
      -                "type": "null"
      -              }
      -            ],
      -            "description": "Cron expression for custom_cron schedules; use null for other frequencies."
      -          },
      -          "frequency": {
      -            "description": "Schedule frequency that determines when rank checks run.",
      -            "enum": [
      -              "paused",
      -              "manual",
      -              "daily",
      -              "weekly",
      -              "monthly",
      -              "custom_cron"
      -            ],
      -            "type": "string"
      -          },
      -          "jitter_minutes": {
      -            "maximum": 120,
      -            "minimum": 0,
      -            "type": "integer"
      -          },
      -          "timezone": {
      -            "maxLength": 80,
      -            "minLength": 1,
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "cron_expression",
      -          "frequency"
      -        ],
      -        "type": "object"
      -      },
      -      "tags": {
      -        "items": {
      -          "description": "Tag label assigned to the keyword.",
      -          "maxLength": 48,
      -          "minLength": 1,
      -          "type": "string"
      -        },
      -        "maxItems": 12,
      -        "type": "array"
      -      },
      -      "target_url": {
      -        "anyOf": [
      -          {
      -            "maxLength": 500,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ],
      -        "description": "Canonical destination URL or site-relative path to associate with the keyword."
      -      },
      -      "topic": {
      -        "anyOf": [
      -          {
      -            "maxLength": 80,
      -            "minLength": 1,
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "keyword"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "maxLength": 180,
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "city": {
      +        "anyOf": [
      +          {
      +            "maxLength": 120,
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "country": {
      +        "maxLength": 120,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "device": {
      +        "description": "Device whose search or ranking data is being selected.",
      +        "enum": [
      +          "desktop",
      +          "mobile"
      +        ],
      +        "type": "string"
      +      },
      +      "intent": {
      +        "anyOf": [
      +          {
      +            "maxLength": 80,
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "keyword": {
      +        "description": "Search phrase to add to the project.",
      +        "maxLength": 180,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "location": {
      +        "maxLength": 120,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "location_key": {
      +        "description": "Canonical country, region, or city key. Append @language for a non-default language pair; an unqualified key uses the country's default language.",
      +        "pattern": "^[A-Z]{2}(\\/[^/@]{1,80}){0,2}(@[a-z]{2,3}(-[a-z0-9]{2,8})?)?$",
      +        "type": "string"
      +      },
      +      "schedule": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "cron_expression": {
      +            "anyOf": [
      +              {
      +                "maxLength": 120,
      +                "minLength": 1,
      +                "type": "string"
      +              },
      +              {
      +                "type": "null"
      +              }
      +            ],
      +            "description": "Cron expression for custom_cron schedules; use null for other frequencies."
      +          },
      +          "frequency": {
      +            "description": "Schedule frequency that determines when rank checks run.",
      +            "enum": [
      +              "paused",
      +              "manual",
      +              "daily",
      +              "weekly",
      +              "monthly",
      +              "custom_cron"
      +            ],
      +            "type": "string"
      +          },
      +          "jitter_minutes": {
      +            "maximum": 120,
      +            "minimum": 0,
      +            "type": "integer"
      +          },
      +          "timezone": {
      +            "maxLength": 80,
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "cron_expression",
      +          "frequency"
      +        ],
      +        "type": "object"
      +      },
      +      "tags": {
      +        "items": {
      +          "description": "Tag label assigned to the keyword.",
      +          "maxLength": 48,
      +          "minLength": 1,
      +          "type": "string"
      +        },
      +        "maxItems": 12,
      +        "type": "array"
      +      },
      +      "target_url": {
      +        "anyOf": [
      +          {
      +            "maxLength": 500,
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ],
      +        "description": "Canonical destination URL or site-relative path to associate with the keyword."
      +      },
      +      "topic": {
      +        "anyOf": [
      +          {
      +            "maxLength": 80,
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "keyword"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / location_key / description
      Added value: +"Canonical country, region, or city key. Append @language for a non-default language pair; an unqualified key uses the country's default language."
    • changedInput schema / properties / location_key / pattern
      Previous value: -"^[A-Z]{2}(\\/[^/]{1,80}){0,2}$"New value: +"^[A-Z]{2}(\\/[^/@]{1,80}){0,2}(@[a-z]{2,3}(-[a-z0-9]{2,8})?)?$"
  2. First observedv0.6.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds context about optional attachments (tags, target URL, schedule) and the @language qualifier, but says nothing about idempotency or what happens on duplicate keywords despite an idempotency_key parameter existing.

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?

Two sentences with no filler, and the core action is front-loaded before the location guidance. The second sentence is dense but each clause carries real information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 13-parameter tool with nested per-keyword overrides and no output schema, the description only covers the headline features and one sourcing hint. It omits the string-vs-object keyword forms, per-keyword overrides, and the 500-item ceiling, leaving the agent to reconstruct much of the call from the schema alone.

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 description coverage is only 38%, so the description has to compensate. It names tags, target URL, and schedule, and explains the @language qualifier for location_key, but leaves city, topic, device, intent, country, location and idempotency_key entirely unexplained beyond the schema.

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: 'Add one or more keywords to a project', and enumerates the optional attributes it accepts. It never distinguishes itself from nearby siblings like create_saved_keywords or research_keywords, so an agent must still infer which one applies.

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 a concrete cross-tool workflow: 'Use search_locations and pass its location_key verbatim', which tells the agent how to source a required value. It stops short of saying when to use this tool versus create_saved_keywords or update_keyword, so no exclusions or alternatives are stated.

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

Deploy Server

Other Tools