owncast-agent 1.0.1

Agent for interacting with Owncast API

Owncast Agent

CLI or API | MCP | Agent

Version: 1.0.1

Documentation — Installation, deployment, usage across the API, CLI, and MCP interfaces, and guidance for provisioning the Owncast platform are maintained in the official documentation.

---

Overview

Owncast Agent is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with Agent for interacting with Owncast API.

---

Key Features

• Consolidated Action-Routed MCP Tools: Minimizes token overhead and eliminates tool bloat in LLM contexts by grouping methods into optimized, togglable tool modules.
• Enterprise-Grade Security: Comprehensive support for Eunomia policies, OIDC token delegation, and granular execution context tracking.
• Integrated Graph Agent: Built-in Pydantic AI agent supporting the Agent Control Protocol (ACP) and standard Web interfaces (AG-UI).
• Native Telemetry & Tracing: Out-of-the-box OpenTelemetry exports and native Langfuse tracing.

---

CLI or API

This agent wraps the Agent for interacting with Owncast API API. You can interact with it programmatically or via its integrated execution entrypoints.

Detailed instructions on how to use the underlying API wrappers, extended schema bindings, and developer SDK references are maintained in docs/index.md.

---

MCP

This server utilizes dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.

Available MCP Tools

This table is auto-generated from the live server — do not edit by hand.

Condensed action-routed tools (default — MCP_TOOL_MODE=condensed)

MCP Tool	Toggle Env Var	Description
owncast_chat	CHATTOOL	Manage owncast chat operations.
owncast_external	EXTERNALTOOL	Manage owncast external operations.
owncast_internal	INTERNALTOOL	Manage owncast internal operations.
owncast_objects	OBJECTSTOOL	Manage owncast objects operations.

Verbose 1:1 API-mapped tools (MCP_TOOL_MODE=verbose or both)

122 per-operation tools — one per public API method (click to expand)

MCP Tool	Toggle Env Var	Description
owncast_approve_follower	OWNCAST_APITOOL	Set the following state of a follower or follow request
owncast_auto_update_force_quit	OWNCAST_APITOOL	Force quit the server and restart it
owncast_auto_update_options	OWNCAST_APITOOL	Return the auto-update features that are supported for this instance
owncast_auto_update_start	OWNCAST_APITOOL	Begin the auto-update
owncast_ban_ipaddress	OWNCAST_APITOOL	Ban an IP address
owncast_create_external_apiuser	OWNCAST_APITOOL	Create a single access token
owncast_create_webhook	OWNCAST_APITOOL	Create a single webhook
owncast_delete_custom_emoji	OWNCAST_APITOOL	Delete custom emoji
owncast_delete_external_apiuser	OWNCAST_APITOOL	Delete a single external API user
owncast_delete_prometheus_api	OWNCAST_APITOOL	Endpoint to interface with Prometheus
owncast_delete_webhook	OWNCAST_APITOOL	Delete a single webhook
owncast_disconnect_inbound_connection	OWNCAST_APITOOL	Disconnect inbound stream
owncast_external_get_chat_messages	OWNCAST_APITOOL	Get chat history
owncast_external_get_connected_chat_clients	OWNCAST_APITOOL	Connected clients
owncast_external_get_status	OWNCAST_APITOOL	Get the server's status
owncast_external_get_user_details	OWNCAST_APITOOL	Get a user's details
owncast_external_set_stream_title	OWNCAST_APITOOL	Stream title
owncast_external_update_message_visibility	OWNCAST_APITOOL	Hide chat message
owncast_get_active_viewers	OWNCAST_APITOOL	Get active viewers
owncast_get_all_social_platforms	OWNCAST_APITOOL	Get all social platforms
owncast_get_blocked_and_rejected_followers	OWNCAST_APITOOL	Get a list of rejected or blocked follows
owncast_get_chat_messages	OWNCAST_APITOOL	Gets a list of chat messages
owncast_get_chat_messages_admin	OWNCAST_APITOOL	Get all chat messages for the admin, unfiltered
owncast_get_connected_chat_clients	OWNCAST_APITOOL	Get a detailed list of currently connected chat clients
owncast_get_custom_emoji_list	OWNCAST_APITOOL	Get list of custom emojis supported in the chat
owncast_get_disabled_users	OWNCAST_APITOOL	Get a list of disabled users
owncast_get_external_apiusers	OWNCAST_APITOOL	Get all access tokens
owncast_get_federated_actions	OWNCAST_APITOOL	Get a paginated list of federated activities
owncast_get_followers	OWNCAST_APITOOL	Gets the list of followers
owncast_get_followers_admin	OWNCAST_APITOOL	Get followers
owncast_get_hardware_stats	OWNCAST_APITOOL	Get the current hardware stats
owncast_get_ipaddress_bans	OWNCAST_APITOOL	Get all banned IP addresses
owncast_get_logs	OWNCAST_APITOOL	Get all logs
owncast_get_moderators	OWNCAST_APITOOL	Get a list of moderator users
owncast_get_pending_follow_requests	OWNCAST_APITOOL	Get a list of pending follow requests
owncast_get_prometheus_api	OWNCAST_APITOOL	Endpoint to interface with Prometheus
owncast_get_server_config	OWNCAST_APITOOL	Get the current server config
owncast_get_status	OWNCAST_APITOOL	Get the status of the server
owncast_get_user_details	OWNCAST_APITOOL	Get a user's details
owncast_get_video_playback_metrics	OWNCAST_APITOOL	Get video playback metrics
owncast_get_video_stream_output_variants	OWNCAST_APITOOL	Get a list of video variants available
owncast_get_viewers_over_time	OWNCAST_APITOOL	Get viewer count over time
owncast_get_warnings	OWNCAST_APITOOL	Get warning/error logs
owncast_get_web_config	OWNCAST_APITOOL	Get the web config
owncast_get_webhooks	OWNCAST_APITOOL	Get all the webhooks
owncast_get_ypresponse	OWNCAST_APITOOL	Get the YP protocol data
owncast_handle_indie_auth_endpoint_get	OWNCAST_APITOOL	Handles the IndieAuth auth endpoint
owncast_handle_indie_auth_endpoint_post	OWNCAST_APITOOL	Handles IndieAuth from form submission
owncast_handle_indie_auth_redirect	OWNCAST_APITOOL	Handle the redirect from an IndieAuth server to continue the auth flow
owncast_ping	OWNCAST_APITOOL	Tell the backend you're an active viewer
owncast_post_prometheus_api	OWNCAST_APITOOL	Endpoint to interface with Prometheus
owncast_put_prometheus_api	OWNCAST_APITOOL	Endpoint to interface with Prometheus
owncast_register_anonymous_chat_user	OWNCAST_APITOOL	Registers an anonymous chat user
owncast_register_fediverse_otprequest	OWNCAST_APITOOL	Register a Fediverse OTP request
owncast_register_for_live_notifications	OWNCAST_APITOOL	Register for notifications
owncast_remote_follow	OWNCAST_APITOOL	Request remote follow
owncast_report_playback_metrics	OWNCAST_APITOOL	Save video playback metrics for future video health recording
owncast_reset_favicon	OWNCAST_APITOOL	Reset favicon to default
owncast_reset_ypregistration	OWNCAST_APITOOL	Reset YP configuration
owncast_send_chat_action	OWNCAST_APITOOL	Send a user action to chat
owncast_send_federated_message	OWNCAST_APITOOL	Send a public message to the Fediverse from the server's user
owncast_send_integration_chat_message	OWNCAST_APITOOL	Send a message to chat as a specific 3rd party bot/integration based on its access token
owncast_send_system_message	OWNCAST_APITOOL	Send a system message to the chat
owncast_send_system_message_to_connected_client	OWNCAST_APITOOL	Send a system message to a single client
owncast_send_user_message	OWNCAST_APITOOL	Send a user message to chat
owncast_set_admin_password	OWNCAST_APITOOL	Change the current admin password
owncast_set_browser_notification_configuration	OWNCAST_APITOOL	Configure Browser notifications
owncast_set_chat_disabled	OWNCAST_APITOOL	Disable chat
owncast_set_chat_join_messages_enabled	OWNCAST_APITOOL	Enable chat for user join messages
owncast_set_chat_require_authentication	OWNCAST_APITOOL	Set require authentication for chat
owncast_set_chat_slur_filter_enabled	OWNCAST_APITOOL	Set slur filter enabled
owncast_set_chat_spam_protection_enabled	OWNCAST_APITOOL	Set spam protection enabled
owncast_set_custom_color_variable_values	OWNCAST_APITOOL	Set style/color/css values
owncast_set_custom_javascript	OWNCAST_APITOOL	Update custom JavaScript
owncast_set_custom_offline_message	OWNCAST_APITOOL	Change the offline message
owncast_set_custom_styles	OWNCAST_APITOOL	Update custom styles
owncast_set_directory_enabled	OWNCAST_APITOOL	Update directory enabled
owncast_set_disable_search_indexing	OWNCAST_APITOOL	Update search indexing
owncast_set_discord_notification_configuration	OWNCAST_APITOOL	Configure Discord notifications
owncast_set_enable_established_chat_user_mode	OWNCAST_APITOOL	Enable/disable chat established user mode
owncast_set_external_actions	OWNCAST_APITOOL	Update external action links
owncast_set_extra_page_content	OWNCAST_APITOOL	Change the extra page content in memory
owncast_set_favicon	OWNCAST_APITOOL	Upload custom favicon
owncast_set_federation_activity_private	OWNCAST_APITOOL	Set if federation activities are private
owncast_set_federation_block_domains	OWNCAST_APITOOL	Set Federation blocked domains
owncast_set_federation_enabled	OWNCAST_APITOOL	Enable/disable federation features
owncast_set_federation_go_live_message	OWNCAST_APITOOL	Set federated go live message
owncast_set_federation_show_engagement	OWNCAST_APITOOL	Set if fediverse engagement appears in chat
owncast_set_federation_username	OWNCAST_APITOOL	Set local federated username
owncast_set_ffmpeg_path	OWNCAST_APITOOL	Update FFMPEG path
owncast_set_forbidden_username_list	OWNCAST_APITOOL	Set chat usernames that are not allowed
owncast_set_hide_viewer_count	OWNCAST_APITOOL	Update hide viewer count
owncast_set_logo	OWNCAST_APITOOL	Update logo
owncast_set_nsfw	OWNCAST_APITOOL	Update NSFW marking
owncast_set_rtmpserver_port	OWNCAST_APITOOL	Update RTMP post
owncast_set_s3_configuration	OWNCAST_APITOOL	Update S3 configuration
owncast_set_server_name	OWNCAST_APITOOL	Change the server name
owncast_set_server_summary	OWNCAST_APITOOL	Change the server summary
owncast_set_server_url	OWNCAST_APITOOL	Update server url
owncast_set_server_welcome_message	OWNCAST_APITOOL	Change the welcome message
owncast_set_social_handles	OWNCAST_APITOOL	Update social handles
owncast_set_socket_host_override	OWNCAST_APITOOL	Update websocket host override
owncast_set_stream_keys	OWNCAST_APITOOL	Set an array of valid stream keys
owncast_set_stream_latency_level	OWNCAST_APITOOL	Set the number of video segments and duration per segment in a playlist
owncast_set_stream_output_variants	OWNCAST_APITOOL	Set an array of video output configurations
owncast_set_stream_title	OWNCAST_APITOOL	Change the stream title
owncast_set_suggested_username_list	OWNCAST_APITOOL	Set the suggested chat usernames that will be assigned automatically
owncast_set_tags	OWNCAST_APITOOL	Update server tags
owncast_set_video_codec	OWNCAST_APITOOL	Set video codec
owncast_set_video_serving_endpoint	OWNCAST_APITOOL	Update custom video serving endpoint
owncast_set_web_server_ip	OWNCAST_APITOOL	Update server IP address
owncast_set_web_server_port	OWNCAST_APITOOL	Update server port
owncast_start_indie_auth_flow	OWNCAST_APITOOL	Begins auth flow
owncast_status_admin	OWNCAST_APITOOL	Get current inboard broadcaster
owncast_unban_ipaddress	OWNCAST_APITOOL	Remove an IP ban
owncast_update_message_visibility	OWNCAST_APITOOL	Update chat message visibility
owncast_update_message_visibility_admin	OWNCAST_APITOOL	Update visibility of chat messages
owncast_update_user_enabled	OWNCAST_APITOOL	Enable/disable a user
owncast_update_user_enabled_admin	OWNCAST_APITOOL	Enable or disable a user
owncast_update_user_moderator	OWNCAST_APITOOL	Set moderator status for a user
owncast_upload_custom_emoji	OWNCAST_APITOOL	Upload custom emoji
owncast_verify_fediverse_otprequest	OWNCAST_APITOOL	Verify Fediverse OTP code

4 action-routed tool(s) (default) · 122 verbose 1:1 tool(s). Each is enabled unless its <DOMAIN>TOOL toggle is set false; MCP_TOOL_MODE selects the surface (condensed default · verbose 1:1 · both). Auto-generated — do not edit.

Detailed tool schemas, parameter shapes, and validation constraints are preserved in docs/mcp.md.

Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows you to restrict the set of exposed tools in order to prevent blowing up the LLM's context window.

You can configure tool filtering via multiple input channels:

• CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.
• Environment Variables: Define standard environment variables:
  • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS
  • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS
• HTTP SSE Request Headers: Pass custom headers during transport initialization:
  • x-mcp-enabled-tools / x-mcp-disabled-tools
  • x-mcp-enabled-tags / x-mcp-disabled-tags
• HTTP SSE Request Query Parameters: Append query parameters directly to your transport connection URL:
  • ?tools=tool1,tool2
  • ?tags=tag1

When query strings or parameters are supplied, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.

---

MCP Configuration Examples

Install the slim [mcp] extra. All examples install owncast-agent[mcp] — the MCP-server extra that pulls only the FastMCP / FastAPI tooling (agent-utilities[mcp]). It deliberately excludes the heavy agent runtime (pydantic-ai, the epistemic-graph engine, dspy, llama-index), so uvx / container installs are far smaller. Use the full [agent] extra only when you need the integrated Pydantic AI agent.

stdio Transport (local IDEs — Cursor, Claude Desktop, VS Code)

{
  "mcpServers": {
    "owncast-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "owncast-agent[mcp]",
        "owncast-mcp"
      ],
      "env": {
        "MCP_TOOL_MODE": "condensed",
        "CHATTOOL": "True",
        "EXTERNALTOOL": "True",
        "INTERNALTOOL": "True",
        "OBJECTSTOOL": "True",
        "OWNCAST_TOKEN": "your_owncast_admin_or_integration_token_here",
        "OWNCAST_URL": "http://localhost:9000"
      }
    }
  }
}

Streamable-HTTP Transport (networked / production)

{
  "mcpServers": {
    "owncast-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "owncast-agent[mcp]",
        "owncast-mcp",
        "--transport",
        "streamable-http",
        "--port",
        "8000"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "MCP_TOOL_MODE": "condensed",
        "CHATTOOL": "True",
        "EXTERNALTOOL": "True",
        "INTERNALTOOL": "True",
        "OBJECTSTOOL": "True",
        "OWNCAST_TOKEN": "your_owncast_admin_or_integration_token_here",
        "OWNCAST_URL": "http://localhost:9000"
      }
    }
  }
}

Alternatively, connect to a pre-deployed Streamable-HTTP instance by url:

{
  "mcpServers": {
    "owncast-mcp": {
      "url": "http://localhost:8000/owncast-mcp/mcp"
    }
  }
}

Deploying the Streamable-HTTP server via Docker:

docker run -d \
  --name owncast-mcp-mcp \
  -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e HOST=0.0.0.0 \
  -e PORT=8000 \
  -e MCP_TOOL_MODE=condensed \
  -e CHATTOOL=True \
  -e EXTERNALTOOL=True \
  -e INTERNALTOOL=True \
  -e OBJECTSTOOL=True \
  -e OWNCAST_TOKEN=your_owncast_admin_or_integration_token_here \
  -e OWNCAST_URL=http://localhost:9000 \
  knucklessg1/owncast-agent:mcp

Auto-generated from the code-read env surface (MCP_TOOL_MODE + package vars) — do not edit.

Additional Deployment Options

owncast-agent can also run as a local container (Docker / Podman / uv) or be consumed from a remote deployment. The Deployment guide has full, copy-paste mcp_config.json for all four transports — stdio, streamable-http, local container / uv, and remote URL:

• Local container / uv — launch the server from mcp_config.json via uvx, docker run, or podman run, or point at a local streamable-http container by url.
• Remote URL — connect to a server deployed behind Caddy at http://owncast-mcp.arpa/mcp using the "url" key.

Agent

This repository features a fully integrated Pydantic AI Graph Agent. It communicates over the Agent Control Protocol (ACP) and interacts seamlessly with the Agent Web UI (AG-UI) and Terminal interface.

Running the Agent CLI

To start the interactive command-line agent:

# Set credentials
export OWNCAST_URL="your_value"

# Run the agent server
owncast-agent --provider openai --model-id gpt-4o

Docker Compose Orchestration

The following docker/agent.compose.yml configures the Agent, Web UI, and Terminal Interface together:

version: '3.8'

services:
  owncast-agent-mcp:
    image: knucklessg1/owncast-agent:latest
    container_name: owncast-agent-mcp
    hostname: owncast-agent-mcp
    restart: always
    env_file:
      - ../.env
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=streamable-http
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

  owncast-agent-agent:
    image: knucklessg1/owncast-agent:latest
    container_name: owncast-agent-agent
    hostname: owncast-agent-agent
    restart: always
    depends_on:
      - owncast-agent-mcp
    env_file:
      - ../.env
    command: [ "owncast-agent" ]
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=9004
      - MCP_URL=http://owncast-agent-mcp:8000/mcp
      - PROVIDER=${PROVIDER:-openai}
      - MODEL_ID=${MODEL_ID:-gpt-4o}
      - ENABLE_WEB_UI=True
      - ENABLE_OTEL=True
    ports:
      - "9004:9004"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:9004/health')"]
      interval: 30s
      timeout: 10s
      retries: 3
      start_period: 10s
    logging:
      driver: json-file
      options:
        max-size: "10m"
        max-file: "3"

Detailed graph node architecture explanations, custom skill configurations, and agentic trace guides are available in docs/agent.md.

---

Security & Governance

Built directly upon the enterprise-ready agent-utilities core, standard security parameters are fully supported:

Access Control & Policy Enforcement

• Eunomia Policies: Fine-grained, policy-driven tool authorization. Supports none, local embedded (mcp_policies.json), or centralized remote modes.
• OIDC Token Delegation: Compliant with RFC 8693 token exchange for flowing authenticating user credentials from Web UI / ACP → Agent → MCP.
• Scoped Credentials: Execution context runs restricted to the specific caller identity.

Runtime Security Grid

Feature	Functionality	Enablement
Tool Guard	Sensitivity inspection with human-in-the-loop validation	Enabled by default
Prompt Injection Defense	Input scanning, repetition monitoring, and recursive loop blocks	Enabled by default
Context Safety Guard	Stuck-loop detectors and contextual overflow preemptive alerts	Enabled by default

---

Environment Variables

Package environment variables

Variable	Example	Description
HOST	0.0.0.0
PORT	8000
TRANSPORT	stdio	options: stdio, streamable-http, sse
ENABLE_OTEL	True
OTEL_EXPORTER_OTLP_ENDPOINT	http://localhost:8080/api/public/otel
OTEL_EXPORTER_OTLP_PUBLIC_KEY	pk-...
OTEL_EXPORTER_OTLP_SECRET_KEY	sk-...
OTEL_EXPORTER_OTLP_PROTOCOL	http/protobuf
EUNOMIA_TYPE	none	options: none, embedded, remote
EUNOMIA_POLICY_FILE	mcp_policies.json
EUNOMIA_REMOTE_URL	http://eunomia-server:8000
OWNCAST_URL	http://localhost:9000
OWNCAST_TOKEN	your_owncast_admin_or_integration_token_here
DEFAULT_AGENT_NAME	Owncast Agent
INTERNALTOOL	True
OBJECTSTOOL	True
EXTERNALTOOL	True
CHATTOOL	True

Inherited agent-utilities variables (apply to every connector)

Variable	Example	Description
MCP_TOOL_MODE	condensed	Tool surface: condensed
MCP_ENABLED_TOOLS	—	Comma-separated tool allow-list
MCP_DISABLED_TOOLS	—	Comma-separated tool deny-list
MCP_ENABLED_TAGS	—	Comma-separated tag allow-list
MCP_DISABLED_TAGS	—	Comma-separated tag deny-list
MCP_CLIENT_AUTH	—	Outbound MCP auth (oidc-client-credentials for fleet calls)
OIDC_CLIENT_ID	—	OIDC client id (service-account auth)
OIDC_CLIENT_SECRET	—	OIDC client secret (service-account auth)
DEBUG	False	Verbose logging
PYTHONUNBUFFERED	1	Unbuffered stdout (recommended in containers)
MCP_URL	http://localhost:8000/mcp	URL of the MCP server the agent connects to
PROVIDER	openai	LLM provider for the agent
MODEL_ID	gpt-4o	Model id for the agent
ENABLE_WEB_UI	True	Serve the AG-UI web interface

18 package + 14 inherited variable(s). Auto-generated from .env.example + the shared agent-utilities set — do not edit.

Every variable the server reads, grouped by purpose.

Connection & Credentials

Variable	Description	Default
OWNCAST_URL	Base URL of the target Owncast instance.	http://localhost:9000
OWNCAST_TOKEN	Owncast Admin or Integration API token for authorized operations.	—

MCP server / transport

Variable	Description	Default
TRANSPORT	stdio, streamable-http, or sse.	stdio
HOST	Bind host (HTTP transports).	0.0.0.0
PORT	Bind port (HTTP transports).	8000
MCP_TOOL_MODE	Tool surface: condensed, verbose, or both.	condensed
MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS	Comma-separated tool allow/deny list.	—
MCP_ENABLED_TAGS / MCP_DISABLED_TAGS	Comma-separated tag allow/deny list.	—
PYTHONUNBUFFERED	Unbuffered stdout (recommended in containers).	1

Tool toggles

Each action-routed tool can be disabled individually by setting its toggle env var to false. The names match the authoritative "Toggle Env Var" column in the Available MCP Tools table above.

Variable	Tool	Default
INTERNALTOOL	owncast_internal	True
OBJECTSTOOL	owncast_objects	True
EXTERNALTOOL	owncast_external	True
CHATTOOL	owncast_chat	True

Telemetry & governance

Variable	Description	Default
ENABLE_OTEL	Enable OpenTelemetry export.	True
OTEL_EXPORTER_OTLP_ENDPOINT	OTLP collector endpoint.	—
OTEL_EXPORTER_OTLP_PUBLIC_KEY / OTEL_EXPORTER_OTLP_SECRET_KEY	OTLP auth keys.	—
OTEL_EXPORTER_OTLP_PROTOCOL	OTLP protocol (e.g. http/protobuf).	—
EUNOMIA_TYPE	Authorization mode: none, embedded, remote.	none
EUNOMIA_POLICY_FILE	Embedded policy file.	mcp_policies.json
EUNOMIA_REMOTE_URL	Remote Eunomia server URL.	—

Agent CLI (full [agent] runtime only)

Variable	Description	Default
MCP_URL	URL of the MCP server the agent connects to.	http://localhost:8000/mcp
PROVIDER	LLM provider (e.g. openai).	openai
MODEL_ID	Model id (e.g. gpt-4o).	gpt-4o
ENABLE_WEB_UI	Serve the AG-UI web interface.	True
DEFAULT_AGENT_NAME	Display name for the Graph Agent.	Owncast Agent

See .env.example for a copy-paste starting point.

---

Installation

Pick the extra that matches what you want to run:

Extra	Installs	Use when
owncast-agent[mcp]	Slim MCP server only (agent-utilities[mcp] — FastMCP/FastAPI)	You only run the MCP server (smallest install / image)
owncast-agent[agent]	Full agent runtime (agent-utilities[agent,logfire] — Pydantic AI + the epistemic-graph engine)	You run the integrated agent
owncast-agent[all]	Everything (mcp + agent + logfire)	Development / both surfaces

# MCP server only (recommended for tool hosting — slim deps)
uv pip install "owncast-agent[mcp]"

# Full agent runtime (Pydantic AI + epistemic-graph engine)
uv pip install "owncast-agent[agent]"

# Everything (development)
uv pip install "owncast-agent[all]"      # or: python -m pip install "owncast-agent[all]"

Container images (:mcp vs :agent)

One multi-stage docker/Dockerfile builds two right-sized images, selected by --target:

Image tag	Build target	Contents	Entrypoint
knucklessg1/owncast-agent:mcp	--target mcp	owncast-agent[mcp] — slim, no engine/pydantic-ai/dspy/llama-index/tree-sitter	owncast-mcp
knucklessg1/owncast-agent:latest	--target agent (default)	owncast-agent[agent] — full agent runtime + epistemic-graph engine	owncast-agent

docker build --target mcp   -t knucklessg1/owncast-agent:mcp    docker/   # slim MCP server
docker build --target agent -t knucklessg1/owncast-agent:latest docker/   # full agent

docker/mcp.compose.yml runs the slim :mcp server; docker/agent.compose.yml runs the agent (:latest) with a co-located :mcp sidecar.

Knowledge-graph database (epistemic-graph)

The full agent ([agent] / :latest) embeds the epistemic-graph engine (pulled in transitively via agent-utilities[agent]). For production — or to share one knowledge graph across multiple agents — run epistemic-graph as its own database container and point the agent at it instead of embedding it. Deployment recipes (single-node + Raft HA), connection config, and the full database architecture (with diagrams) are documented in the epistemic-graph deployment guide. The slim [mcp] server does not require the database.

---

Documentation

The complete documentation is published as the official documentation site and is the recommended reference for installation, deployment, and day-to-day operation.

Page	Contents
Installation	pip, source, extras, prebuilt Docker image
Deployment	run the MCP and agent servers, Compose, Caddy + Technitium, env config
Usage	the MCP tools, the OwncastApi client, the CLI
Backing Platform	deploy Owncast with Docker
Overview	architecture, ecosystem role, concept index
Concepts	concept registry (CONCEPT:OC-*)

AGENTS.md is the canonical contributor/agent guidance.

---

Repository Owners

---

Contribute

Contributions are welcome! Please ensure code quality by executing local checks before submitting pull requests:

• Format code using ruff format .
• Lint code using ruff check .
• Validate type-safety with mypy .
• Execute test suites using pytest

Deploy with agent-os-genesis

This package can be provisioned for you — skill-guided — by the agent-os-genesis universal skill (its single-package deploy mode): it picks your install method, seeds secrets to OpenBao/Vault (or .env), trusts your enterprise CA, registers the MCP server, and verifies it — the same machinery that stands up the whole Agent OS, narrowed to just this package. Ask your agent to "deploy owncast-agent with agent-os-genesis".

Install mode	Command
Bare-metal, prod (PyPI)	uvx owncast-mcp · or uv tool install owncast-agent
Bare-metal, dev (editable)	uv pip install -e ".[all]" · or pip install -e ".[all]"
Container, prod	deploy knucklessg1/owncast-agent:latest via docker-compose / swarm / podman / podman-compose / kubernetes
Container, dev (editable)	deploy docker/compose.dev.yml (source-mounted at /src; edits live on restart)

Secrets are read-existing + seeded via vault_sync — you are only prompted for what's missing.