Skip to main content
Glama

Get the overview

get_overview
Read-only

Get the headline numbers of one update, as on the app's dashboard: the brand's visibility (share of answers naming it), average position (1 = named first), share of voice and how often its website is cited; the same per AI model; every brand named with its visibility, position and share of voice; and the 15 websites cited most. The best first call to answer "how visible are we in AI answers?". Defaults to the latest update, all models and all topics. Read-only.

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": {
      "project": "<project>"
    },
    "name": "get_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
modelNoAn AI model id from get_project (ai_models[].id, for example "chatgpt" or "gemini"), to keep only that model's answers. Default: all models.
topicNoA topic name or id from get_project (topics), to keep only that topic's prompts. Default: all topics.
updateNoAn update (run) id from list_updates, to read an earlier update. Default: the latest update.
projectYesThe project: its id or its address (for example "acme-france"), as returned by list_projects.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • changedInput schema / properties / model / description
      Previous value: -"An AI model id (for example \"chatgpt\", \"gemini\") to keep only its answers. See get_project."New value: +"An AI model id from get_project (ai_models[].id, for example \"chatgpt\" or \"gemini\"), to keep only that model's answers. Default: all models."
    • changedInput schema / properties / project / description
      Previous value: -"The project: its id, or its address (for example \"acme-france\"). See list_projects."New value: +"The project: its id or its address (for example \"acme-france\"), as returned by list_projects."
    • changedInput schema / properties / topic / description
      Previous value: -"A topic name or id to keep only its prompts. See get_project."New value: +"A topic name or id from get_project (topics), to keep only that topic's prompts. Default: all topics."
    • changedInput schema / properties / update / description
      Previous value: -"An update (run) id from list_updates. Default: the latest update."New value: +"An update (run) id from list_updates, to read an earlier update. Default: the latest update."
  2. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the 'Read-only' note is consistent rather than informative. Beyond that, the description discloses the default window (latest update) and the default filter scope (all models, all topics), which is meaningful behavioral context an agent needs to interpret results without passing optional params.

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 dashboard analogy are front-loaded, followed by a compact enumeration of returned metrics and a routing hint. The middle return-value list is dense but each item is a distinct metric; nothing is padding.

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 return contents, and it does so thoroughly (headline metrics, per-model breakdown, per-brand rows, top 15 websites). Combined with the stated defaults and read-only nature, an agent has everything needed to call this correctly.

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 100% and each parameter already documents its source tool (get_project, list_updates) and its default. The description only restates the defaults in aggregate ('Defaults to the latest update, all models and all topics'), adding no syntax or semantics beyond the schema, so the baseline 3 applies.

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 ('headline numbers of one update, as on the app's dashboard') and enumerates exactly what is returned: visibility, average position, share of voice, website citations, per-model breakdown, all brands, top 15 websites. Positioned against siblings by describing itself as 'the best first call' for a visibility question, so an agent knows this is the summary entry point rather than get_answer or get_sources.

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 an explicit triggering question ('how visible are we in AI answers?') and states the default scope (latest update, all models, all topics), which tells the agent this is the broad first look. It does not name when to switch to siblings such as get_sources or get_answer for drill-down, so it is clear context without explicit exclusions.

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