Skip to main content
Glama

Refresh keyword metrics

refresh_keyword_metrics
Idempotent

Re-fetches monthly volume, difficulty, CPC and the opportunity score of one keyword, plus up to 49 companion keywords of the same website and locale, from the search-volume provider in a single call. Keywords the provider does not return are left untouched. Use it when metrics look stale (see metrics_updated_at); it does not change Google Search Console positions. Costs 1 AI brain credit, charged before the work, refunded if the provider fails. Requires an active subscription or free trial. Pass confirm=true to acknowledge the AI brain credits charge; without it the tool only returns the cost and your balance. Pass website_id when the account has several websites (see get_account).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
confirmNoSet to true to acknowledge the AI brain credit charge. Omit it to only get the cost and your balance.
keyword_idYesKeyword id from list_keywords.
website_idNoWebsite id from get_account. Optional when the account has a single website.
companion_keyword_idsNoUp to 49 other keyword ids to refresh in the same call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
website_idNoWebsite the result belongs to.
credits_balanceNoCurrent AI brain credits balance; only with requires_confirmation.
refreshed_countNo
credits_requiredNoAI brain credits the call would charge; only with requires_confirmation.
credits_balance_afterNoAI brain credits balance after this call.
requires_confirmationNoPresent when the tool did not run: it needs confirm=true. The other fields are then absent.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

The description discloses the partial-failure behavior (provider-omitted keywords are left untouched), the credit cost and refund policy, the confirmation gate (without confirm=true it only returns cost and balance), and the subscription requirement. This goes well beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core action is front-loaded, and each subsequent sentence adds a distinct fact about side effects, cost, prerequisites, or parameter conditions. There is no redundant wording.

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?

For a mutating, paid refresh call with four parameters, the description covers when to use it, how costs are charged/refunded, how the confirm parameter changes behavior, how website_id disambiguates accounts, and what happens to unfetchable keywords. An output schema is present, so return-value details are not needed.

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%, but the description adds useful context: companion keywords must share the same website and locale, website_id is needed only when the account has several websites, and confirm controls whether the charge is acknowledged. This exceeds what the schema alone states.

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?

The description names the exact resource and verb: it re-fetches monthly volume, difficulty, CPC, and opportunity score for one keyword plus up to 49 companion keywords of the same website and locale. It also distinguishes itself from plain getters by emphasizing it is a re-fetch that leaves missing provider keywords untouched and does not change Google Search Console positions.

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?

It explicitly states the trigger: use it when metrics look stale, pointing to metrics_updated_at. It also clarifies what it does not do (change GSC positions) and the prerequisite of an active subscription or free trial, though it does not name a specific alternative tool to use instead.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.