Skip to main content
Glama
ignytehq

plunk-mcp

Official
by ignytehq

Archive campaign

plunk_archive_campaign
Idempotent

Archive a Plunk campaign to hide it from the default list while keeping its performance history intact. Use instead of deleting to preserve records of finished or abandoned campaigns.

Instructions

Purpose: Hide a campaign from the default list while keeping it and all its performance history intact.

Not for: Getting rid of one for good, which is plunk_delete_campaign and discards the history with it.

Returns: The archived campaign.

Use when: Tidying up finished or abandoned campaigns without losing the record of how they did.

Note: Requires Plunk v0.15+. Fully reversible with plunk_unarchive_campaign. Scheduled and sending campaigns cannot be archived, since they still need attention.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCampaign UUID

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.0

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the annotations: states history is preserved, action is fully reversible via plunk_unarchive_campaign, requires Plunk v0.15+, and that scheduled/sending campaigns cannot be archived. These are real behavioral constraints not encoded in the structured fields.

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?

Bold-labeled sections (Purpose / Not for / Returns / Use when / Note) make it skimmable and front-loaded, with the key distinction from delete stated early. No wasted sentences.

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?

No output schema, but the description names the return value ('the archived campaign'), covers preconditions, reversibility, and version requirement. An agent has everything needed to invoke it correctly.

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?

Single 'id' parameter with 100% schema description coverage ('Campaign UUID'). The description adds no syntax or format detail beyond the schema, so baseline 3 is appropriate for a fully-documented lone parameter.

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+resource (archive a campaign) and immediately scopes it against the destructive alternative plunk_delete_campaign. An agent can distinguish it from delete/unarchive/bulk-archive without opening any schema.

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?

Explicit 'Use when' (tidying unfinished/abandoned campaigns) and 'Not for' (permanent removal, routing to plunk_delete_campaign), plus reversibility pointer to plunk_unarchive_campaign. When-to-use and when-not-to-use are both stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools