Skip to main content
A channel plugin declares — in one place — everything the gateway needs to treat it as first-class: its own config keys, a system-prompt hint, and an optional setup wizard.

​
Quick Start

1

Declare a descriptor

List your channel’s config fields and a prompt hint on a small descriptor class:
from praisonaiagents.bots import ChannelField

class IRCDescriptor:
    config_fields = [
        ChannelField("server", required=True, prompt="IRC server host"),
        ChannelField("nickserv_password", secret=True, env="IRC_NICKSERV_PASSWORD"),
    ]
    system_prompt_hint = (
        "You are replying on IRC: plain text only, one short line."
    )
2

Register the platform

Pass the descriptor when you register the adapter — the gateway wires config, onboarding, and prompt for you:
from praisonai.bots._registry import register_platform

register_platform("irc", IRCBot, descriptor=IRCDescriptor())
Without a descriptor, a plugin channel’s own keys (like IRC’s server) are silently dropped by the fixed ChannelConfigSchema. The descriptor keeps them.

​
How It Works

One declaration feeds three consumers when the channel is active.
ConsumerReadsEffect
Config schemaconfig_fieldsPlugin keys validate instead of being dropped
Onboarding wizardconfig_fields (+ optional setup)Prompts for each field, using env as fallback
Agent promptsystem_prompt_hintInjects the hint whenever the channel is active

​
ChannelField Options

Each ChannelField describes one config key the channel needs.
FieldTypeDefaultDescription
namestr—Config key name (as it appears under channels.<platform>)
requiredboolFalseWhether the field must be provided
secretboolFalseWhether the value is sensitive (masked in prompts/logs)
promptstr""Human-friendly prompt shown by the onboarding wizard
envOptional[str]NoneEnvironment-variable name used as a fallback source

​
Interactive Setup

Add an optional setup(io) hook for multi-step flows that a flat field list can’t express — the wizard calls it when present and merges the returned values. 
from praisonaiagents.bots import ChannelField
from praisonai.bots._registry import register_platform

class IRCDescriptor:
    config_fields = [
        ChannelField("server", required=True, prompt="IRC server host"),
    ]
    system_prompt_hint = "You are replying on IRC: plain text only, one short line."

    def setup(self, io) -> dict:
        channels = io.prompt("Which channels to join? (comma-separated)")
        return {"channels": [c.strip() for c in channels.split(",") if c.strip()]}

register_platform("irc", IRCBot, descriptor=IRCDescriptor())
setup is optional. A descriptor that only needs declarative config_fields omits it entirely.

​
Best Practices

Set secret=True on tokens and passwords so the wizard masks them and logs never print the value.
Add env="IRC_NICKSERV_PASSWORD" so operators can supply credentials via environment variables instead of prompts.
State the platform and its constraints in one line — for example plain text only, one short line — so the agent adapts its replies.
Reach for setup(io) for bespoke, multi-step flows. Declarative config_fields cover the common case with no code.

Messaging Bots

Connect agents to Telegram, Slack, Discord, and more

Bot Platform Capabilities

How platform capabilities drive channel behaviour

Gateway

Multi-agent coordination across channels

Plugins

Ship channels and tools as pip packages