Skip to content
PricingReleases

NormalizedPluginManifest

Defined in: plugin.ts:1066

Flat manifest returned after v2 normalization and validation.

optional $schema?: string

Defined in: plugin.ts:1082

PluginManifest.$schema


optional adapterManifest?: AdapterManifest

Defined in: plugin.ts:1165

PluginManifest.adapterManifest


optional adapters?: string | string[]

Defined in: plugin.ts:1110

PluginManifest.adapters


optional agent?: PluginAgentManifest

Defined in: plugin.ts:1081

PluginManifest.agent


optional app?: PluginAppConfig

Defined in: plugin.ts:1161

PluginManifest.app


optional appScope?: string

Defined in: plugin.ts:1099

PluginManifest.appScope


optional author?: string | { name?: string; url?: string; }

Defined in: plugin.ts:1088

PluginManifest.author


optional automations?: string | string[]

Defined in: plugin.ts:1109

PluginManifest.automations


optional bundledOptIn?: boolean

Defined in: plugin.ts:1151

PluginManifest.bundledOptIn


optional category?: string

Defined in: plugin.ts:1097

PluginManifest.category


optional channelConnection?: object

Defined in: plugin.ts:1130

optional managedOAuth?: object

authorizationUrl: string

optional authorizeParams?: Record<string, string>

gatewayProvider: string

identity: object

idPath: string

optional labelPath?: string

scopes: string[]

optional scopeSeparator?: "space" | "comma"

settings: Record<string, string>

PluginManifest.channelConnection


optional channelSetup?: object

Defined in: plugin.ts:1124

description: string

optional guideLabel?: string

guideUrl: string

title: string

PluginManifest.channelSetup


optional cli?: PluginCliConfig

Defined in: plugin.ts:1159

PluginManifest.cli


optional client?: Omit<PluginUiAppBundle, "kind" | "pluginId">

Defined in: plugin.ts:1141

PluginManifest.client


optional client_lifecycle?: Record<string, ClientLifecycleHandlerDeclaration>

Defined in: plugin.ts:1149

PluginManifest.client_lifecycle


optional color?: string

Defined in: plugin.ts:1095

PluginManifest.color


optional commands?: string | string[]

Defined in: plugin.ts:1108

PluginManifest.commands


optional comms?: string | string[]

Defined in: plugin.ts:1103

PluginManifest.comms


optional computerProvider?: SandboxProviderDeclaration

Defined in: plugin.ts:1147

PluginManifest.computerProvider


optional consumes?: PluginManifestConsumes

Defined in: plugin.ts:1119

PluginManifest.consumes


optional data?: PluginDataConfig

Defined in: plugin.ts:1145

PluginManifest.data


optional dataset?: PluginDatasetDescriptor

Defined in: plugin.ts:1146

PluginManifest.dataset


optional dependencies?: string[]

Defined in: plugin.ts:1150

PluginManifest.dependencies


optional description?: string

Defined in: plugin.ts:1087

PluginManifest.description


optional detect?: PluginDetectConfig

Defined in: plugin.ts:1144

PluginManifest.detect


optional diagnoseCommand?: string

Defined in: plugin.ts:1154

PluginManifest.diagnoseCommand


optional entities?: PluginEntityProvider[]

Defined in: plugin.ts:1118

PluginManifest.entities


optional extensions?: Record<string, unknown>

Defined in: plugin.ts:1093

PluginManifest.extensions


optional greetings?: string | string[]

Defined in: plugin.ts:1114

PluginManifest.greetings


optional homepage?: string

Defined in: plugin.ts:1089

PluginManifest.homepage


optional hooks?: string | string[]

Defined in: plugin.ts:1121

PluginManifest.hooks


optional icon?: string

Defined in: plugin.ts:1096

PluginManifest.icon


id: string

Defined in: plugin.ts:1084

PluginManifest.id


optional installCommand?: string

Defined in: plugin.ts:1155

PluginManifest.installCommand


optional installUrl?: string

Defined in: plugin.ts:1158

PluginManifest.installUrl


optional keywords?: string[]

Defined in: plugin.ts:1092

PluginManifest.keywords


optional license?: string

Defined in: plugin.ts:1091

PluginManifest.license


optional lifecycle?: Record<string, LifecycleHandlerDeclaration>

Defined in: plugin.ts:1148

PluginManifest.lifecycle


optional loginCommand?: string

Defined in: plugin.ts:1152

PluginManifest.loginCommand


manifestFormat: 2

Defined in: plugin.ts:1067

PluginManifest.manifestFormat


optional mcp?: string | string[]

Defined in: plugin.ts:1122

PluginManifest.mcp


optional mcpDiagnoseCommand?: string

Defined in: plugin.ts:1157

PluginManifest.mcpDiagnoseCommand


optional mcpLoginCommand?: string

Defined in: plugin.ts:1156

PluginManifest.mcpLoginCommand


optional migrations?: string

Defined in: plugin.ts:1117

PluginManifest.migrations


optional min_recursive_version?: string

Defined in: plugin.ts:1102

PluginManifest.min_recursive_version


optional name?: string

Defined in: plugin.ts:1085

PluginManifest.name


optional npm?: object

Defined in: plugin.ts:1160

optional scripts?: boolean

PluginManifest.npm


optional onboarding?: PluginOnboardingConfig

Defined in: plugin.ts:1163

PluginManifest.onboarding


optional operations?: string | string[]

Defined in: plugin.ts:1116

PluginManifest.operations


optional platforms?: string[]

Defined in: plugin.ts:1101

PluginManifest.platforms


optional pluginOAuth?: PluginOAuthConfig

Defined in: plugin.ts:1164

PluginManifest.pluginOAuth


optional private?: boolean

Defined in: plugin.ts:1100

PluginManifest.private


optional providers?: string | string[]

Defined in: plugin.ts:1115

PluginManifest.providers


optional provides?: PluginManifestProvides

Defined in: plugin.ts:1068


optional remoteAccess?: object

Defined in: plugin.ts:1080

providers: RemoteProviderDeclaration[]

PluginManifest.remoteAccess


optional repository?: string

Defined in: plugin.ts:1090

PluginManifest.repository


optional routes?: string | string[]

Defined in: plugin.ts:1120

PluginManifest.routes


optional rules?: string | string[]

Defined in: plugin.ts:1107

PluginManifest.rules


optional settings?: PluginSettingsSchema

Defined in: plugin.ts:1143

PluginManifest.settings


optional setupCommand?: string

Defined in: plugin.ts:1153

PluginManifest.setupCommand


optional setupSequence?: PluginSetupStep[]

Defined in: plugin.ts:1162

PluginManifest.setupSequence


optional skills?: string | string[]

Defined in: plugin.ts:1106

PluginManifest.skills


optional soundDefaults?: Record<string, string>

Defined in: plugin.ts:1105

PluginManifest.soundDefaults


optional sounds?: string | string[]

Defined in: plugin.ts:1113

PluginManifest.sounds


optional tags?: string[]

Defined in: plugin.ts:1098

PluginManifest.tags


optional themes?: string | string[]

Defined in: plugin.ts:1112

PluginManifest.themes


optional thumbnail?: string

Defined in: plugin.ts:1094

PluginManifest.thumbnail


optional tools?: string | string[]

Defined in: plugin.ts:1111

PluginManifest.tools


optional triggers?: PluginTriggersManifest

Defined in: plugin.ts:1123

PluginManifest.triggers


optional ui?: PluginUiManifest

Defined in: plugin.ts:1142

PluginManifest.ui


optional version?: string

Defined in: plugin.ts:1086

PluginManifest.version