Skip to main content
Glama

Get Referral Campaign Attribution Tool

get-referral-campaign-attribution
Read-only

Shows verified referral campaign totals and conversion activity without returning referral tokens or bearer-like links. Use to get referral campaign attribution in the connected business. Returns campaign, days, asked_total, converted_total, conversion_rate, links, scope.

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": {
      "campaign_id": "<campaign_id>"
    },
    "name": "get-referral-campaign-attribution"
  }
}

Input Schema

NameRequiredDescriptionDefault
daysNoLookback window in days.
campaign_idYesReferral campaign ID returned by search-referral-campaigns.

Output Schema

NameRequiredDescriptionDefault
daysYesDays for the returned result.
linksYesBounded links records returned by this tool.
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
campaignYesCampaign data returned by the authorized safe projection.
asked_totalYesAsked total for the returned result.
conversion_rateYesObserved campaign conversion rate.
converted_totalYesConverted total for the returned result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / required
      Added value: +[
      +  "campaign_id"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "asked_total": {
      +      "description": "Asked total for the returned result.",
      +      "type": "integer"
      +    },
      +    "campaign": {
      +      "description": "Campaign data returned by the authorized safe projection.",
      +      "type": "object"
      +    },
      +    "conversion_rate": {
      +      "description": "Observed campaign conversion rate.",
      +      "type": "number"
      +    },
      +    "converted_total": {
      +      "description": "Converted total for the returned result.",
      +      "type": "integer"
      +    },
      +    "days": {
      +      "description": "Days for the returned result.",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "links": {
      +      "description": "Bounded links records returned by this tool.",
      +      "items": {
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "campaign",
      +    "days",
      +    "asked_total",
      +    "converted_total",
      +    "conversion_rate",
      +    "links",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.5/5.0
Behavior4/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 safety is covered. The description adds genuinely new behavioral context by disclosing what is deliberately excluded from the response (referral tokens and bearer-like links), which matters for privacy-sensitive callers. It does not say what 'verified' means in this context, which is a small remaining gap.

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?

Three short sentences, front-loaded with the outcome and the privacy constraint before the generic usage line. The second sentence is largely redundant with the title and first sentence, which is the main wasted phrasing.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Output schema exists, so listing return fields is not required, and the safety profile is carried by annotations. Combined with full schema coverage, the definition covers enough for correct invocation, though the absence of any sibling comparison or explanation of 'verified' attribution leaves a modest gap for a reporting tool.

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 the schema documents both parameters fully, including default 30 and the 1–180 range for days and the origin of campaign_id. The description adds no syntax, format, or interpretation guidance beyond the schema; it only echoes 'days' in the return-field list, so the baseline of 3 applies.

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?

States a specific verb and resource: shows verified referral campaign totals and conversion activity for a given campaign. It is clear what the tool returns and it hints at a privacy boundary (no tokens/links). It does not explicitly distinguish itself from the closely named sibling preview-referral-campaign, leaving that differentiation to be inferred.

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

Usage Guidelines2/5

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

The only guidance is 'Use to get referral campaign attribution in the connected business,' which restates the tool name rather than saying when to choose it. There is no mention of when not to use it, and no routing to or away from siblings such as preview-referral-campaign or search-referral-campaigns.

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