Skip to main content
Glama

Cancel Matched Upload

cancel_matched_upload
DestructiveIdempotent

Abort a staged matched-segment upload without confirming. Call this when the user declines to proceed after reviewing analyze_audience_upload's results. Clears the staged upload — no file move, no status/mapping-state change. The existing segment is retained; cancellation does not delete it or complete matching. Inspect it with get_segment and archive it with archive_segment if no longer needed. Idempotent. Pass exactly one of segment_id or audience_id — use audience_id when only the audience is known (it resolves to that audience's matched member segment server-side). Requires 'creator' scope.

Input Schema

NameRequiredDescriptionDefault
segment_idNoThe segment_id returned by create_segment(subtype=matched)
audience_idNoThe audience_id, if segment_id isn't known

Output Schema

NameRequiredDescriptionDefault
okYesWhether the requested action succeeded
guidanceNoInterpretation or recovery guidance for this result
count_unitNo
page_countNoNumber of objects on this page, not the organization total
count_stateNoUnknown means no count; available does not guarantee freshness. Recount for a current value.
next_actionsNoSuggested next calls using returned IDs and available scopes. Not executed and not user consent.
money_displayNoCurrency amounts formatted once from source paths ending in _cents. Use verbatim; do not divide again. Null/missing source amounts are omitted, not zero.
population_inputNoPopulation input used for the preview; IDs refer to their current saved definitions

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations: clarifies that the destructiveHint covers only the staged upload (no file move, no status/mapping-state change), that the existing segment survives cancellation, that the call is idempotent, and that 'creator' scope is required. This resolves the ambiguity an agent would otherwise have about destructiveHint=true.

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?

Front-loaded with the action and trigger, and every sentence carries information (behavior, alternatives, idempotency, param exclusivity, auth). Slightly dense at six sentences, but there is no filler.

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?

An output schema exists, so return values need not be explained. Given that, the description covers everything an agent needs: trigger, side effects and non-effects, post-cancellation handling, idempotency, parameter selection, and auth scope.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema descriptions already cover both params, but the description adds a rule the schema does not enforce: pass exactly one of segment_id or audience_id, and that audience_id resolves server-side to the matched member segment. Useful added semantics beyond the 100%-covered schema.

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?

States a specific verb and resource: abort a staged matched-segment upload. Explicitly ties itself to the analyze_audience_upload workflow, making it distinguishable from generic cancel/delete siblings like archive_segment.

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?

Names the exact trigger (user declines to proceed after reviewing analyze_audience_upload results) and routes the agent to alternatives: get_segment to inspect, archive_segment if the retained segment is no longer needed. When-to-use and when-to-use-something-else are both covered.

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