Interface: PluginOptions
Plugin configuration structure resolved during initialization.
Properties
commands?
optional commands: boolean | string[];
Command allow/deny list configuration.
context?
optional context: object;
Surrounding context configuration for understanding ongoing conversations.
| Name | Type | Description |
|---|---|---|
depth? | number | Number of recent messages to fetch for context. Default: 8 |
enabled? | boolean | Enable surrounding channel context when mentioned. Default: true |
engine?
optional engine: BaseEngine;
Custom AI engine instance to override defaults.
hooks?
optional hooks: Partial<Record<HookEvent, Hook>>;
Hooks to run during engine orchestration events.
insight?
optional insight: boolean;
Enables vector store insights synchronisation.
instructions?
optional instructions: string;
System instructions injected into AI prompts.
mcp?
optional mcp: object;
MCP error handling configuration.
| Name | Type | Description |
|---|---|---|
baseDelayMs? | number | Base delay in milliseconds for exponential backoff. Default: 500 |
extraRetries? | number | Number of extra retry attempts before degrading. Default: 1 |
gracefulDegradation? | boolean | Enable graceful degradation by removing MCP tools on persistent failures. Default: true |
maxDelayMs? | number | Maximum delay in milliseconds for exponential backoff. Default: 2000 |
mcpServers?
optional mcpServers: MCPTool[];
MCP (Model Context Protocol) server configurations for tool integration.
restrict?
optional restrict: object;
Channel restriction settings limiting where the bot responds.
| Name | Type |
|---|---|
channelIds | string[] |
usage?
optional usage: PluginUsageOptions;
Token usage tracking configuration.
voice?
optional voice: VoicePluginVoiceOptions;
Voice feature configuration delegated to the voice manager.
whitelist?
optional whitelist: object;
Whitelist of channels where the bot can respond freely.
| Name | Type |
|---|---|
channelIds | string[] |