Skip to main content
Glama

Read a campaign

readCampaign
Read-onlyIdempotent

One campaign as it is saved: its name, status, subject and the one it tests, preview line, audience, the brief it was written from, and its body, block by block, in the shape updateCampaign's blocks takes. A products block also has items: what it shows now, prices as the email writes them (one that picks for each reader shows what a reader nobody knows would get). productsLeftOut lists chosen products that will not show. Takes the broadcastId (readCampaigns lists them).

Only for a workspace with subscribed email contacts.

Input Schema

NameRequiredDescriptionDefault
broadcastIdYesThe campaign, by its id in Kooga
workspaceIdNoThe workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace.

Output Schema

NameRequiredDescriptionDefault
logoYesThe logo a header block draws, from the email brand settings; null draws the store's name as text. updateEmailBrand sets it
nameYes
briefYesWhat it was written from, when it was
blocksYes
statusYes
subjectYes
audienceYes'all', or the segment's name
subjectBYesThe subject tested against it; null when there is no test
preheaderYes
segmentIdYes
broadcastIdYes
productsLeftOutYesChosen products that will not show: unknown here, out of stock, without a page or not on sale

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive behavior, so the description need not restate safety. It adds useful behavioral context about the campaign being 'as it is saved,' product block item behavior, fallback pricing for anonymous readers, and `productsLeftOut` entries that will not display.

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?

The description is dense but front-loads the core purpose and then adds relevant return-shape details. Some sentences, especially the products block explanation, are compact and parenthetical, but there is little obvious filler.

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 full return-value documentation is not required. The description still covers the important compatibility detail that the body shape matches `updateCampaign`'s `blocks` parameter and explains key products-block behavior, making it largely complete for an agent.

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%, so both parameters are already documented. The description adds that `broadcastId` comes from `readCampaigns`, but does not expand on `workspaceId` beyond what the schema says, so it provides only marginal added meaning.

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?

The description states a specific verb and resource: it reads one saved campaign and enumerates the fields returned. It also distinguishes itself from `readCampaigns` by noting that tool lists broadcast IDs, so an agent can choose the singular tool for one campaign without opening schemas.

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?

It gives a clear prerequisite (`broadcastId`, obtainable from `readCampaigns`) and a workspace constraint for subscribed email contacts. It does not explicitly say when to avoid this tool versus `updateCampaign` or other campaign-related siblings, but the usage context is clear.

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