{"id":48648049,"url":"https://github.com/knuckles-team/owncast-agent","last_synced_at":"2026-06-17T09:00:35.533Z","repository":{"id":350391187,"uuid":"1195070922","full_name":"Knuckles-Team/owncast-agent","owner":"Knuckles-Team","description":null,"archived":false,"fork":false,"pushed_at":"2026-06-13T18:21:08.000Z","size":1319,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-13T20:19:34.869Z","etag":null,"topics":["a2a","a2a-server","ag-ui","mcp-server","owncast","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Knuckles-Team.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-29T07:11:19.000Z","updated_at":"2026-06-13T18:19:50.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/Knuckles-Team/owncast-agent","commit_stats":null,"previous_names":["knuckles-team/owncast-agent"],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/Knuckles-Team/owncast-agent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Knuckles-Team%2Fowncast-agent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Knuckles-Team%2Fowncast-agent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Knuckles-Team%2Fowncast-agent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Knuckles-Team%2Fowncast-agent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Knuckles-Team","download_url":"https://codeload.github.com/Knuckles-Team/owncast-agent/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Knuckles-Team%2Fowncast-agent/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34441285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-17T02:00:05.408Z","response_time":127,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a2a","a2a-server","ag-ui","mcp-server","owncast","python"],"created_at":"2026-04-10T08:02:20.088Z","updated_at":"2026-06-17T09:00:35.523Z","avatar_url":"https://github.com/Knuckles-Team.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Owncast Agent\n## CLI or API | MCP | Agent\n\n![PyPI - Version](https://img.shields.io/pypi/v/owncast-agent)\n![MCP Server](https://badge.mcpx.dev?type=server 'MCP Server')\n![PyPI - Downloads](https://img.shields.io/pypi/dd/owncast-agent)\n![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/owncast-agent)\n![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/owncast-agent)\n![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/owncast-agent)\n![PyPI - License](https://img.shields.io/pypi/l/owncast-agent)\n![GitHub](https://img.shields.io/github/license/Knuckles-Team/owncast-agent)\n![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/owncast-agent)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/owncast-agent)\n![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/owncast-agent)\n![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/owncast-agent)\n![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/owncast-agent)\n![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/owncast-agent)\n![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/owncast-agent)\n![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/owncast-agent)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/owncast-agent)\n![PyPI - Implementation](https://img.shields.io/pypi/implementation/owncast-agent)\n\n*Version: 0.33.0*\n\n\u003e **Documentation** — Installation, deployment, usage across the API, CLI, and MCP\n\u003e interfaces, and guidance for provisioning the Owncast platform are maintained in\n\u003e the [official documentation](https://knuckles-team.github.io/owncast-agent/).\n\n---\n\n## Overview\n\n**Owncast Agent** is a production-grade Agent and Model Context Protocol (MCP) server designed to interface directly with Agent for interacting with Owncast API.\n\n---\n\n## Key Features\n\n- **Consolidated Action-Routed MCP Tools:** Minimizes token overhead and eliminates tool bloat in LLM contexts by grouping methods into optimized, togglable tool modules.\n- **Enterprise-Grade Security:** Comprehensive support for Eunomia policies, OIDC token delegation, and granular execution context tracking.\n- **Integrated Graph Agent:** Built-in Pydantic AI agent supporting the Agent Control Protocol (ACP) and standard Web interfaces (AG-UI).\n- **Native Telemetry \u0026 Tracing:** Out-of-the-box OpenTelemetry exports and native Langfuse tracing.\n\n---\n\n## CLI or API\n\nThis agent wraps the Agent for interacting with Owncast API API. You can interact with it programmatically or via its integrated execution entrypoints.\n\nDetailed instructions on how to use the underlying API wrappers, extended schema bindings, and developer SDK references are maintained in [docs/index.md](docs/index.md).\n\n---\n\n## MCP\n\nThis server utilizes dynamic Action-Routed tools to optimize token overhead and maximize IDE compatibility.\n\n### Available MCP Tools\n| Tool Module | Toggle Env Var | Enabled by Default | Description \u0026 Nested Methods |\n|-------------|----------------|--------------------|------------------------------|\n| **Internal** | `INTERNAL_TOOL` | `True` | Manage owncast internal operations. Action-routed methods: `approve_follower`, `auto_update_force_quit`, `auto_update_options`, `auto_update_start`, `ban_ipaddress`, `create_external_apiuser`, `create_webhook`, `delete_custom_emoji`, `delete_external_apiuser`, `delete_prometheus_api`, `delete_webhook`, `disconnect_inbound_connection`, `get_active_viewers`, `get_all_social_platforms`, `get_blocked_and_rejected_followers`, `get_chat_messages`, `get_chat_messages_admin`, `get_connected_chat_clients`, `get_custom_emoji_list`, `get_disabled_users`, `get_external_apiusers`, `get_federated_actions`, `get_followers`, `get_followers_admin`, `get_hardware_stats`, `get_ipaddress_bans`, `get_logs`, `get_moderators`, `get_pending_follow_requests`, `get_prometheus_api`, `get_server_config`, `get_status`, `get_video_playback_metrics`, `get_video_stream_output_variants`, `get_viewers_over_time`, `get_warnings`, `get_web_config`, `get_webhooks`, `get_ypresponse`, `handle_indie_auth_endpoint_get`, `handle_indie_auth_endpoint_post`, `handle_indie_auth_redirect`, `ping`, `post_prometheus_api`, `put_prometheus_api`, `register_anonymous_chat_user`, `register_fediverse_otprequest`, `register_for_live_notifications`, `remote_follow`, `report_playback_metrics`, `reset_favicon`, `reset_ypregistration`, `send_federated_message`, `set_admin_password`, `set_browser_notification_configuration`, `set_chat_disabled`, `set_chat_join_messages_enabled`, `set_chat_require_authentication`, `set_chat_slur_filter_enabled`, `set_chat_spam_protection_enabled`, `set_custom_color_variable_values`, `set_custom_javascript`, `set_custom_styles`, `set_directory_enabled`, `set_disable_search_indexing`, `set_discord_notification_configuration`, `set_enable_established_chat_user_mode`, `set_external_actions`, `set_extra_page_content`, `set_favicon`, `set_federation_activity_private`, `set_federation_block_domains`, `set_federation_enabled`, `set_federation_go_live_message`, `set_federation_show_engagement`, `set_federation_username`, `set_ffmpeg_path`, `set_forbidden_username_list`, `set_hide_viewer_count`, `set_logo`, `set_nsfw`, `set_rtmpserver_port`, `set_s3_configuration`, `set_server_url`, `set_server_welcome_message`, `set_social_handles`, `set_socket_host_override`, `set_stream_keys`, `set_stream_latency_level`, `set_stream_output_variants`, `set_stream_title`, `set_suggested_username_list`, `set_tags`, `set_video_codec`, `set_video_serving_endpoint`, `set_web_server_ip`, `set_web_server_port`, `start_indie_auth_flow`, `status_admin`, `unban_ipaddress`, `update_message_visibility`, `update_message_visibility_admin`, `update_user_enabled`, `update_user_enabled_admin`, `update_user_moderator`, `upload_custom_emoji`, `verify_fediverse_otprequest`. |\n| **Objects** | `OBJECTS_TOOL` | `True` | Manage owncast objects operations. Action-routed methods: `set_custom_offline_message`, `set_server_name`, `set_server_summary`. |\n| **External** | `EXTERNAL_TOOL` | `True` | Manage owncast external operations. Action-routed methods: `external_get_chat_messages`, `external_get_connected_chat_clients`, `external_get_status`, `external_get_user_details`, `external_set_stream_title`, `external_update_message_visibility`, `send_chat_action`, `send_integration_chat_message`, `send_system_message`, `send_system_message_to_connected_client`, `send_user_message`. |\n| **Chat** | `CHAT_TOOL` | `True` | Manage owncast chat operations. Action-routed methods: `get_user_details`. |\n\nDetailed tool schemas, parameter shapes, and validation constraints are preserved in [docs/mcp.md](docs/mcp.md).\n\n### Dynamic Tool Selection \u0026 Visibility\n\nThis 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.\n\nYou can configure tool filtering via multiple input channels:\n\n- **CLI Arguments:** Pass `--tools` or `--toolsets` (or their disabled counterparts `--disabled-tools` and `--disabled-toolsets`) during startup.\n- **Environment Variables:** Define standard environment variables:\n  - `MCP_ENABLED_TOOLS` / `MCP_DISABLED_TOOLS`\n  - `MCP_ENABLED_TAGS` / `MCP_DISABLED_TAGS`\n- **HTTP SSE Request Headers:** Pass custom headers during transport initialization:\n  - `x-mcp-enabled-tools` / `x-mcp-disabled-tools`\n  - `x-mcp-enabled-tags` / `x-mcp-disabled-tags`\n- **HTTP SSE Request Query Parameters:** Append query parameters directly to your transport connection URL:\n  - `?tools=tool1,tool2`\n  - `?tags=tag1`\n\nWhen 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.\n\n---\n\n### MCP Configuration Examples\n\n#### stdio Transport (Recommended for local IDEs e.g., Cursor, Claude Desktop)\nConfigure your IDE's `mcp.json` to launch the MCP server via `uvx`:\n\n```json\n{\n  \"mcpServers\": {\n    \"owncast-agent\": {\n      \"command\": \"uvx\",\n      \"args\": [\n        \"--from\",\n        \"owncast-agent\",\n        \"owncast-mcp\"\n      ],\n      \"env\": {\n        \"OWNCAST_URL\": \"your_owncast_url_here\"\n      }\n    }\n  }\n}\n```\n\n#### Streamable-HTTP Transport (Recommended for production deployments)\nConfigure your client's `mcp.json` to launch the Streamable-HTTP server via `uvx` with explicit host and port definition:\n\n```json\n{\n  \"mcpServers\": {\n    \"owncast-agent\": {\n      \"command\": \"uvx\",\n      \"args\": [\n        \"--from\",\n        \"owncast-agent\",\n        \"owncast-mcp\"\n      ],\n      \"env\": {\n        \"TRANSPORT\": \"streamable-http\",\n        \"HOST\": \"0.0.0.0\",\n        \"PORT\": \"8000\",\n        \"OWNCAST_URL\": \"your_owncast_url_here\"\n      }\n    }\n  }\n}\n```\n\nAlternatively, connect to a pre-deployed remote or local Streamable-HTTP instance:\n\n```json\n{\n  \"mcpServers\": {\n    \"owncast-agent\": {\n      \"url\": \"http://localhost:8000/owncast-agent/mcp\"\n    }\n  }\n}\n```\n\nDeploying the Streamable-HTTP server via Docker:\n\n```bash\ndocker run -d \\\n  --name owncast-agent-mcp \\\n  -p 8000:8000 \\\n  -e TRANSPORT=streamable-http \\\n  -e PORT=8000 \\\n  -e OWNCAST_URL=\"your_value\" \\\n  knucklessg1/owncast-agent:latest\n```\n\n---\n\n\u003c!-- BEGIN GENERATED: additional-deployment-options --\u003e\n### Additional Deployment Options\n\n`owncast-agent` can also run as a **local container** (Docker / Podman / `uv`) or be\nconsumed from a **remote deployment**. The\n[Deployment guide](https://knuckles-team.github.io/owncast-agent/deployment/) has full, copy-paste\n`mcp_config.json` for all four transports — **stdio**, **streamable-http**,\n**local container / uv**, and **remote URL**:\n\n- **Local container / uv** — launch the server from `mcp_config.json` via `uvx`,\n  `docker run`, or `podman run`, or point at a local streamable-http container by `url`.\n- **Remote URL** — connect to a server deployed behind Caddy at\n  `http://owncast-mcp.arpa/mcp` using the `\"url\"` key.\n\u003c!-- END GENERATED: additional-deployment-options --\u003e\n\n## Agent\n\nThis 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.\n\n### Running the Agent CLI\nTo start the interactive command-line agent:\n\n```bash\n# Set credentials\nexport OWNCAST_URL=\"your_value\"\n\n# Run the agent server\nowncast-agent --provider openai --model-id gpt-4o\n```\n\n### Docker Compose Orchestration\nThe following `docker/agent.compose.yml` configures the Agent, Web UI, and Terminal Interface together:\n\n```yaml\nversion: '3.8'\n\nservices:\n  owncast-agent-mcp:\n    image: knucklessg1/owncast-agent:latest\n    container_name: owncast-agent-mcp\n    hostname: owncast-agent-mcp\n    restart: always\n    env_file:\n      - ../.env\n    environment:\n      - PYTHONUNBUFFERED=1\n      - HOST=0.0.0.0\n      - PORT=8000\n      - TRANSPORT=streamable-http\n    ports:\n      - \"8000:8000\"\n    healthcheck:\n      test: [\"CMD\", \"python3\", \"-c\", \"import urllib.request; urllib.request.urlopen('http://localhost:8000/health')\"]\n      interval: 30s\n      timeout: 10s\n      retries: 3\n      start_period: 10s\n    logging:\n      driver: json-file\n      options:\n        max-size: \"10m\"\n        max-file: \"3\"\n\n  owncast-agent-agent:\n    image: knucklessg1/owncast-agent:latest\n    container_name: owncast-agent-agent\n    hostname: owncast-agent-agent\n    restart: always\n    depends_on:\n      - owncast-agent-mcp\n    env_file:\n      - ../.env\n    command: [ \"owncast-agent\" ]\n    environment:\n      - PYTHONUNBUFFERED=1\n      - HOST=0.0.0.0\n      - PORT=9004\n      - MCP_URL=http://owncast-agent-mcp:8000/mcp\n      - PROVIDER=${PROVIDER:-openai}\n      - MODEL_ID=${MODEL_ID:-gpt-4o}\n      - ENABLE_WEB_UI=True\n      - ENABLE_OTEL=True\n    ports:\n      - \"9004:9004\"\n    healthcheck:\n      test: [\"CMD\", \"python3\", \"-c\", \"import urllib.request; urllib.request.urlopen('http://localhost:9004/health')\"]\n      interval: 30s\n      timeout: 10s\n      retries: 3\n      start_period: 10s\n    logging:\n      driver: json-file\n      options:\n        max-size: \"10m\"\n        max-file: \"3\"\n\n```\n\nDetailed graph node architecture explanations, custom skill configurations, and agentic trace guides are available in [docs/agent.md](docs/agent.md).\n\n---\n\n## Security \u0026 Governance\n\nBuilt directly upon the enterprise-ready [`agent-utilities`](https://github.com/Knuckles-Team/agent-utilities) core, standard security parameters are fully supported:\n\n### Access Control \u0026 Policy Enforcement\n- **Eunomia Policies:** Fine-grained, policy-driven tool authorization. Supports `none`, local `embedded` (`mcp_policies.json`), or centralized `remote` modes.\n- **OIDC Token Delegation:** Compliant with RFC 8693 token exchange for flowing authenticating user credentials from Web UI / ACP → Agent → MCP.\n- **Scoped Credentials:** Execution context runs restricted to the specific caller identity.\n\n### Runtime Security Grid\n| Feature | Functionality | Enablement |\n|---------|---------------|------------|\n| **Tool Guard** | Sensitivity inspection with human-in-the-loop validation | Enabled by default |\n| **Prompt Injection Defense** | Input scanning, repetition monitoring, and recursive loop blocks | Enabled by default |\n| **Context Safety Guard** | Stuck-loop detectors and contextual overflow preemptive alerts | Enabled by default |\n\n---\n\n## Environment Variables\n\nThe agent can be fully configured using the following environment variables:\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `OWNCAST_URL` | Base URL of the target Owncast instance. | `http://localhost:8080` |\n| `OWNCAST_TOKEN` | Owncast Admin or Integration API Token for authorized operations. | `\"\"` |\n| `DEFAULT_AGENT_NAME` | The default name displayed for the Graph Agent. | `Owncast Agent` |\n| `AGENT_DESCRIPTION` | Detailed description of the agent shown in UI/terminal contexts. | `\"AI agent for Owncast Agent operations.\"` |\n| `AGENT_SYSTEM_PROMPT` | Custom system prompt instructions overriding workspace defaults. | *Auto-generated* |\n| `INTERNAL_TOOL` / `INTERNALTOOL` | Toggle flag to enable (`True`) or disable (`False`) the Internal tools. | `True` |\n| `OBJECTS_TOOL` / `OBJECTSTOOL` | Toggle flag to enable (`True`) or disable (`False`) the Objects tools. | `True` |\n| `EXTERNAL_TOOL` / `EXTERNALTOOL` | Toggle flag to enable (`True`) or disable (`False`) the External tools. | `True` |\n| `CHAT_TOOL` / `CHATTOOL` | Toggle flag to enable (`True`) or disable (`False`) the Chat tools. | `True` |\n| `TRANSPORT` | The MCP transport protocol to run on (`stdio`, `streamable-http`, `sse`). | `stdio` |\n| `HOST` | The host address to bind the HTTP/SSE server. | `localhost` |\n| `PORT` | The port to bind the HTTP/SSE server. | `8000` |\n| `PROVIDER` | The Pydantic AI LLM provider to use (`openai`, `anthropic`, `ollama`, etc.). | `openai` |\n| `MODEL_ID` | The specific LLM model ID to execute. | `gpt-4o` |\n| `ENABLE_WEB_UI` | Boolean flag to enable or disable the built-in web playground. | `True` |\n| `AUTH_TYPE` | Type of authentication used for tool access controls. | `\"\"` |\n| `EUNOMIA_POLICY_FILE` | Path to the JSON file containing Eunomia tool policies. | `\"\"` |\n| `EUNOMIA_TYPE` | Eunomia policy evaluation type. | `\"\"` |\n| `OTEL_EXPORTER_OTLP_ENDPOINT` | The OTLP endpoint for OpenTelemetry metrics export. | `\"\"` |\n\n---\n\n## Installation\n\nInstall the Python package locally:\n\n```bash\n# Using uv (highly recommended)\nuv pip install owncast-agent[all]\n\n# Using standard pip\npython -m pip install owncast-agent[all]\n```\n\n---\n\n## Documentation\n\nThe complete documentation is published as the\n[official documentation site](https://knuckles-team.github.io/owncast-agent/) and is\nthe recommended reference for installation, deployment, and day-to-day operation.\n\n| Page | Contents |\n|---|---|\n| [Installation](https://knuckles-team.github.io/owncast-agent/installation/) | pip, source, extras, prebuilt Docker image |\n| [Deployment](https://knuckles-team.github.io/owncast-agent/deployment/) | run the MCP and agent servers, Compose, Caddy + Technitium, env config |\n| [Usage](https://knuckles-team.github.io/owncast-agent/usage/) | the MCP tools, the `OwncastApi` client, the CLI |\n| [Backing Platform](https://knuckles-team.github.io/owncast-agent/platform/) | deploy Owncast with Docker |\n| [Overview](https://knuckles-team.github.io/owncast-agent/overview/) | architecture, ecosystem role, concept index |\n| [Concepts](https://knuckles-team.github.io/owncast-agent/concepts/) | concept registry (`CONCEPT:OC-*`) |\n\n`AGENTS.md` is the canonical contributor/agent guidance.\n\n---\n\n## Repository Owners\n\n\u003cimg width=\"100%\" height=\"180em\" src=\"https://github-readme-stats.vercel.app/api?username=Knucklessg1\u0026show_icons=true\u0026hide_border=true\u0026\u0026count_private=true\u0026include_all_commits=true\" /\u003e\n\n![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)\n![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)\n\n---\n\n## Contribute\n\nContributions are welcome! Please ensure code quality by executing local checks before submitting pull requests:\n- Format code using `ruff format .`\n- Lint code using `ruff check .`\n- Validate type-safety with `mypy .`\n- Execute test suites using `pytest`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknuckles-team%2Fowncast-agent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknuckles-team%2Fowncast-agent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknuckles-team%2Fowncast-agent/lists"}