Skip to main content

Agent for interacting with Postiz Public API

Project description

Postiz Agent

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: 0.15.0


Overview

Postiz Agent is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with Agent for interacting with Postiz Public API.


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 Agent for interacting with Postiz Public API 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
Integrations INTEGRATIONSTOOL True Manage postiz integrations operations. Action-routed methods: postiz_list_integrations, postiz_get_integration_url, postiz_delete_channel, postiz_check_connection, postiz_find_slot.
Posts POSTSTOOL True Manage postiz posts operations. Action-routed methods: postiz_list_posts, postiz_create_post, postiz_delete_post, postiz_delete_post_by_group, postiz_get_missing_content, postiz_update_release_id.
Uploads UPLOADSTOOL True Manage postiz uploads operations. Action-routed methods: postiz_upload_file, postiz_upload_from_url.
Analytics ANALYTICSTOOL True Manage postiz analytics operations. Action-routed methods: postiz_get_analytics, postiz_get_post_analytics.
Notifications NOTIFICATIONSTOOL True Manage postiz notifications operations. Action-routed methods: postiz_list_notifications.
Video VIDEOTOOL True Manage postiz video operations. Action-routed methods: postiz_generate_video, postiz_video_function.

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

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": {
    "postiz-agent": {
      "command": "uvx",
      "args": [
        "--from",
        "postiz-agent",
        "postiz-mcp"
      ],
      "env": {
        "POSTIZ_SUBDOMAIN": "your_postiz_subdomain_here",
        "POSTIZ_TOKEN": "your_postiz_token_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": {
    "postiz-agent": {
      "command": "uvx",
      "args": [
        "--from",
        "postiz-agent",
        "postiz-mcp"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "POSTIZ_SUBDOMAIN": "your_postiz_subdomain_here",
        "POSTIZ_TOKEN": "your_postiz_token_here"
      }
    }
  }
}

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

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

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name postiz-agent-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e PORT=8000 \
  -e POSTIZ_SUBDOMAIN="your_value" \
  -e POSTIZ_TOKEN="your_value" \
  knucklessg1/postiz-agent: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 POSTIZ_SUBDOMAIN="your_value"
export POSTIZ_TOKEN="your_value"

# Run the agent server
postiz-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:
  postiz-agent-mcp:
    image: knucklessg1/postiz-agent:latest
    container_name: postiz-agent-mcp
    hostname: postiz-agent-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"

  postiz-agent-agent:
    image: knucklessg1/postiz-agent:latest
    container_name: postiz-agent-agent
    hostname: postiz-agent-agent
    restart: always
    depends_on:
      - postiz-agent-mcp
    env_file:
      - ../.env
    command: [ "postiz-agent" ]
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=9004
      - MCP_URL=http://postiz-agent-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

Installation

Install the Python package locally:

# Using uv (highly recommended)
uv pip install postiz-agent[all]

# Using standard pip
python -m pip install postiz-agent[all]

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

postiz_agent-0.15.0.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

postiz_agent-0.15.0-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file postiz_agent-0.15.0.tar.gz.

File metadata

  • Download URL: postiz_agent-0.15.0.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for postiz_agent-0.15.0.tar.gz
Algorithm Hash digest
SHA256 3a05db8884311788e6b85c141835cc9d155675ed9732e52802185f6ceb500cf6
MD5 d112896a974f96e3a7617661f4ccaf64
BLAKE2b-256 f1dd941e255f4c92ec6dc07f477e286a90b15fecaf33f50046698a670e1927da

See more details on using hashes here.

File details

Details for the file postiz_agent-0.15.0-py3-none-any.whl.

File metadata

  • Download URL: postiz_agent-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for postiz_agent-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a290fce0cdca4b1a152e18b36a8f3b695517ec174f5cdae9bc85b28df4da603
MD5 0da5f7bab2bfbe522c7f64f0d2e57a3d
BLAKE2b-256 c2a418b71db2acb4734cdf1e2cf66cda67662448c14939f17e1f68de29c615c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page