Skip to main content
Glama

Search Referral Campaigns Tool

search-referral-campaigns
Read-only

Searches authorized referral campaigns by name, status, message channel, and bounded performance fields. Use to search referral campaigns in the connected business. Returns query, count, total, campaigns, resolution, scope.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "search-referral-campaigns"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of campaigns to return.
queryNoCampaign name, message, or channel.
statusNoCampaign status.

Output Schema

NameRequiredDescriptionDefault
countYesCount for the returned result.
queryYesQuery used or returned by this tool.
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
totalYesTotal for the returned result.
campaignsYesBounded campaigns records returned by this tool.
resolutionYesResolution metadata; empty collections retain their existing JSON array representation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "campaigns": {
      +      "description": "Bounded campaigns records returned by this tool.",
      +      "items": {
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "count": {
      +      "description": "Count for the returned result.",
      +      "type": "integer"
      +    },
      +    "query": {
      +      "description": "Query used or returned by this tool.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "resolution": {
      +      "description": "Resolution metadata; empty collections retain their existing JSON array representation.",
      +      "type": [
      +        "object",
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business"
      +      ],
      +      "type": "string"
      +    },
      +    "total": {
      +      "description": "Total for the returned result.",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "query",
      +    "count",
      +    "total",
      +    "campaigns",
      +    "resolution",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered. The description does add that results are limited to 'authorized' campaigns and that only 'bounded performance fields' are searchable, which is real behavioral context, but it lists return fields ('query, count, total, campaigns, resolution, scope') that the output schema already documents.

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 short sentences with the capability front-loaded and no filler. The second sentence partially restates the first ('use to search referral campaigns' after 'searches referral campaigns'), and the trailing return-field list is low-value given the output schema.

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?

With zero required parameters, full schema coverage, and an output schema, the definition covers the essentials for a read-only search tool. It leaves open what 'bounded performance fields' means in practice, how the query string is matched, and how results are ordered or paginated.

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%, so the schema already explains limit, query, and status in detail. The description roughly mirrors those ('name, status, message channel') but its reference to 'bounded performance fields' maps to no actual parameter, adding slight ambiguity rather than extra meaning.

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 ('Searches') and resource ('authorized referral campaigns') plus the filter dimensions (name, status, message channel). The resource name implicitly separates it from siblings like search-broadcast-campaigns and search-reactivation-campaigns, but no explicit sibling differentiation is made.

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?

The sentence 'Use to search referral campaigns in the connected business' gives implied usage context only. There is no guidance on when to prefer this over preview-referral-campaign, get-referral-campaign-attribution, or the other campaign search tools, and no 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