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

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.7.1.tar.gz (14.6 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.7.1-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stirlingpdf_agent-0.7.1.tar.gz
  • Upload date:
  • Size: 14.6 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.7.1.tar.gz
Algorithm Hash digest
SHA256 2db64e03f26ee3fd9af70a85efd452c38cf80f2d4c3474d07b592e9d4b806c01
MD5 63f08c8486c1183a5a64ebd4024dd4a4
BLAKE2b-256 5248d66dbb752af0ed687a6d14fba579e97f0e915805ce6fc3835e1496696306

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stirlingpdf_agent-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 572e6f7226cdb23b580e889708f2becf085f41951544ea2d2c04c1ecbfad8193
MD5 b466e0df0776618011442143587cc706
BLAKE2b-256 d70a38ed0cd96d31ec6dbfede388809d6724a474459fbff8987a60577a2cbf8f

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