Skip to content

Knuckles-Team/listmonk-api

Repository files navigation

Listmonk Api

CLI or API | MCP | Agent

PyPI - Version MCP Server PyPI - Downloads GitHub Repo stars GitHub forks GitHub contributors PyPI - License GitHub GitHub last commit (by committer) GitHub pull requests GitHub closed pull requests GitHub issues GitHub top language GitHub language count GitHub repo size GitHub repo file count (file type) PyPI - Wheel PyPI - Implementation

Version: 1.0.1

Documentation — Installation, deployment, usage across the API, CLI, MCP, and agent interfaces, and guidance for provisioning the Listmonk platform are maintained in the official documentation.


Overview

Listmonk Api is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with Python Listmonk API Wrapper.


Key Features

  • Consolidated Action-Routed MCP Tools: Minimizes token overhead and eliminates tool bloat in LLM contexts by grouping methods into optimized, togglable tool modules.
  • Enterprise-Grade Security: Comprehensive support for Eunomia policies, OIDC token delegation, and granular execution context tracking.
  • Integrated Graph Agent: Built-in Pydantic AI agent supporting the Agent Control Protocol (ACP) and standard Web interfaces (AG-UI).
  • Native Telemetry & Tracing: Out-of-the-box OpenTelemetry exports and native Langfuse tracing.

CLI or API

This agent wraps the Python Listmonk API Wrapper API. You can interact with it programmatically or via its integrated execution entrypoints.

Detailed instructions on how to use the underlying API wrappers, extended schema bindings, and developer SDK references are maintained in docs/index.md.


MCP

This server utilizes dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.

Available MCP Tools

Auto-generated — do not edit between the markers below.

Condensed action-routed tools (default — MCP_TOOL_MODE=condensed)

MCP Tool Toggle Env Var Description
listmonk_campaigns LISTMONK_CAMPAIGNSTOOL Manage listmonk campaigns operations.
listmonk_imports LISTMONK_IMPORTSTOOL Manage listmonk imports operations.
listmonk_lists LISTMONK_LISTSTOOL Manage listmonk lists operations.
listmonk_media LISTMONK_MEDIATOOL Manage listmonk media operations.
listmonk_subscribers LISTMONK_SUBSCRIBERSTOOL Manage listmonk subscribers operations.
listmonk_templates LISTMONK_TEMPLATESTOOL Manage listmonk templates operations.
listmonk_tx LISTMONK_TXTOOL Manage listmonk tx operations.

Verbose 1:1 API-mapped tools (MCP_TOOL_MODE=verbose or both)

32 per-operation tools — one per public API method (click to expand)
MCP Tool Toggle Env Var Description
listmonk_create_campaign LISTMONK_APITOOL Invoke the create_campaign operation.
listmonk_create_list LISTMONK_APITOOL Invoke the create_list operation.
listmonk_create_subscriber LISTMONK_APITOOL Invoke the create_subscriber operation.
listmonk_delete BASE_API_CLIENTTOOL Invoke the delete operation.
listmonk_delete_campaign LISTMONK_APITOOL Invoke the delete_campaign operation.
listmonk_delete_media LISTMONK_APITOOL Invoke the delete_media operation.
listmonk_delete_subscriber_import LISTMONK_APITOOL Invoke the delete_subscriber_import operation.
listmonk_delete_template LISTMONK_APITOOL Invoke the delete_template operation.
listmonk_edit_list LISTMONK_APITOOL Invoke the edit_list operation.
listmonk_get BASE_API_CLIENTTOOL Invoke the get operation.
listmonk_get_campaign LISTMONK_APITOOL Invoke the get_campaign operation.
listmonk_get_campaign_preview LISTMONK_APITOOL Invoke the get_campaign_preview operation.
listmonk_get_campaign_stats LISTMONK_APITOOL Invoke the get_campaign_stats operation.
listmonk_get_campaigns LISTMONK_APITOOL Invoke the get_campaigns operation.
listmonk_get_list LISTMONK_APITOOL Invoke the get_list operation.
listmonk_get_lists LISTMONK_APITOOL Invoke the get_lists operation.
listmonk_get_media LISTMONK_APITOOL Invoke the get_media operation.
listmonk_get_subscriber LISTMONK_APITOOL Invoke the get_subscriber operation.
listmonk_get_subscriber_import_logs LISTMONK_APITOOL Invoke the get_subscriber_import_logs operation.
listmonk_get_subscriber_import_status LISTMONK_APITOOL Invoke the get_subscriber_import_status operation.
listmonk_get_subscribers LISTMONK_APITOOL Invoke the get_subscribers operation.
listmonk_get_subscribers_from_list LISTMONK_APITOOL Invoke the get_subscribers_from_list operation.
listmonk_get_template LISTMONK_APITOOL Invoke the get_template operation.
listmonk_get_template_preview LISTMONK_APITOOL Invoke the get_template_preview operation.
listmonk_get_templates LISTMONK_APITOOL Invoke the get_templates operation.
listmonk_import_subscribers LISTMONK_APITOOL Invoke the import_subscribers operation.
listmonk_post BASE_API_CLIENTTOOL Invoke the post operation.
listmonk_put BASE_API_CLIENTTOOL Invoke the put operation.
listmonk_set_campaign_status LISTMONK_APITOOL Invoke the set_campaign_status operation.
listmonk_set_default_template LISTMONK_APITOOL Invoke the set_default_template operation.
listmonk_transactional_message LISTMONK_APITOOL Invoke the transactional_message operation.
listmonk_upload_media LISTMONK_APITOOL Invoke the upload_media operation.

7 action-routed tool(s) (default) · 32 verbose 1:1 tool(s). Each is enabled unless its <DOMAIN>TOOL toggle is set false; MCP_TOOL_MODE selects the surface (condensed default · verbose 1:1 · both). Auto-generated — do not edit.

Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows you to restrict the set of exposed tools in order to prevent blowing up the LLM's context window.

You can configure tool filtering via multiple input channels:

  • CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.
  • Environment Variables: Define standard environment variables:
    • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS
    • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS
  • HTTP SSE Request Headers: Pass custom headers during transport initialization:
    • x-mcp-enabled-tools / x-mcp-disabled-tools
    • x-mcp-enabled-tags / x-mcp-disabled-tags
  • HTTP SSE Request Query Parameters: Append query parameters directly to your transport connection URL:
    • ?tools=tool1,tool2
    • ?tags=tag1

When query strings or parameters are supplied, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.


MCP Configuration Examples

Install the slim [mcp] extra. All examples install listmonk-api[mcp] — the MCP-server extra that pulls only the FastMCP / FastAPI tooling (agent-utilities[mcp]). It deliberately excludes the heavy agent runtime (pydantic-ai, the epistemic-graph engine, dspy, llama-index), so uvx / container installs are far smaller. Use the full [agent] extra only when you need the integrated Pydantic AI agent.

stdio Transport (local IDEs — Cursor, Claude Desktop, VS Code)

{
  "mcpServers": {
    "listmonk-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "listmonk-api[mcp]",
        "listmonk-mcp"
      ],
      "env": {
        "MCP_TOOL_MODE": "condensed",
        "LISTMONK_CAMPAIGNSTOOL": "True",
        "LISTMONK_IMPORTSTOOL": "True",
        "LISTMONK_LISTSTOOL": "True",
        "LISTMONK_MEDIATOOL": "True",
        "LISTMONK_SUBSCRIBERSTOOL": "True",
        "LISTMONK_TEMPLATESTOOL": "True",
        "LISTMONK_TOKEN": "your_bearer_token_here",
        "LISTMONK_TXTOOL": "True",
        "LISTMONK_URL": "http://localhost:8080",
        "OPENAPI_CLIENT_ID": "",
        "OPENAPI_PASSWORD": "adminpassword",
        "OPENAPI_USERNAME": "admin"
      }
    }
  }
}

Streamable-HTTP Transport (networked / production)

{
  "mcpServers": {
    "listmonk-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "listmonk-api[mcp]",
        "listmonk-mcp",
        "--transport",
        "streamable-http",
        "--port",
        "8000"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "MCP_TOOL_MODE": "condensed",
        "LISTMONK_CAMPAIGNSTOOL": "True",
        "LISTMONK_IMPORTSTOOL": "True",
        "LISTMONK_LISTSTOOL": "True",
        "LISTMONK_MEDIATOOL": "True",
        "LISTMONK_SUBSCRIBERSTOOL": "True",
        "LISTMONK_TEMPLATESTOOL": "True",
        "LISTMONK_TOKEN": "your_bearer_token_here",
        "LISTMONK_TXTOOL": "True",
        "LISTMONK_URL": "http://localhost:8080",
        "OPENAPI_CLIENT_ID": "",
        "OPENAPI_PASSWORD": "adminpassword",
        "OPENAPI_USERNAME": "admin"
      }
    }
  }
}

Alternatively, connect to a pre-deployed Streamable-HTTP instance by url:

{
  "mcpServers": {
    "listmonk-mcp": {
      "url": "http://localhost:8000/listmonk-mcp/mcp"
    }
  }
}

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name listmonk-mcp-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e HOST=0.0.0.0 \
  -e PORT=8000 \
  -e MCP_TOOL_MODE=condensed \
  -e LISTMONK_CAMPAIGNSTOOL=True \
  -e LISTMONK_IMPORTSTOOL=True \
  -e LISTMONK_LISTSTOOL=True \
  -e LISTMONK_MEDIATOOL=True \
  -e LISTMONK_SUBSCRIBERSTOOL=True \
  -e LISTMONK_TEMPLATESTOOL=True \
  -e LISTMONK_TOKEN=your_bearer_token_here \
  -e LISTMONK_TXTOOL=True \
  -e LISTMONK_URL=http://localhost:8080 \
  -e OPENAPI_CLIENT_ID="" \
  -e OPENAPI_PASSWORD=adminpassword \
  -e OPENAPI_USERNAME=admin \
  knucklessg1/listmonk-api:mcp

Auto-generated from the code-read env surface (MCP_TOOL_MODE + package vars) — do not edit.

Additional Deployment Options

listmonk-api can also run as a local container (Docker / Podman / uv) or be consumed from a remote deployment. The Deployment guide has full, copy-paste mcp_config.json for all four transports — stdio, streamable-http, local container / uv, and remote URL:

  • Local container / uv — launch the server from mcp_config.json via uvx, docker run, or podman run, or point at a local streamable-http container by url.
  • Remote URL — connect to a server deployed behind Caddy at http://listmonk-mcp.arpa/mcp using the "url" key.

Agent

This repository features a fully integrated Pydantic AI Graph Agent. It communicates over the Agent Control Protocol (ACP) and interacts seamlessly with the Agent Web UI (AG-UI) and Terminal interface.

Running the Agent CLI

To start the interactive command-line agent:

# Set credentials
export LISTMONK_URL="your_listmonk_url_here"
export LISTMONK_USERNAME="your_listmonk_username_here"
export LISTMONK_PASSWORD="your_listmonk_password_here"

# Run the agent server
listmonk-agent --provider openai --model-id gpt-4o

Docker Compose Orchestration

The following docker/agent.compose.yml configures the Agent, Web UI, and Terminal Interface together:

version: '3.8'

services:
  listmonk-api-mcp:
    image: knucklessg1/listmonk-api:latest
    container_name: listmonk-api-mcp
    hostname: listmonk-api-mcp
    restart: always
    env_file:
      - ../.env
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=streamable-http
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

  listmonk-api-agent:
    image: knucklessg1/listmonk-api:latest
    container_name: listmonk-api-agent
    hostname: listmonk-api-agent
    restart: always
    depends_on:
      - listmonk-api-mcp
    env_file:
      - ../.env
    command: [ "listmonk-agent" ]
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=9004
      - MCP_URL=http://listmonk-api-mcp:8000/mcp
      - PROVIDER=${PROVIDER:-openai}
      - MODEL_ID=${MODEL_ID:-gpt-4o}
      - ENABLE_WEB_UI=True
      - ENABLE_OTEL=True
    ports:
      - "9004:9004"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:9004/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

Detailed graph node architecture explanations, custom skill configurations, and agentic trace guides are available in docs/agent.md.


Security & Governance

Built directly upon the enterprise-ready agent-utilities core, standard security parameters are fully supported:

Access Control & Policy Enforcement

  • Eunomia Policies: Fine-grained, policy-driven tool authorization. Supports none, local embedded (mcp_policies.json), or centralized remote modes.
  • OIDC Token Delegation: Compliant with RFC 8693 token exchange for flowing authenticating user credentials from Web UI / ACP → Agent → MCP.
  • Scoped Credentials: Execution context runs restricted to the specific caller identity.

Runtime Security Grid

Feature Functionality Enablement
Tool Guard Sensitivity inspection with human-in-the-loop validation Enabled by default
Prompt Injection Defense Input scanning, repetition monitoring, and recursive loop blocks Enabled by default
Context Safety Guard Stuck-loop detectors and contextual overflow preemptive alerts Enabled by default

Environment Variables

Package environment variables

Variable Example Description
HOST 0.0.0.0
PORT 8000
TRANSPORT stdio options: stdio, streamable-http, sse
ENABLE_OTEL True
OTEL_EXPORTER_OTLP_ENDPOINT http://localhost:8080/api/public/otel
OTEL_EXPORTER_OTLP_PUBLIC_KEY pk-...
OTEL_EXPORTER_OTLP_SECRET_KEY sk-...
OTEL_EXPORTER_OTLP_PROTOCOL http/protobuf
AUTH_TYPE
EUNOMIA_TYPE none options: none, embedded, remote
EUNOMIA_POLICY_FILE mcp_policies.json
EUNOMIA_REMOTE_URL http://eunomia-server:8000
OIDC_BASE_URL
OPENAPI_USERNAME admin
OPENAPI_PASSWORD adminpassword
OPENAPI_CLIENT_ID OAuth client id for OpenAPI tool import
OPENAPI_CLIENT_SECRET OAuth client secret for OpenAPI tool import
LISTMONK_URL http://localhost:8080
LISTMONK_TOKEN your_bearer_token_here
LISTMONK_CAMPAIGNSTOOL True
LISTMONK_IMPORTSTOOL True
LISTMONK_LISTSTOOL True
LISTMONK_MEDIATOOL True
LISTMONK_SUBSCRIBERSTOOL True
LISTMONK_TEMPLATESTOOL True
LISTMONK_TXTOOL True

Inherited agent-utilities variables (apply to every connector)

Variable Example Description
MCP_TOOL_MODE condensed Tool surface: condensed
MCP_ENABLED_TOOLS Comma-separated tool allow-list
MCP_DISABLED_TOOLS Comma-separated tool deny-list
MCP_ENABLED_TAGS Comma-separated tag allow-list
MCP_DISABLED_TAGS Comma-separated tag deny-list
MCP_CLIENT_AUTH Outbound MCP auth (oidc-client-credentials for fleet calls)
OIDC_CLIENT_ID OIDC client id (service-account auth)
OIDC_CLIENT_SECRET OIDC client secret (service-account auth)
DEBUG False Verbose logging
PYTHONUNBUFFERED 1 Unbuffered stdout (recommended in containers)
MCP_URL http://localhost:8000/mcp URL of the MCP server the agent connects to
PROVIDER openai LLM provider for the agent
MODEL_ID gpt-4o Model id for the agent
ENABLE_WEB_UI True Serve the AG-UI web interface

26 package + 14 inherited variable(s). Auto-generated from .env.example + the shared agent-utilities set — do not edit.

The server and client support standard configuration environment variables:

Variable Description Default
LISTMONK_URL Base URL of your Listmonk instance. http://localhost:8080
LISTMONK_TOKEN Bearer Token used for secure API authorization. ""
LISTMONK_USERNAME Username for Basic Authorization (if token is empty). ""
LISTMONK_PASSWORD Password for Basic Authorization (if token is empty). ""
Toggles
LISTMONK_SUBSCRIBERSTOOL Enable or disable the listmonk_subscribers tool. True
LISTMONK_LISTSTOOL Enable or disable the listmonk_lists tool. True
LISTMONK_IMPORTSTOOL Enable or disable the listmonk_imports tool. True
LISTMONK_CAMPAIGNSTOOL Enable or disable the listmonk_campaigns tool. True
LISTMONK_MEDIATOOL Enable or disable the listmonk_media tool. True
LISTMONK_TEMPLATESTOOL Enable or disable the listmonk_templates tool. True
LISTMONK_TXTOOL Enable or disable the listmonk_tx tool. True
Security & Policies
AUTH_TYPE Type of API authentication schema required. ""
EUNOMIA_TYPE Type of authorization engine policy enforcement (none, embedded, remote). none
EUNOMIA_POLICY_FILE Path to your local policy definition file (e.g., mcp_policies.json). ""
EUNOMIA_REMOTE_URL Host/Port URL pointing to a remote Eunomia policy daemon. ""
ALLOWED_CLIENT_REDIRECT_URIS Whitelisted URIs allowed to complete Oauth/OIDC identity validation flows. ""
OAUTH_BASE_URL Base endpoint of your trusted OAuth provider. ""
OIDC_BASE_URL Base endpoint of your OIDC identity provider. ""
OpenAPI Docs
OPENAPI_USERNAME Username whitelisted to view internal raw API specifications. ""
OPENAPI_PASSWORD Password whitelisted to view internal raw API specifications. ""
OPENAPI_BEARER_TOKEN Bearer authorization token used to limit raw API specifications access. ""

Installation

Pick the extra that matches what you want to run:

Extra Installs Use when
listmonk-api[mcp] Slim MCP server only (agent-utilities[mcp] — FastMCP/FastAPI) You only run the MCP server (smallest install / image)
listmonk-api[agent] Full agent runtime (agent-utilities[agent,logfire] — Pydantic AI + the epistemic-graph engine) You run the integrated agent
listmonk-api[all] Everything (mcp + agent + logfire) Development / both surfaces
# MCP server only (recommended for tool hosting — slim deps)
uv pip install "listmonk-api[mcp]"

# Full agent runtime (Pydantic AI + epistemic-graph engine)
uv pip install "listmonk-api[agent]"

# Everything (development)
uv pip install "listmonk-api[all]"      # or: python -m pip install "listmonk-api[all]"

Container images (:mcp vs :agent)

One multi-stage docker/Dockerfile builds two right-sized images, selected by --target:

Image tag Build target Contents Entrypoint
knucklessg1/listmonk-api:mcp --target mcp listmonk-api[mcp]slim, no engine/pydantic-ai/dspy/llama-index/tree-sitter listmonk-mcp
knucklessg1/listmonk-api:latest --target agent (default) listmonk-api[agent]full agent runtime + epistemic-graph engine listmonk-agent
docker build --target mcp   -t knucklessg1/listmonk-api:mcp    docker/   # slim MCP server
docker build --target agent -t knucklessg1/listmonk-api:latest docker/   # full agent

docker/mcp.compose.yml runs the slim :mcp server; docker/agent.compose.yml runs the agent (:latest) with a co-located :mcp sidecar.

Knowledge-graph database (epistemic-graph)

The full agent ([agent] / :latest) embeds the epistemic-graph engine (pulled in transitively via agent-utilities[agent]). For production — or to share one knowledge graph across multiple agents — run epistemic-graph as its own database container and point the agent at it instead of embedding it. Deployment recipes (single-node + Raft HA), connection config, and the full database architecture (with diagrams) are documented in the epistemic-graph deployment guide. The slim [mcp] server does not require the database.


Documentation

The complete documentation is published as the official documentation site and is the recommended reference for installation, deployment, and day-to-day operation.

Page Contents
Installation pip, source, extras, prebuilt Docker image
Deployment run the MCP and agent servers, Compose, Caddy + Technitium, env config
Usage the MCP tools, the ListmonkAPI client, the agent CLI
Backing Platform deploy Listmonk with Docker
Overview API structure, tool reference, quick start
Concepts concept registry (CONCEPT:LM-*)

Repository Owners

GitHub followers GitHub User's stars


Contribute

Contributions are welcome! Please ensure code quality by executing local checks before submitting pull requests:

  • Format code using ruff format .
  • Lint code using ruff check .
  • Validate type-safety with mypy .
  • Execute test suites using pytest

Deploy with agent-os-genesis

This package can be provisioned for you — skill-guided — by the agent-os-genesis universal skill (its single-package deploy mode): it picks your install method, seeds secrets to OpenBao/Vault (or .env), trusts your enterprise CA, registers the MCP server, and verifies it — the same machinery that stands up the whole Agent OS, narrowed to just this package. Ask your agent to "deploy listmonk-api with agent-os-genesis".

Install mode Command
Bare-metal, prod (PyPI) uvx listmonk-mcp · or uv tool install listmonk-api
Bare-metal, dev (editable) uv pip install -e ".[all]" · or pip install -e ".[all]"
Container, prod deploy knucklessg1/listmonk-api:latest via docker-compose / swarm / podman / podman-compose / kubernetes
Container, dev (editable) deploy docker/compose.dev.yml (source-mounted at /src; edits live on restart)

Secrets are read-existing + seeded via vault_sync — you are only prompted for what's missing.

About

Listmonk Python API Wrapper

Topics

Resources

License

Stars

Watchers

Forks

Contributors