Skip to main content
Glama

SEOAI - AI Visibility Tracker

List gaps

list_gaps
Read-onlyIdempotent

Lists the gaps of one brand: tracked prompts where AI answers did not cite, or rarely cited, the brand in the chosen period, most runs first. Each item has gap_class (absent: no citation and no mention; mentioned_not_cited: named but not cited; inconsistently_cited: cited in at most a third of at least three runs; not_visible_anywhere: absent with at least two runs), runs, cited_share (0 to 1), retrieval (per AI platform: runs that searched, runs that fetched a page of the brand domain, runs that cited it), top_competitor (most cited competitor page) and audit_status (none, running, ready, outdated). Get brand_id from list_brands. For an item with audit_status ready or outdated, call get_gap_audit with its prompt_id. The result carries the window used. Filters: topic_id, range (7d, 30d default, 90d), gap_class, limit (default 20, max 100) and offset. app_url opens this prompt's audit for this brand in SEOAI (the person signs in if needed).

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": {
      "brand_id": "<brand_id>"
    },
    "name": "list_gaps"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoItems per page. Default 20, max 100.
rangeNoPeriod of runs to read. Default 30d.
offsetNoItems to skip. Default 0.
brand_idYesBrand id from list_brands.
topic_idNoOnly gaps of this topic (from list_brands).
gap_classNoOnly this class. not_visible_anywhere is the subset of absent with at least two runs.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and openWorldHint=false, so safety is covered; the description adds real context on top: default ordering ('most runs first'), that the result carries the window used, and the sign-in requirement for app_url. It stops short of covering failure behavior for an invalid brand_id or anything about pagination cost at offset limits. With annotations carrying the safety profile, this is strong but not exhaustive.

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 is front-loaded in the first sentence and no sentence is filler. The middle portion is a single long run-on that packs six return fields into one breath, which would read far better as a list. Dense but not padded.

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?

Six parameters, a required input, no output schema, and the description compensates by documenting every returned field including gap_class semantics, cited_share range, retrieval per platform, top_competitor and audit_status. It also states the pagination defaults and the downstream get_gap_audit step. Nothing an agent needs to invoke or interpret this tool is missing.

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 would be 3, but the description adds meaning the schema lacks: it spells out what each gap_class value means (absent, mentioned_not_cited, inconsistently_cited, not_visible_anywhere with its run threshold) rather than only listing the enum. It also restates the defaults for range and limit and the 0-1 meaning of cited_share. The added value is in the enum semantics rather than the scalar filters.

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?

Opens with a specific verb and resource plus its scope: 'Lists the gaps of one brand: tracked prompts where AI answers did not cite, or rarely cited, the brand in the chosen period.' It goes on to define exactly what a 'gap' is via the gap_class taxonomy, so an agent knows the record shape before calling. The follow-up rule pointing to get_gap_audit also separates it from that sibling.

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?

Explicit routing is provided: 'Get brand_id from list_brands' for the required input, and 'For an item with audit_status ready or outdated, call get_gap_audit with its prompt_id' for the next step. It also explains that app_url opens the audit in SEOAI and that the person signs in if needed, covering the human hand-off path. No condition is left to inference for the common workflow.

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