Skip to main content

Agent for interacting with Owncast API

Project description

Owncast 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

Owncast Agent MCP Server + A2A Agent

Agent for interacting with Owncast API

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

  • OWNCAST_URL: The URL of the target service.
  • OWNCAST_TOKEN: The API token or access token.

Run in stdio mode (default):

export OWNCAST_URL="http://localhost:8080"
export OWNCAST_TOKEN="your_token"
owncast-mcp --transport "stdio"

Run in HTTP mode:

export OWNCAST_URL="http://localhost:8080"
export OWNCAST_TOKEN="your_token"
owncast-mcp --transport "http" --host "0.0.0.0" --port "8000"

A2A Agent

Run A2A Server

export OWNCAST_URL="http://localhost:8080"
export OWNCAST_TOKEN="your_token"
owncast-agent --provider openai --model-id gpt-4o --api-key sk-...

Docker

Build

docker build -t owncast-agent .

Run MCP Server

docker run -d \
  --name owncast-agent \
  -p 8000:8000 \
  -e TRANSPORT=http \
  -e OWNCAST_URL="http://your-service:8080" \
  -e OWNCAST_TOKEN="your_token" \
  knucklessg1/owncast-agent:latest

Deploy with Docker Compose

services:
  owncast-agent:
    image: knucklessg1/owncast-agent:latest
    environment:
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=http
      - OWNCAST_URL=http://your-service:8080
      - OWNCAST_TOKEN=your_token
    ports:
      - 8000:8000

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

{
  "mcpServers": {
    "owncast": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "owncast-agent",
        "owncast-mcp"
      ],
      "env": {
        "OWNCAST_URL": "http://your-service:8080",
        "OWNCAST_TOKEN": "your_token"
      }
    }
  }
}

Install Python Package

python -m pip install owncast-agent
uv pip install owncast-agent

Repository Owners

GitHub followers GitHub User's stars

MCP Configuration Examples

1. Standard IO (stdio) Deployment

{
  "mcpServers": {
    "owncast-agent": {
      "command": "uv",
      "args": [
        "run",
        "owncast-mcp"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "CHAT_TOOL": "True",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "EXTERNAL_TOOL": "True",
        "INTERNAL_TOOL": "True",
        "OBJECTS_TOOL": "True",
        "OWNCAST_TOKEN": "<YOUR_OWNCAST_TOKEN>",
        "OWNCAST_URL": "<YOUR_OWNCAST_URL>"
      }
    }
  }
}

2. Streamable HTTP (SSE) Deployment

{
  "mcpServers": {
    "owncast-agent": {
      "command": "uv",
      "args": [
        "run",
        "owncast-mcp",
        "--transport",
        "http",
        "--host",
        "0.0.0.0",
        "--port",
        "8000"
      ],
      "env": {
        "AGENT_DESCRIPTION": "<YOUR_AGENT_DESCRIPTION>",
        "AGENT_SYSTEM_PROMPT": "<YOUR_AGENT_SYSTEM_PROMPT>",
        "CHAT_TOOL": "True",
        "DEFAULT_AGENT_NAME": "<YOUR_DEFAULT_AGENT_NAME>",
        "EXTERNAL_TOOL": "True",
        "INTERNAL_TOOL": "True",
        "OBJECTS_TOOL": "True",
        "OWNCAST_TOKEN": "<YOUR_OWNCAST_TOKEN>",
        "OWNCAST_URL": "<YOUR_OWNCAST_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

owncast_agent-0.7.1.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

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

owncast_agent-0.7.1-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for owncast_agent-0.7.1.tar.gz
Algorithm Hash digest
SHA256 08a8ee3109bdb408c7dcec18c13e2ecf09ab22a3dc70e68f8ff5ab1bd4fe31aa
MD5 1961c6ef78c9c2941b56f8ae2f863963
BLAKE2b-256 c725a43c30d602a088efbf0bf35eb8a3a94badbb82a718800cdaa5a216acacab

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for owncast_agent-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1a0568dcfd6e3854e595cfa5f54984a5c177b8bc26fd083e55225d7129693c03
MD5 3fe73213e4f9b03533bdc3037dd1fc45
BLAKE2b-256 8919dc7e21b604b7d3fe21064c3e16d1ebe1e597750611804a4619589b65604e

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