Listmonk Api

CLI or API | MCP | Agent

Version: 0.16.0

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

Tool Module	Toggle Env Var	Enabled by Default	Description & Nested Methods
Listmonk Subscribers	`LISTMONK_SUBSCRIBERS_TOOL`	`True`	Manage listmonk subscribers operations. Action-routed methods: `create_subscriber`, `get_subscriber`, `get_subscribers`, `get_subscribers_from_list`.
Listmonk Lists	`LISTMONK_LISTS_TOOL`	`True`	Manage listmonk lists operations. Action-routed methods: `create_list`, `edit_list`, `get_list`, `get_lists`.
Listmonk Imports	`LISTMONK_IMPORTS_TOOL`	`True`	Manage listmonk imports operations. Action-routed methods: `delete_subscriber_import`, `get_subscriber_import_logs`, `get_subscriber_import_status`, `import_subscribers`.
Listmonk Campaigns	`LISTMONK_CAMPAIGNS_TOOL`	`True`	Manage listmonk campaigns operations. Action-routed methods: `create_campaign`, `delete_campaign`, `get_campaign`, `get_campaign_preview`, `get_campaign_stats`, `get_campaigns`, `set_campaign_status`.
Listmonk Media	`LISTMONK_MEDIA_TOOL`	`True`	Manage listmonk media operations. Action-routed methods: `delete_media`, `get_media`, `upload_media`.
Listmonk Templates	`LISTMONK_TEMPLATES_TOOL`	`True`	Manage listmonk templates operations. Action-routed methods: `delete_template`, `get_template`, `get_template_preview`, `get_templates`, `set_default_template`.
Listmonk Tx	`LISTMONK_TX_TOOL`	`True`	Manage listmonk tx operations. Action-routed methods: `transactional_message`.

Detailed tool schemas, parameter shapes, and validation constraints are preserved in docs/mcp.md.

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

stdio Transport (Recommended for local IDEs e.g., Cursor, Claude Desktop)

Configure your IDE's mcp.json to launch the MCP server via uvx:

{
  "mcpServers": {
    "listmonk-api": {
      "command": "uvx",
      "args": [
        "--from",
        "listmonk-api",
        "listmonk-mcp"
      ],
      "env": {
        "LISTMONK_URL": "your_listmonk_url_here",
        "LISTMONK_USERNAME": "your_listmonk_username_here",
        "LISTMONK_PASSWORD": "your_listmonk_password_here"
      }
    }
  }
}

Streamable-HTTP Transport (Recommended for production deployments)

Configure your client's mcp.json to launch the Streamable-HTTP server via uvx with explicit host and port definition:

{
  "mcpServers": {
    "listmonk-api": {
      "command": "uvx",
      "args": [
        "--from",
        "listmonk-api",
        "listmonk-mcp"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "LISTMONK_URL": "your_listmonk_url_here",
        "LISTMONK_USERNAME": "your_listmonk_username_here",
        "LISTMONK_PASSWORD": "your_listmonk_password_here"
      }
    }
  }
}

Alternatively, connect to a pre-deployed remote or local Streamable-HTTP instance:

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

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name listmonk-api-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e PORT=8000 \
  -e LISTMONK_URL="your_listmonk_url_here" \
  -e LISTMONK_USERNAME="your_listmonk_username_here" \
  -e LISTMONK_PASSWORD="your_listmonk_password_here" \
  knucklessg1/listmonk-api:latest

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

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

Install the Python package locally:

# Using uv (highly recommended)
uv pip install listmonk-api[all]

# Using standard pip
python -m pip install listmonk-api[all]

Repository Owners

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

Name		Name	Last commit message	Last commit date
Latest commit History 46 Commits
.github/workflows		.github/workflows
.specify		.specify
docker		docker
docs		docs
listmonk_api		listmonk_api
scripts		scripts
tests		tests
.bumpversion.cfg		.bumpversion.cfg
.dockerignore		.dockerignore
.env.example		.env.example
.gitattributes		.gitattributes
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
AGENTS.md		AGENTS.md
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.md		README.md
mcp_config.json		mcp_config.json
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Listmonk Api

CLI or API | MCP | Agent

Overview

Key Features

CLI or API

MCP

Available MCP Tools

Dynamic Tool Selection & Visibility

MCP Configuration Examples

stdio Transport (Recommended for local IDEs e.g., Cursor, Claude Desktop)

Streamable-HTTP Transport (Recommended for production deployments)

Agent

Running the Agent CLI

Docker Compose Orchestration

Security & Governance

Access Control & Policy Enforcement

Runtime Security Grid

Environment Variables

Installation

Repository Owners

Contribute

About

Uh oh!

Releases 12

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

Listmonk Api

CLI or API | MCP | Agent

Overview

Key Features

CLI or API

MCP

Available MCP Tools

Dynamic Tool Selection & Visibility

MCP Configuration Examples

stdio Transport (Recommended for local IDEs e.g., Cursor, Claude Desktop)

Streamable-HTTP Transport (Recommended for production deployments)

Agent

Running the Agent CLI

Docker Compose Orchestration

Security & Governance

Access Control & Policy Enforcement

Runtime Security Grid

Environment Variables

Installation

Repository Owners

Contribute

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 12

Uh oh!

Contributors

Uh oh!

Languages