Skip to main content

Agent package for communicating with Stirling PDF via REST APIs.

Project description

Stirling PDF Agent - A2A | AG-UI | MCP

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.11.0

Overview

Stirling PDF Agent MCP Server + A2A Agent

Agent package for communicating with Stirling PDF via REST APIs.

This repository is actively maintained - Contributions are welcome!

MCP

Using as an MCP Server

The MCP Server can be run in two modes: stdio (for local testing) or http (for networked access).

Environment Variables

  • STIRLINGPDF_URL: The URL of the target service.
  • STIRLINGPDF_API_KEY: The API token or access token.

Run in stdio mode (default):

export STIRLINGPDF_URL="http://localhost:8080"
export STIRLINGPDF_API_KEY="your_token"
stirlingpdf-mcp --transport "stdio"

Run in HTTP mode:

export STIRLINGPDF_URL="http://localhost:8080"
export STIRLINGPDF_API_KEY="your_token"
stirlingpdf-mcp --transport "http" --host "0.0.0.0" --port "8000"

A2A Agent

Run A2A Server

export STIRLINGPDF_URL="http://localhost:8080"
export STIRLINGPDF_API_KEY="your_token"
stirlingpdf-agent --provider openai --model-id gpt-4o --api-key sk-...

Docker

Build

docker build -t stirlingpdf-agent .

Run MCP Server

docker run -d \
  --name stirlingpdf-agent \
  -p 8000:8000 \
  -e TRANSPORT=http \
  -e STIRLINGPDF_URL="http://your-service:8080" \
  -e STIRLINGPDF_API_KEY="your_token" \
  knucklessg1/stirlingpdf-agent:latest

Deploy with Docker Compose

services:
  stirlingpdf-agent:
    image: knucklessg1/stirlingpdf-agent:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=http
      - STIRLINGPDF_URL=http://your-service:8080
      - STIRLINGPDF_API_KEY=your_token
    ports:
      - 8000:8000

Configure mcp.json for AI Integration (e.g. Claude Desktop)

{
  "mcpServers": {
    "stirlingpdf": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "stirlingpdf-agent",
        "stirlingpdf-mcp"
      ],
      "env": {
        "STIRLINGPDF_URL": "http://your-service:8080",
        "STIRLINGPDF_API_KEY": "your_token"
      }
    }
  }
}

Install Python Package

python -m pip install stirlingpdf-agent
uv pip install stirlingpdf-agent

Repository Owners

GitHub followers GitHub User's stars

MCP Configuration Examples

1. Standard IO (stdio) Deployment

{
  "mcpServers": {
    "stirlingpdf-agent": {
      "command": "uv",
      "args": [
        "run",
        "stirlingpdf-mcp"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "PDFTOOL": "True",
        "STIRLINGPDF_AGENT_VERIFY": "<YOUR_STIRLINGPDF_AGENT_VERIFY>",
        "STIRLINGPDF_API_KEY": "<YOUR_STIRLINGPDF_API_KEY>",
        "STIRLINGPDF_URL": "<YOUR_STIRLINGPDF_URL>"
      }
    }
  }
}

2. Streamable HTTP (SSE) Deployment

{
  "mcpServers": {
    "stirlingpdf-agent": {
      "command": "uv",
      "args": [
        "run",
        "stirlingpdf-mcp",
        "--transport",
        "http",
        "--host",
        "0.0.0.0",
        "--port",
        "8000"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "PDFTOOL": "True",
        "STIRLINGPDF_AGENT_VERIFY": "<YOUR_STIRLINGPDF_AGENT_VERIFY>",
        "STIRLINGPDF_API_KEY": "<YOUR_STIRLINGPDF_API_KEY>",
        "STIRLINGPDF_URL": "<YOUR_STIRLINGPDF_URL>"
      }
    }
  }
}

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

stirlingpdf_agent-0.11.0.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

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

stirlingpdf_agent-0.11.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file stirlingpdf_agent-0.11.0.tar.gz.

File metadata

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

File hashes

Hashes for stirlingpdf_agent-0.11.0.tar.gz
Algorithm Hash digest
SHA256 a2e5ca971ec87c20dfd9454a04f2e2a41755b7fd750110fdc7546588999055a8
MD5 2b54c01ad2a2cef5bed7b3afce9218a3
BLAKE2b-256 dbd99d8bb2a894463985bf1e0fe43f59ec94fd3b3f295499280a094688957f48

See more details on using hashes here.

File details

Details for the file stirlingpdf_agent-0.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for stirlingpdf_agent-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b2ddc176d31d88adb6c1d2e583ff9644a8ff7ab5ccab0ad5f34f0d0a4b92fd2
MD5 8cc80ed046a4b46971105b09b342017c
BLAKE2b-256 5efa086d89c65fed1ef527addf47cdec8b087d2237dab0f7af744887438100e7

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