Skip to main content
Glama

Quote a campaign

quote_campaign
Read-onlyIdempotent

Checks a campaign BEFORE launching it, for free: every problem at once (not just the first), any adjustments we would make, the flat price that launching would charge, and whether your balance covers it (and by how much it is short). For targeted campaigns pass cohortSize (the number of people), never the addresses. Always quote before launch_campaign.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindYesopen_link: a share link anyone can answer, closing at responseCap — put it in your own post-purchase email. targeted: we email one invitation per address in cohortEmails.
titleYesShown to participants, e.g. 'How was your order?'
apiKeyYesYour Clearvoyance API key (cv_live_… or cv_test_…), from create_account
giftTextNoShown to a participant after answering: a promo code, a thank-you, a link. Optional.
questionsYes1–10 questions participants answer by voice or text. No links or phone numbers.
cohortSizeNotargeted only: how many people you will invite (10–200). The number, not the addresses.
minPercentNotargeted only: results unlock once this share of the list has answered. Floored at 50.
senderNameNoWho is asking, as participants see it (your shop or product name). Required for open_link.
descriptionYesWhat you want to learn. Steers the AI analysis; participants do not see it.
responseCapNoopen_link only: 10, 50, 100 or 200 — the link closes at that many answers. Sets the tier: $4.99 / $17.99 / $29.99 / $49.99.
expiresInDaysNo1–42. Default 14 for open_link, 7 for targeted.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds value by disclosing that the tool is free, reports all problems at once rather than just the first, and lists the specific outputs (adjustments, flat price, balance shortfall). This explains behavioral traits beyond the annotations without contradicting them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the key purpose ('Checks a campaign BEFORE launching it'), and every phrase earns its place. The parameter caution and usage directive are concise and actionable, with no fluff or redundancy.

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?

This is a complex tool with 11 parameters, but the schema provides full coverage. The description covers the tool's purpose, when to use it, and a critical parameter misuse caution. Combined with the annotations (read-only, idempotent) and the output schema (present), the description is complete enough for an agent to call it correctly without additional clarification.

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 coverage is 100% and all parameters have descriptions. The description's note about passing cohortSize instead of addresses merely repeats the schema's existing 'The number, not the addresses' for that parameter. No new semantic meaning is added beyond the schema, so the baseline of 3 is appropriate.

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?

The description clearly states the tool checks a campaign before launch, enumerating the specific outputs (problems, adjustments, price, balance coverage). It distinguishes itself from launch_campaign by saying 'Always quote before launch_campaign,' but it does not explicitly differentiate from the sibling validate_campaign. Overall, the purpose is clear and specific, though sibling differentiation is implicit rather than explicit.

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?

The description gives explicit usage guidance: 'Always quote before launch_campaign' provides a clear when-to-use directive. It also includes a specific parameter caution ('For targeted campaigns pass cohortSize (the number of people), never the addresses'), which prevents misuse. This is strong, actionable guidance that goes beyond the schema.

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