Skip to main content
Glama

Get scoped visibility score

get-visibility-score
Read-only

Get the exact visibility score for the scope you name: prompt type, topic, custom filters and engine, in one run or a date window. Every figure is scoped to the arguments given and matches the dashboard for the same selection. Each field matches a dashboard name: score = AI AuraScore (0-100), coverage = Mention Rate (a 0-1 ratio, mentions / answers), share_of_voice = Share of Voice (a 0-1 ratio), mentions = answers that mention you, mention_count = mentions and citations behind Share of Voice; answers and prompts are the counts in scope. It is NOT equivalent to averaging get-prompt-scores: per-prompt scores do not average into the scoped score, and this tool returns the scoped figure directly. Scope is run_id when given, else the latest completed run of run_date, else the latest completed run for range latest_run, else the last range days (default 15d, the same default period as the dashboard). prompt_type defaults to non_branded (prompts naming neither us nor a competitor); branded names only us, competitor_branded names a competitor with or without us, and each prompt is in exactly one. Valid filters keys and value slugs are the ones list-prompt-filters returns; an undeclared key is rejected with the valid options. Score and share_of_voice are null when the scope has nothing to score. The response scope.run_id is the run scored (null for a date window). compare-visibility-runs compares runs or slices side by side; get-visibility-summary gives the stored summary of a run.

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": {
      "domain_id": "<domain_id>"
    },
    "name": "get-visibility-score"
  }
}

Input Schema

NameRequiredDescriptionDefault
rangeNoPool every run in the last N days (defaults to 15d), or latest_run for the newest completed run alone. Ignored with run_id or run_date.
engineNoNarrow to one engine. Omit for all engines.
run_idNoCompleted visibility run ID. Overrides range and run_date.
filtersNo{filterKey: valueSlug} from list-prompt-filters, ANDed
run_dateNoA day (YYYY-MM-DD in time_zone): scores that day's latest completed run. Overrides range.
topic_idNoTopic ID from list-prompt-topics
domain_idYesDomain ID from list-domains
time_zoneNoIANA time zone that decides which day a run belongs to. Defaults to UTC.
prompt_typeNoPrompt Type segment. Defaults to non_branded.non_branded

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / domain_id / description
      Previous value: -"Domain ID"New value: +"Domain ID from list-domains"
    • changedInput schema / properties / filters / description
      Previous value: -"Custom filter selection as {filterKey: valueSlug}, ANDed across keys."New value: +"{filterKey: valueSlug} from list-prompt-filters, ANDed"
    • changedInput schema / properties / topic_id / description
      Previous value: -"Narrow to one prompt topic of this domain"New value: +"Topic ID from list-prompt-topics"
  2. Changed5 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / domain_id / pattern
      Added value: +"^([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)$"
    • addedInput schema / properties / filters / propertyNames
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / run_id / pattern
      Added value: +"^([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)$"
    • addedInput schema / properties / topic_id / pattern
      Added value: +"^([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)$"
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare it is a safe read; the description goes well beyond that by defining scope precedence, defaulting behavior, rejection of undeclared filter keys, and null semantics for score/share_of_voice when nothing is in scope. It also states that scope.run_id is null for a date window, which is exactly the kind of return-value behavior annotations cannot convey.

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?

Purpose and scope resolution are front-loaded and every sentence carries information, but it is one dense paragraph with no visual separation between scope rules, field mappings, and sibling routing. Slightly harder to scan than it needs to be, though nothing is gratuitous.

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?

There is no output schema, so the description carries the burden of explaining returns, and it does: score, coverage, share_of_voice, mentions, mention_count, answers and prompts are each mapped to their dashboard names and definitions. Combined with null behavior and single-run vs date-window semantics, an agent has everything needed to call and interpret it.

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, but the description adds real meaning: it defines the three prompt_type segments and their mutual exclusivity, the 15d default for range, the source of valid filter keys, and the precedence among run_id/run_date/range. Engine, time_zone and domain_id are left to the schema, which is reasonable since they are self-explanatory.

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 (get the visibility score) plus the exact scope axes it accepts: prompt type, topic, filters, engine, run or date window. It explicitly separates itself from get-prompt-scores, compare-visibility-runs and get-visibility-summary, so an agent can pick it without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use and when-not-to-use: it warns that it is NOT equivalent to averaging get-prompt-scores, and names the two alternatives with their distinct roles. It also documents the full scope-resolution precedence (run_id, then run_date, then latest_run, then last `range` days) and the default period.

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.

Resources