Skip to main content
Glama

get_citation_rate_cumulative

Read-only

Get cumulative citation rate — average citation rate for each competitor across the date range. citation_rate is absolute (share of all responses); relative_citation_rate is the share of responses citing the website or any tracked competitor.

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": {
      "website_id": "<website_id>",
      "filters": "<filters>"
    },
    "name": "get_citation_rate_cumulative"
  }
}

Input Schema

NameRequiredDescriptionDefault
filtersYes
website_idYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / data / additionalProperties / properties / relative_citation_rate
      Added value: +{
      +  "type": "number"
      +}
    • changedOutput schema / properties / data / additionalProperties / required
      Previous value: -[
      -  "citation_rate",
      -  "is_self"
      -]New value: +[
      +  "citation_rate",
      +  "relative_citation_rate",
      +  "is_self"
      +]
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuine value by explaining what the two returned rates mean (absolute share of all responses vs. share citing the site or a tracked competitor), which is the non-obvious part of this metric. It says nothing about permissions, empty-result behavior, or aggregation edge cases, which is acceptable given annotations and an output schema.

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 tightly packed sentences: purpose and aggregation scope first, metric definitions second. Every clause carries meaning, though the second sentence is dense with domain jargon that assumes familiarity with 'absolute' vs. 'relative' rates.

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 metric aggregator with a rich nested filter schema and an output schema, the description covers the 'what does the number mean' question well. It falls short on routing (cumulative vs. time-series) and on any hint that the large filter object controls which responses are counted.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description says nothing about website_id or the filters object, despite reported schema description coverage of 0%. An agent must go entirely to the schema to learn that start_date is required, how dates are parsed, or that schedule_id, saved_view_id, and prompt_tags_operator behave specially — the description compensates for none of that.

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?

Names a specific verb and resource ('Get cumulative citation rate') and immediately defines the aggregate: 'average citation rate for each competitor across the date range.' That scope word 'cumulative/across the date range' implicitly separates it from the time-series sibling, though it never names that sibling outright.

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

Usage Guidelines3/5

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

Usage is only implied by the metric definition — an agent can infer this is the tool for an aggregate-per-competitor view rather than a trend. There is no explicit when-to-use, when-not, or pointer to get_citation_rate_time_series for the per-period view.

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