Skip to content
Retidal Docs

Available tools

The six tools the Retidal MCP server exposes — arguments, required scope, and what each one actually does.

The server registers exactly six tools. tools/list only advertises the subset your credential’s scope allows — see Overview § Tool visibility.

Every tool below (except get_integration_guide) is a thin forward to the same Management API documented elsewhere in these docs: a downstream 4xx is passed through with its error/issues verbatim, a downstream 5xx or network failure becomes a fixed generic upstream-error message that never leaks internal detail.

get_integration_guide

Section titled “get_integration_guide”
stackstringrequired

"node" | "browser" | "curl".

No scope required — any resolved credential can call it. Generates the event-ingestion wiring snippet for the chosen stack, filled in with your resolved apiKey only (never the secret, even if your credential is a key:secret pair). Pure content generation — it calls no downstream route.

verify_event_ingestion

Section titled “verify_event_ingestion”
eventNamestring

Optional. If provided, only a matching event name counts as “received.”

Requires scope mcp:events_write. Enables debug mode for the project if it isn’t already on, then does a single check (not long-polling) for events received in the roughly 5-second window before the call plus 1 second after. Reports either a confirmed match with the event, or a fixed “not yet received — try again in a few seconds” message. If enabling debug mode succeeds but the events query itself fails, the tool returns an error without undoing the now-enabled debug mode (enabling is idempotent, so nothing is lost).

list_recent_events

Section titled “list_recent_events”
eventNamestring

Optional substring filter.

limitnumber

Optional, default 20, clamped to 1–100.

Requires scope mcp:events_read. Forwards to the project-events catalog — this returns the aggregated list of active event types (most recently triggered first), not a feed of raw individual event rows.

register_event_schema

Section titled “register_event_schema”
appEventNamestringrequired

Your application’s event name, exactly as reported to /api/v1/t.

eventDefinitionIdstringrequired

The target standard event definition’s id — not its name/slug. There’s no tool to look this id up; get it from the console’s event-mapping UI or the Management API’s event-definitions list.

isActiveboolean

Optional. Omit it to take the downstream default (true) rather than sending false unintentionally.

Requires scope mcp:events_write. Creates an event mapping — the same mapping the console’s “event mapping” feature manages, letting your business event name (user_paid) attribute against a standard event (PURCHASE) for ad-platform conversion callbacks.

Section titled “create_short_link”
destinationUrlstringrequired

Must be a parseable http:// or https:// URL. Rejected locally (no downstream call at all) if it isn’t — you get an immediate error rather than a wasted round trip.

campaignNamestring

Optional. Defaults to "MCP Quickstart" if omitted.

utmSourcestring

Optional.

utmMediumstring

Optional.

utmCampaignstring

Optional.

Requires scope mcp:links_write. Get-or-creates a campaign by exact name (atomic on the server — concurrent calls with the same name can’t create duplicate campaigns or split links across two different ones), then creates a short link under it. Returns the short URL in the form https://api.retidal.com/s/{shortCode}. If link creation fails after the campaign was resolved, the campaign is not rolled back — it’s safely reusable on a retry.

get_attribution_report

Section titled “get_attribution_report”
startDatestring

Optional YYYY-MM-DD.

endDatestring

Optional YYYY-MM-DD.

Requires scope mcp:attribution_read. Read-only forward to the attribution analytics endpoint. Missing or unparseable dates don’t error — they silently fall back to the downstream default 30-day window.

Scope reference

Section titled “Scope reference”
Tool Required scope
get_integration_guide none
verify_event_ingestion mcp:events_write
list_recent_events mcp:events_read
register_event_schema mcp:events_write
create_short_link mcp:links_write
get_attribution_report mcp:attribution_read

Issue a scoped key with only the scopes an agent actually needs from Projects → Scoped API keys. A project key:secret pair bypasses these scope checks entirely (every tool is available) — prefer a scoped key for anything you’re handing to an agent you don’t fully trust with full project ADMIN access.