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.10.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.10.0.tar.gz (15.7 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.10.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stirlingpdf_agent-0.10.0.tar.gz
  • Upload date:
  • Size: 15.7 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.10.0.tar.gz
Algorithm Hash digest
SHA256 09f97e3979aa3e411912aa7811591d101be29ae2f95142743d10e63e022b72c2
MD5 c230227b579d45d8e2671e2d5f955e5c
BLAKE2b-256 40b454ca79e32caabb07a06dfb3307e0a3a25520cce8674a86b5c56a34da0549

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stirlingpdf_agent-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9ccc5ab1e84ec5d8d1290d55ce43c07aa2ad3266e769c0525fdec22db0ed6589
MD5 299270fb16f14c1bb746fb66592d1139
BLAKE2b-256 6d45c3d429fd1b757dc3ca3bcc63488006972918dbab4c3f08207c2b379a240a

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