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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: owncast_agent-0.10.0.tar.gz
  • Upload date:
  • Size: 22.6 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.10.0.tar.gz
Algorithm Hash digest
SHA256 d4d4006a2673a6b27ac39469d37d63ca3409506dad3b001be6830511690fa53c
MD5 d168b85f3cb452b77174cf5c73331716
BLAKE2b-256 97c0aed3e642be3c3c6fd03e65900c86c18cf059260b965ebc991ab833b23664

See more details on using hashes here.

File details

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

File metadata

  • Download URL: owncast_agent-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 24.3 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd0821c7a7245024dd6fa2bd5b4404410d1e3a1bc57e4ffa77355d463007a101
MD5 06fa001b99f2fcdcae66cd372a6a9d71
BLAKE2b-256 6d4ade6674941dae19f05dbd24312d6390f37e2983051df22c9a59c7626a0713

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