Skip to content

Generated configuration field reference

Generated from runtime source and JSON Schema. Do not edit manually. See Configuration for narrative guidance and examples.

  • Generator: pnpm docs:config
  • Drift check: pnpm check:config-reference

Host top-level fields

The authoritative contract is packages/im/runtime/src/host-config-schema.json, consumed by the Runtime at basic/cli/src/plugin-runtime/console-api-installer.ts.

PathTypeDescriptionSource
httpobjectHTTP, Console, REST/RPC/SSE, and Webhook Host.source
databaseobjectDatabase Host and dialect connection options.source
aiobjectProviders, Agents, sessions, memory, tools, and execution security.source
mcpobjectExpose Bot tools through an MCP Server.source
a2aobjectA2A Agent Card, remote execution, and Workroom callbacks.source
speechobjectSpeech-to-text and text-to-speech Host.source
htmlRendererobjectHTML and image rendering options.source
assistantobjectScheduled jobs, event ingress, and failure notifications.source
log_levelstring | numberRuntime log level.source
pluginobjectRoot Plugin configuration; replaced by its project schema during composition.source

Plugin instance fields

These fields are read directly from each plugin schema.json. The <name> in plugins.<name> is the default instanceKey.

dingtalk

plugins/adapters/dingtalk/schema.json

PathTypeRequiredDefaultDescription
plugins.dingtalk.apiBaseUrlstringno"https://oapi.dingtalk.com"
plugins.dingtalk.masterstring | numberno框架 master(DingTalk userid;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.dingtalk.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.dingtalk.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.dingtalk.endpoints[].masterstring | numberno本 endpoint 的框架 master(DingTalk userid);覆盖顶层 master
plugins.dingtalk.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.dingtalk.endpoints[].appKeystringyesDingtalk app key
plugins.dingtalk.endpoints[].appSecretstringyesDingtalk app secret
plugins.dingtalk.endpoints[].webhookPathstringyesDingtalk webhook path
plugins.dingtalk.endpoints[].robotCodestringyesDingtalk robot code
plugins.dingtalk.endpoints[].idstringyesDingtalk bot name
plugins.dingtalk.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

discord

plugins/adapters/discord/schema.json

PathTypeRequiredDefaultDescription
plugins.discord.connectionstring: "gateway", "interactions"no"gateway"Gateway WebSocket (default). interactions uses httpHostToken POST + Ed25519 verify.
plugins.discord.intentsarray<number>no
plugins.discord.enableSlashCommandsbooleannofalse
plugins.discord.globalCommandsbooleannofalse
plugins.discord.defaultActivityobjectno
plugins.discord.defaultActivity.namestringyes
plugins.discord.defaultActivity.typestring: "PLAYING", "STREAMING", "LISTENING", "WATCHING", "COMPETING"yes
plugins.discord.defaultActivity.urlstringno
plugins.discord.slashCommandsarray<object>no
plugins.discord.applicationIdstringnoRequired when connection is interactions.
plugins.discord.publicKeystringnoRequired when connection is interactions (hex Ed25519 public key).
plugins.discord.interactionsPathstringno"/discord/interactions"POST path on httpHostToken when connection is interactions.
plugins.discord.masterstring | numberno框架 master(Discord user snowflake;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.discord.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.discord.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.discord.endpoints[].masterstring | numberno本 endpoint 的框架 master(Discord user snowflake);覆盖顶层 master
plugins.discord.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.discord.endpoints[].tokenstringyesDiscord bot token
plugins.discord.endpoints[].idstringyesDiscord bot name
plugins.discord.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

email

plugins/adapters/email/schema.json

PathTypeRequiredDefaultDescription
plugins.email.masterstring | numberno框架 master(email address;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.email.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.email.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.email.endpoints[].masterstring | numberno本 endpoint 的框架 master(email address);覆盖顶层 master
plugins.email.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.email.endpoints[].smtpobjectyes
plugins.email.endpoints[].smtp.hoststringyes
plugins.email.endpoints[].smtp.portnumberyes
plugins.email.endpoints[].smtp.securebooleanyes
plugins.email.endpoints[].smtp.authobjectyes
plugins.email.endpoints[].smtp.auth.userstringyes
plugins.email.endpoints[].smtp.auth.passstringyes
plugins.email.endpoints[].imapobjectyes
plugins.email.endpoints[].imap.hoststringyes
plugins.email.endpoints[].imap.portnumberyes
plugins.email.endpoints[].imap.tlsbooleanyes
plugins.email.endpoints[].imap.userstringyes
plugins.email.endpoints[].imap.passwordstringyes
plugins.email.endpoints[].imap.checkIntervalnumberno60000
plugins.email.endpoints[].imap.mailboxstringno"INBOX"
plugins.email.endpoints[].imap.markSeenbooleannotrue
plugins.email.endpoints[].attachmentsobjectno
plugins.email.endpoints[].attachments.enabledbooleannofalse
plugins.email.endpoints[].attachments.downloadPathstringno
plugins.email.endpoints[].attachments.maxFileSizenumberno
plugins.email.endpoints[].attachments.allowedTypesarray<string>no
plugins.email.endpoints[].idstringyesEmail bot name
plugins.email.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

github

plugins/adapters/github/schema.json

PathTypeRequiredDefaultDescription
plugins.github.hoststringnoGitHub Enterprise hostname (default github.com)
plugins.github.webhook_pathstringno"/github/webhook"
plugins.github.webhookPathstringno"/github/webhook"
plugins.github.poll_intervalnumberno60Deferred: polling fallback was removed in the Plugin Runtime migration; currently parsed but unused
plugins.github.auto_reply_reposarray<string>noRepos whose Issue/PR comments auto-trigger AI without @bot
plugins.github.bot_loginstringnoOverride App bot login (default {slug}[bot])
plugins.github.workspace_rootstringnoManaged git workspace root
plugins.github.masterstring | numberno框架 master(GitHub user login or id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.github.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.github.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint
plugins.github.endpoints[].masterstring | numberno本 endpoint 的框架 master(GitHub user login or id);覆盖顶层 master
plugins.github.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.github.endpoints[].app_idstring | numbernoGitHub App ID
plugins.github.endpoints[].appIdstring | numbernoGitHub App ID (camelCase alias)
plugins.github.endpoints[].private_keystringnoGitHub App private key (PEM content or file path)
plugins.github.endpoints[].privateKeystringnoGitHub App private key (camelCase alias)
plugins.github.endpoints[].webhook_secretstringnoWebhook HMAC secret; enables httpHostToken POST route
plugins.github.endpoints[].webhookSecretstringnoWebhook HMAC secret (camelCase alias)
plugins.github.endpoints[].idstringyesGitHub App bot name
plugins.github.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

icqq

plugins/adapters/icqq/schema.json

PathTypeRequiredDefaultDescription
plugins.icqq.masterstring | numberyes框架 master QQ uin(/approve、AI/工具权限);endpoints[i].master 可逐项覆盖
plugins.icqq.trustedarray<string | number>no框架 trusted QQ uin 列表(弱于 master)
plugins.icqq.passwordstringnoQQ 密码(可选,不填则扫码登录)
plugins.icqq.platformnumber: 1, 2, 3, 4, 5, 6, 7no1登录设备平台:1=Android, 2=aPad, 3=Watch, 4=iMac, 5=iPad, 6=Tim, 7=Custom
plugins.icqq.verstringno协议版本号,仅在对应 platform 有多个版本时有效,不填则使用最新版本
plugins.icqq.signApiAddrstringno签名服务器地址;未配置时若安装了 @icqqjs/qqsign 则自动使用本地签名
plugins.icqq.dataDirstringno数据存储文件夹路径,默认为主模块下的 data 文件夹
plugins.icqq.autoReconnectbooleannotrue断线后是否自动重连(默认 true)
plugins.icqq.outboundMediastring: "file", "base64"no"file"出站媒体模式:file=落盘本地路径(默认); base64=CQ base64:// 内联
plugins.icqq.ignoreSelfbooleannotrue群聊和频道中是否过滤自己的消息(默认 true)
plugins.icqq.resendbooleannofalse被风控时是否尝试用分片发送(默认 false)
plugins.icqq.cacheGroupMemberbooleannotrue是否缓存群员列表(默认 true);群多时(500+)会多占约 100MB+ 内存
plugins.icqq.autoServerbooleannotrue是否自动选择最优服务器(默认 true)
plugins.icqq.qqntbooleannotrue是否使用 QQNT 协议(默认 true)
plugins.icqq.ntLoginbooleanno是否使用 NT 登录方式
plugins.icqq.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.icqq.endpoints[].idstringyesQQ uin
plugins.icqq.endpoints[].masterstring | numberno本 endpoint 的 master QQ uin;覆盖顶层 master
plugins.icqq.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.icqq.endpoints[].passwordstringno本 endpoint 的 QQ 密码
plugins.icqq.endpoints[].platformnumber: 1, 2, 3, 4, 5, 6, 7no登录设备平台:1=Android, 2=aPad, 3=Watch, 4=iMac, 5=iPad, 6=Tim, 7=Custom
plugins.icqq.endpoints[].verstringno协议版本号
plugins.icqq.endpoints[].signApiAddrstringno签名服务器地址
plugins.icqq.endpoints[].dataDirstringno数据存储文件夹路径
plugins.icqq.endpoints[].autoReconnectbooleanno断线后是否自动重连
plugins.icqq.endpoints[].outboundMediastring: "file", "base64"no出站媒体模式
plugins.icqq.endpoints[].ignoreSelfbooleanno是否过滤自己的消息
plugins.icqq.endpoints[].resendbooleanno被风控时是否分片发送
plugins.icqq.endpoints[].cacheGroupMemberbooleanno是否缓存群员列表
plugins.icqq.endpoints[].autoServerbooleanno是否自动选择最优服务器
plugins.icqq.endpoints[].qqntbooleanno是否使用 QQNT 协议
plugins.icqq.endpoints[].ntLoginbooleanno是否使用 NT 登录方式
plugins.icqq.commandPrefixstringno""命令前缀(默认 '' 无前缀)。endpoints[i] 可逐项覆盖

kook

plugins/adapters/kook/schema.json

PathTypeRequiredDefaultDescription
plugins.kook.connectionstring: "websocket", "webhook"no"websocket"WebSocket gateway (default). webhook requires httpHostToken, verify_token, and a public HTTPS callback URL.
plugins.kook.webhookPathstringno"/kook/webhook"POST path registered via httpHostToken when connection is webhook.
plugins.kook.data_dirstringno
plugins.kook.timeoutnumberno10000
plugins.kook.max_retrynumberno3
plugins.kook.ignorestring: "bot", "self"no"bot"
plugins.kook.logLevelstring: "trace", "debug", "info", "warn", "error", "fatal", "mark", "off"no"info"
plugins.kook.masterstring | numberno框架 master(KOOK user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.kook.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.kook.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.kook.endpoints[].masterstring | numberno本 endpoint 的框架 master(KOOK user id);覆盖顶层 master
plugins.kook.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.kook.endpoints[].tokenstringyesKOOK bot token
plugins.kook.endpoints[].verify_tokenstringnoKOOK developer console verify token (required for webhook mode).
plugins.kook.endpoints[].encrypt_keystringnoOptional Encrypt Key when message encryption is enabled in KOOK console.
plugins.kook.endpoints[].idstringyesKOOK bot name
plugins.kook.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

lark

plugins/adapters/lark/schema.json

PathTypeRequiredDefaultDescription
plugins.lark.webhookPathstringno"/lark/webhook"
plugins.lark.apiBaseUrlstringno
plugins.lark.isFeishubooleannotrue
plugins.lark.masterstring | numberno框架 master(Lark/Feishu open_id or user_id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.lark.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.lark.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.lark.endpoints[].masterstring | numberno本 endpoint 的框架 master(Lark/Feishu open_id or user_id);覆盖顶层 master
plugins.lark.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.lark.endpoints[].appIdstringyesLark app ID
plugins.lark.endpoints[].appSecretstringyesLark app secret
plugins.lark.endpoints[].encryptKeystringnoLark encrypt key
plugins.lark.endpoints[].verificationTokenstringnoLark verification token
plugins.lark.endpoints[].idstringyesLark bot name
plugins.lark.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

line

plugins/adapters/line/schema.json

PathTypeRequiredDefaultDescription
plugins.line.webhookPathstringno"/line/webhook"
plugins.line.apiBaseUrlstringno"https://api.line.me"
plugins.line.masterstring | numberno框架 master(LINE user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.line.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.line.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.line.endpoints[].masterstring | numberno本 endpoint 的框架 master(LINE user id);覆盖顶层 master
plugins.line.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.line.endpoints[].channelSecretstringyesLINE channel secret
plugins.line.endpoints[].channelAccessTokenstringyesLINE channel access token
plugins.line.endpoints[].idstringyesLINE bot name
plugins.line.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

milky

plugins/adapters/milky/schema.json

PathTypeRequiredDefaultDescription
plugins.milky.connectionstring: "ws", "sse", "webhook", "wss"no"ws"ws (default), sse (EventSource client), webhook or wss (webhook/wss via httpHostToken)
plugins.milky.reconnect_intervalnumberno5000
plugins.milky.heartbeat_intervalnumberno30000
plugins.milky.masterstring | numberno框架 master(QQ uin;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.milky.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.milky.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.milky.endpoints[].masterstring | numberno本 endpoint 的框架 master(QQ uin);覆盖顶层 master
plugins.milky.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.milky.endpoints[].baseUrlstringyesMilky HTTP API base URL (required); WS event path is derived as ws(s)😕/host/event
plugins.milky.endpoints[].pathstringnoPath for webhook / reverse-wss
plugins.milky.endpoints[].access_tokenstringnoMilky access token
plugins.milky.endpoints[].idstringyesMilky bot name
plugins.milky.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

napcat

plugins/adapters/napcat/schema.json

PathTypeRequiredDefaultDescription
plugins.napcat.connectionstring: "ws", "wss", "http"no"ws"ws (default), wss (reverse WS), or http (POST webhook + HTTP API outbound)
plugins.napcat.reconnect_intervalnumberno5000
plugins.napcat.heartbeat_intervalnumberno30000
plugins.napcat.poll_intervalnumberno30000
plugins.napcat.masterstring | numberno框架 master(QQ uin;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.napcat.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.napcat.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.napcat.endpoints[].masterstring | numberno本 endpoint 的框架 master(QQ uin);覆盖顶层 master
plugins.napcat.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.napcat.endpoints[].urlstringnoNapCat WebSocket URL (required for connection: ws)
plugins.napcat.endpoints[].pathstringnoWS path for reverse-wss
plugins.napcat.endpoints[].http_urlstringnoHTTP API base URL (connection: http outbound)
plugins.napcat.endpoints[].post_pathstringnoHTTP POST event path (connection: http inbound)
plugins.napcat.endpoints[].access_tokenstringnoNapCat access token
plugins.napcat.endpoints[].idstringyesNapCat bot name
plugins.napcat.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

onebot11

plugins/adapters/onebot11/schema.json

PathTypeRequiredDefaultDescription
plugins.onebot11.connectionstring: "ws", "wss"no"ws"connection: ws (forward WS client, default) or wss (reverse WS via httpHostToken)
plugins.onebot11.reconnect_intervalnumberno5000
plugins.onebot11.heartbeat_intervalnumberno30000
plugins.onebot11.masterstring | numberno框架 master(platform user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.onebot11.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.onebot11.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.onebot11.endpoints[].masterstring | numberno本 endpoint 的框架 master(platform user id);覆盖顶层 master
plugins.onebot11.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.onebot11.endpoints[].urlstringnoOneBot implementation WebSocket URL (required for connection: ws)
plugins.onebot11.endpoints[].pathstringnoWS path for reverse-wss (connection: wss)
plugins.onebot11.endpoints[].access_tokenstringnoOneBot access token
plugins.onebot11.endpoints[].idstringyesOneBot11 bot name
plugins.onebot11.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

onebot12

plugins/adapters/onebot12/schema.json

PathTypeRequiredDefaultDescription
plugins.onebot12.connectionstring: "ws", "webhook", "wss"no"ws"ws (default), webhook (httpHostToken POST), or wss (reverse WS via httpHostToken)
plugins.onebot12.reconnect_intervalnumberno5000
plugins.onebot12.heartbeat_intervalnumberno30000
plugins.onebot12.masterstring | numberno框架 master(platform user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.onebot12.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.onebot12.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.onebot12.endpoints[].masterstring | numberno本 endpoint 的框架 master(platform user id);覆盖顶层 master
plugins.onebot12.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.onebot12.endpoints[].urlstringnoOneBot implementation WebSocket URL (required for connection: ws)
plugins.onebot12.endpoints[].pathstringnoHTTP/WS path for webhook or reverse-wss
plugins.onebot12.endpoints[].api_urlstringnoHTTP action endpoint for webhook outbound (required for connection: webhook send)
plugins.onebot12.endpoints[].access_tokenstringnoOneBot access token
plugins.onebot12.endpoints[].idstringyesOneBot12 bot name
plugins.onebot12.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

qq

plugins/adapters/qq/schema.json

PathTypeRequiredDefaultDescription
plugins.qq.modestring: "websocket", "webhook", "middleware"no"websocket"WebSocket gateway (default). webhook/middleware use httpHostToken POST.
plugins.qq.sandboxbooleannofalse
plugins.qq.botKindstring: "public", "private"no"public"公域/私域:均含 GROUP_AND_C2C_EVENT;频道消息分别为 PUBLIC_GUILD_MESSAGES / GUILD_MESSAGES。未显式配置 intents 时按此展开
plugins.qq.masterstring | numberno框架 master(endpoint 管理命令、AI/工具权限);openid。endpoints[i].master 可逐项覆盖
plugins.qq.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.qq.intentsarray<string>noWebSocket Identify intents;省略时按 botKind 自动生成(public→含 PUBLIC_GUILD_MESSAGES)
plugins.qq.accessTokenUrlstringno
plugins.qq.gatewayUrlstringno
plugins.qq.webhookPathstringno"/qq/webhook"POST path on httpHostToken for webhook/middleware modes.
plugins.qq.portnumbernoLegacy standalone webhook port (unused with httpHostToken).
plugins.qq.pathstringnoLegacy standalone webhook path (unused with httpHostToken).
plugins.qq.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.qq.endpoints[].appidstringyesQQ official bot app ID
plugins.qq.endpoints[].secretstringyesQQ official bot secret
plugins.qq.endpoints[].masterstring | numberno本 endpoint 的框架 master(openid);覆盖顶层 master
plugins.qq.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.qq.endpoints[].botKindstring: "public", "private"no覆盖顶层 botKind(公域/私域),用于按 endpoint 生成 intents
plugins.qq.endpoints[].intentsarray<string>no覆盖顶层 intents
plugins.qq.endpoints[].idstringyesQQ bot name
plugins.qq.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

sandbox

plugins/adapters/sandbox/schema.json

PathTypeRequiredDefaultDescription
plugins.sandbox.masterstring | numberno框架 master(sandbox client id (distinct from endpoints[].owner);AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.sandbox.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.sandbox.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.sandbox.endpoints[].masterstring | numberno本 endpoint 的框架 master(sandbox client id (distinct from endpoints[].owner));覆盖顶层 master
plugins.sandbox.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.sandbox.endpoints[].contextstringnoSandbox context identifier
plugins.sandbox.endpoints[].ownerstringnoSandbox owner user ID
plugins.sandbox.endpoints[].idstringyesSandbox bot name
plugins.sandbox.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

satori

plugins/adapters/satori/schema.json

PathTypeRequiredDefaultDescription
plugins.satori.connectionstring: "ws", "webhook"no"ws"ws (default) or webhook (httpHostToken POST route)
plugins.satori.heartbeat_intervalnumberno10000WS PING interval in milliseconds
plugins.satori.masterstring | numberno框架 master(platform user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.satori.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.satori.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.satori.endpoints[].masterstring | numberno本 endpoint 的框架 master(platform user id);覆盖顶层 master
plugins.satori.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.satori.endpoints[].baseUrlstringyesSatori SDK HTTP/WS base URL (e.g. http://127.0.0.1:5140)
plugins.satori.endpoints[].tokenstringnoBearer token for API and WS IDENTIFY
plugins.satori.endpoints[].pathstringnoWebhook POST path (connection: webhook)
plugins.satori.endpoints[].idstringyesSatori bot name
plugins.satori.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

slack

plugins/adapters/slack/schema.json

PathTypeRequiredDefaultDescription
plugins.slack.socketModebooleannotruePrefer Socket Mode (default). Set false for HTTP Events via httpHostToken.
plugins.slack.webhookPathstringno"/slack/events"
plugins.slack.clientPingTimeoutnumberno15000Socket Mode client ping timeout (ms)
plugins.slack.masterstring | numberno框架 master(Slack user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.slack.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.slack.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.slack.endpoints[].masterstring | numberno本 endpoint 的框架 master(Slack user id);覆盖顶层 master
plugins.slack.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.slack.endpoints[].tokenstringyesBot User OAuth Token (xoxb-...)
plugins.slack.endpoints[].signingSecretstringnoRequired for HTTP Events API (socketMode: false)
plugins.slack.endpoints[].appTokenstringnoApp-Level Token (xapp-...) for Socket Mode
plugins.slack.endpoints[].idstringyesSlack bot name
plugins.slack.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

telegram

plugins/adapters/telegram/schema.json

PathTypeRequiredDefaultDescription
plugins.telegram.pollingbooleannotrueLong-poll getUpdates (default). Set false for webhook via httpHostToken.
plugins.telegram.webhookobjectnoWebhook settings when polling is false.
plugins.telegram.webhook.domainstringno
plugins.telegram.webhook.pathstringno"/telegram/webhook"
plugins.telegram.webhook.secretTokenstringnoVerified via X-Telegram-Bot-Api-Secret-Token.
plugins.telegram.allowedUpdatesarray<string>no["message","callback_query"]
plugins.telegram.apiBaseUrlstringno"https://api.telegram.org"
plugins.telegram.masterstring | numberno框架 master(Telegram user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.telegram.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.telegram.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.telegram.endpoints[].masterstring | numberno本 endpoint 的框架 master(Telegram user id);覆盖顶层 master
plugins.telegram.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.telegram.endpoints[].tokenstringyesTelegram bot token
plugins.telegram.endpoints[].idstringyesTelegram bot name
plugins.telegram.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

wechat-mp

plugins/adapters/wechat-mp/schema.json

PathTypeRequiredDefaultDescription
plugins.wechat-mp.pathstringno"/wechat/webhook"
plugins.wechat-mp.encryptbooleannofalse
plugins.wechat-mp.encryptModestring: "plain", "compatible", "secure"noDefault follows encrypt: 'plain' when encrypt=false, 'compatible' when encrypt=true
plugins.wechat-mp.replyModestring: "passive", "customer_service"no"passive"
plugins.wechat-mp.passiveReplyTimeoutMsnumberno4500
plugins.wechat-mp.masterstring | numberno框架 master(WeChat OpenID;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.wechat-mp.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.wechat-mp.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.wechat-mp.endpoints[].masterstring | numberno本 endpoint 的框架 master(WeChat OpenID);覆盖顶层 master
plugins.wechat-mp.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.wechat-mp.endpoints[].appIdstringyesWeChat MP app ID
plugins.wechat-mp.endpoints[].appSecretstringyesWeChat MP app secret
plugins.wechat-mp.endpoints[].tokenstringyesWeChat MP callback token
plugins.wechat-mp.endpoints[].encodingAESKeystringnoWeChat MP encoding AES key
plugins.wechat-mp.endpoints[].idstringyesWeChat MP bot name
plugins.wechat-mp.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

wecom

plugins/adapters/wecom/schema.json

PathTypeRequiredDefaultDescription
plugins.wecom.webhookPathstringno"/wecom/callback"
plugins.wecom.apiBaseUrlstringno"https://qyapi.weixin.qq.com"
plugins.wecom.masterstring | numberno框架 master(WeCom userid;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.wecom.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.wecom.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.wecom.endpoints[].masterstring | numberno本 endpoint 的框架 master(WeCom userid);覆盖顶层 master
plugins.wecom.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.wecom.endpoints[].corpIdstringyesWeCom corp ID
plugins.wecom.endpoints[].agentSecretstringyesWeCom agent secret
plugins.wecom.endpoints[].tokenstringyesWeCom callback token
plugins.wecom.endpoints[].encodingAESKeystringyesWeCom encoding AES key
plugins.wecom.endpoints[].idstringyesWeCom bot name
plugins.wecom.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

plugins/adapters/weixin-ilink/schema.json

PathTypeRequiredDefaultDescription
plugins.weixin-ilink.botAgentstringno
plugins.weixin-ilink.baseUrlstringno"https://ilinkai.weixin.qq.com"
plugins.weixin-ilink.cdnBaseUrlstringno"https://novac2c.cdn.weixin.qq.com/c2c"
plugins.weixin-ilink.longPollTimeoutMsnumberno35000
plugins.weixin-ilink.masterstring | numberno框架 master(Weixin user id;AI/工具权限、endpoint 管理)。endpoints[i].master 可逐项覆盖
plugins.weixin-ilink.trustedarray<string | number>no框架 trusted 用户列表(弱于 master)。endpoints[i].trusted 可逐项追加
plugins.weixin-ilink.endpointsarray<object>yes多账号:一个插件实例挂多个 endpoint。每项与顶层字段同构(id 必填,其余覆盖顶层)
plugins.weixin-ilink.endpoints[].masterstring | numberno本 endpoint 的框架 master(Weixin user id);覆盖顶层 master
plugins.weixin-ilink.endpoints[].trustedarray<string | number>no本 endpoint 的 trusted 列表
plugins.weixin-ilink.endpoints[].botTokenstringyesiLink bot token (prefer env WEIXIN_ILINK_TOKEN or sidecar credential file)
plugins.weixin-ilink.endpoints[].idstringyesWeixin iLink bot name
plugins.weixin-ilink.commandPrefixstringno""命令前缀(默认 '' 无前缀,任意文本按命令匹配;如 '/' 要求 / 开头)。endpoints[i] 可逐项覆盖

process-monitor

plugins/features/process-monitor/schema.json

PathTypeRequiredDefaultDescription
plugins.process-monitor.enabledbooleannotrue是否启用进程监控
plugins.process-monitor.notifyOnStartbooleannotrue首次启动时通知
plugins.process-monitor.notifyOnRestartbooleannotrue正常重启时通知
plugins.process-monitor.notifyOnCrashbooleannotrue异常崩溃重启时通知
plugins.process-monitor.notifyChannelsarray<object>no[]通知渠道(slice-1 仅 webhook 生效)
plugins.process-monitor.notifyChannels[].typestring: "user", "group", "webhook"yes
plugins.process-monitor.notifyChannels[].targetstringyes
plugins.process-monitor.notifyChannels[].platformstringno

blackjack

plugins/games/blackjack/schema.json

This Schema declares no fields.

dice-duel

plugins/games/dice-duel/schema.json

This Schema declares no fields.

dungeon-expedition

plugins/games/dungeon-expedition/schema.json

This Schema declares no fields.

guess-number

plugins/games/guess-number/schema.json

This Schema declares no fields.

hub

plugins/games/hub/schema.json

This Schema declares no fields.

idiom-chain

plugins/games/idiom-chain/schema.json

This Schema declares no fields.

rps

plugins/games/rps/schema.json

This Schema declares no fields.

text-adventure

plugins/games/text-adventure/schema.json

This Schema declares no fields.

tic-tac-toe

plugins/games/tic-tac-toe/schema.json

This Schema declares no fields.

word-riddle

plugins/games/word-riddle/schema.json

This Schema declares no fields.

activity-feedback

plugins/services/activity-feedback/schema.json

PathTypeRequiredDefaultDescription
plugins.activity-feedback.enabledbooleannotrue
plugins.activity-feedback.defaultsobjectno
plugins.activity-feedback.platformsobjectno
plugins.activity-feedback.endpointsobjectno
plugins.activity-feedback.scheduleobjectno

60s

plugins/utils/60s/schema.json

PathTypeRequiredDefaultDescription
plugins.60s.apiBasestringno"https://60s.viki.moe"60s API base URL

code-runner

plugins/utils/code-runner/schema.json

This Schema declares no fields.

content-moderation

plugins/utils/content-moderation/schema.json

PathTypeRequiredDefaultDescription
plugins.content-moderation.enabledbooleannotrue总开关
plugins.content-moderation.onErrorstring: "open", "closed"no"open"审查源失败时的全局默认策略:open=视为通过,closed=视为 critical
plugins.content-moderation.maskCharstringno"*"文本打码字符
plugins.content-moderation.replyTemplatestringno"消息含不当内容,已拦截。"reply 动作时的提示文案
plugins.content-moderation.mastersarray<string>no[]额外视为 master 的 userId(兜底,与 endpoint master 合并)
plugins.content-moderation.inboundobjectno
plugins.content-moderation.inbound.enabledbooleannotrue
plugins.content-moderation.inbound.bypassMastersbooleannotruemaster 跳过入站审查
plugins.content-moderation.inbound.whitelistobjectno
plugins.content-moderation.inbound.whitelist.userIdsarray<string>no[]
plugins.content-moderation.inbound.whitelist.conversationIdsarray<string>no[]
plugins.content-moderation.outboundobjectno
plugins.content-moderation.outbound.enabledbooleannotrue
plugins.content-moderation.outbound.bypassbooleannofalse为 true 时跳过出站审查
plugins.content-moderation.actionsobjectnoseverity → 动作(字符串或数组);缺省用偏严默认表
plugins.content-moderation.actions.passstring: "allow", "log", "reply", "redact", "drop", "recall" | array<string: "allow", "log", "reply", "redact", "drop", "recall">no
plugins.content-moderation.actions.lowstring: "allow", "log", "reply", "redact", "drop", "recall" | array<string: "allow", "log", "reply", "redact", "drop", "recall">no
plugins.content-moderation.actions.mediumstring: "allow", "log", "reply", "redact", "drop", "recall" | array<string: "allow", "log", "reply", "redact", "drop", "recall">no
plugins.content-moderation.actions.highstring: "allow", "log", "reply", "redact", "drop", "recall" | array<string: "allow", "log", "reply", "redact", "drop", "recall">no
plugins.content-moderation.actions.criticalstring: "allow", "log", "reply", "redact", "drop", "recall" | array<string: "allow", "log", "reply", "redact", "drop", "recall">no
plugins.content-moderation.sourcesarray<object>no[]
plugins.content-moderation.sources[].idstringyes
plugins.content-moderation.sources[].typestring: "local", "http"yes
plugins.content-moderation.sources[].enabledbooleannotrue
plugins.content-moderation.sources[].onErrorstring: "open", "closed"no
plugins.content-moderation.sources[].includeBuiltinbooleannotrue是否合并内置分级违禁词词库
plugins.content-moderation.sources[].wordsarray<string | object>no[]自定义词:字符串(用 defaultSeverity)或
plugins.content-moderation.sources[].wordFilesarray<string>no[]词库文件;行格式 word / severity:word / word|severity
plugins.content-moderation.sources[].defaultSeveritystring: "low", "medium", "high", "critical"no"high"未标注分级的自定义词默认 severity
plugins.content-moderation.sources[].severitystring: "low", "medium", "high", "critical"no"high"兼容旧字段,等同 defaultSeverity
plugins.content-moderation.sources[].urlstringno
plugins.content-moderation.sources[].headersobjectno
plugins.content-moderation.sources[].timeoutMsnumberno5000
plugins.content-moderation.sources[].forceUploadbooleannofalse强制下载图片后上传,不传 URL

group-suite

plugins/utils/group-suite/schema.json

PathTypeRequiredDefaultDescription
plugins.group-suite.keywordReplybooleannofalse
plugins.group-suite.basePointsMinnumberno10
plugins.group-suite.basePointsMaxnumberno30
plugins.group-suite.streakBonusnumberno5
plugins.group-suite.streakCapnumberno50
plugins.group-suite.rankSizenumberno10
plugins.group-suite.teachMaxPerGroupnumberno200
plugins.group-suite.teachCooldownMsnumberno3000
plugins.group-suite.teachAllowRegexbooleannotrue
plugins.group-suite.teachPageSizenumberno10

plugins/utils/link-poster/schema.json

This Schema declares no fields.

lottery

plugins/utils/lottery/schema.json

PathTypeRequiredDefaultDescription
plugins.lottery.pickCountnumberno5
plugins.lottery.scheduleCronstringno"0 0 18 * * *"
plugins.lottery.historyLimitnumberno500
plugins.lottery.scheduleEnabledbooleannotrue
plugins.lottery.backtestEnabledbooleannotrue
plugins.lottery.backtestWindownumberno50
plugins.lottery.backtestRandomTrialsnumberno64
plugins.lottery.backtestMinHistorynumberno30
plugins.lottery.backtestAdaptivebooleannotrue
plugins.lottery.weightPersistEnabledbooleannotrue
plugins.lottery.weightHoldoutFallbackbooleannotrue
plugins.lottery.gamesarray<string>no["kl8","ssq","dlt","fc3d","pl3","pl5"]
plugins.lottery.pushTargetsarray<object>no[]OutboundHost push destinations for cron/publish reports
plugins.lottery.pushTargets[].adapterstringyes
plugins.lottery.pushTargets[].endpointIdstringno
plugins.lottery.pushTargets[].channelTypestringno"private"
plugins.lottery.pushTargets[].channelIdstringyes
plugins.lottery.kl8objectno
plugins.lottery.kl8.pickCountnumberno5
plugins.lottery.kl8.recommendGroupsnumberno3
plugins.lottery.kl8.groupStrategiesarray<string>no["balanced","hot","cold"]

music

plugins/utils/music/schema.json

This Schema declares no fields.

qrcode

plugins/utils/qrcode/schema.json

This Schema declares no fields.

repeater

plugins/utils/repeater/schema.json

PathTypeRequiredDefaultDescription
plugins.repeater.thresholdnumberno3触发复读的最少人数
plugins.repeater.cooldownnumberno30000同一群冷却时间 (ms)
plugins.repeater.maxLengthnumberno200消息长度上限

rss

plugins/utils/rss/schema.json

PathTypeRequiredDefaultDescription
plugins.rss.pollCronstringno"0 */5 * * * *"轮询频率 (6 段 Cron 表达式)
plugins.rss.maxPerGroupnumberno30
plugins.rss.maxItemsnumberno5
plugins.rss.timeoutnumberno15000

short-url

plugins/utils/short-url/schema.json

This Schema declares no fields.