Skip to main content
Glama
@kieksme/listmonk-mcp

@kieksme/listmonk-mcp

by kieksme

Preview Campaign As Plain Text

listmonk_preview_campaign_text
Read-onlyIdempotent

Render a campaign's plain-text version to verify fallback formatting or review spam score without persisting changes.

Instructions

Renders the plain-text version of a campaign (defaults content_type to 'plain'), useful for checking the text-fallback rendering or for spam-score review. Does not persist anything.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "listmonk_preview_campaign_text"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesNumeric id.
bodyNoUnsaved body to render (omit to use the campaign's saved body).
template_idNo
content_typeNoplain

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.3.0

TDQS

A4/5.0
Behavior3/5

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

Adds value beyond the annotations by declaring "Does not persist anything", reinforcing readOnlyHint=true, and by disclosing the content_type default. Beyond that it says nothing about what the returned text looks like, whether errors occur for campaigns lacking a plain part, or how template_id interacts with rendering.

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?

Two compact sentences, front-loaded with the action and the useful use cases; the non-persistence note is appended efficiently. No filler, though it could be tightened slightly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Sufficient for a simple read-only preview tool with annotations covering safety, but the non-obvious parameters (body, template_id) and the fact that no output schema exists mean the agent gets no help predicting the return value's shape or size.

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 coverage is only 50%, and the description compensates by explaining content_type's default behavior ('plain'), which is the parameter an agent would actually consider overriding. The optional body, template_id, and id semantics remain undocumented in the description and only partly in the 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 ("Renders the plain-text version of a campaign") plus a distinguishing detail: it defaults to text-only output, which separates it from the HTML/visual renderer siblings like listmonk_preview_campaign and listmonk_get_campaign_preview.

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?

Gives clear use contexts (checking text-fallback rendering, spam-score review) and notes it defaults content_type to 'plain'. It does not explicitly say when to prefer the sibling HTML preview or convert_campaign_content instead, so the alternative routing is implied rather than 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