RevoEngine Documentation

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Body

application/json

string

required

Stable plugin id used by the agent runtime.

Minimum string length: 1

name

string

required

Operator-facing plugin name.

Minimum string length: 1

componentId

string

required

Component id executed when this tool plugin runs. Required for tools plugins and forbidden for MCP server plugins.

Minimum string length: 1

kind

enum<string>

default:tools

Plugin execution provider kind.

Available options:

tools,

mcp_server,

skill,

package

description

string

Optional plugin description.

routing

object

Canonical English capability metadata used for tool selection. Operator-facing content may remain localized.

Show child attributes

category

string

Optional plugin category used for search, grouping, and operator organization.

metadata

object

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:

{ "costCenter": "ops" }

remoteId

string

Optional upstream identifier used to track the source plugin when this registry entry is a tenant-local clone.

executionMode

enum<string>

Execution mode expected for the plugin provider.

Available options:

sync,

background

componentVersion

number

Optional fixed component version for tools plugins. Forbidden for MCP server plugins.

Required range: x >= 0

componentToolset

object

Multiple governed tool contracts backed by the same component implementation. Forbidden for MCP server and skill plugins.

Show child attributes

mcpServer

object

Remote MCP server configuration. Required for MCP server plugins and forbidden for tools plugins.

Show child attributes

mcpToolset

object

Per-tool MCP governance and loading configuration used for MCP server plugins. Forbidden for tools plugins.

Show child attributes

skill

object

Markdown skill configuration. Required for skill plugins and forbidden for tools or MCP plugins.

Show child attributes

package

object

Markdown package manifest. Required for package plugins and forbidden for tools, MCP, and skill plugins.

Show child attributes

providerSource

enum<string>

Provider source recorded for discovery, auditability, and telemetry.

Available options:

tenant_plugin,

community_plugin

inputSchema

object

Strict structured input schema exposed to discovery and runtime validation for tools plugins. Forbidden for MCP server plugins. Must be an object schema with additionalProperties=false and descriptions on every declared property.

outputSchema

object

Structured output schema expected from the provider for tools plugins. Forbidden for MCP server plugins.

approvalPolicy

object

Approval contract enforced before execution.

Show child attributes

mutationIntent

enum<string>

Declared mutation intent used for governance and approval safety.

Available options:

read,

write,

destructive,

external

reversibility

enum<string>

Declared reversibility of the plugin side effects.

Available options:

reversible,

operator_reversible,

irreversible,

unknown

targetScope

enum<string>

Primary runtime scope impacted when the plugin executes.

Available options:

assistant_thread,

agent,

tenant,

external

sideEffectSummary

string

Concise side-effect declaration recorded in approval, evidence, and audit surfaces.

sideEffectCategories

string[]

Normalized side-effect categories used for governance and operator review.

timeoutMs

number

Maximum runtime in milliseconds.

Required range: x >= 1000

Example:

30000

resultMaxBytes

number

Maximum serialized result size in bytes.

Required range: x >= 512

autoDiscovery

boolean

Whether the plugin should be surfaced as summary-only discovery context for agents and assistant threads before explicit attachment.

active

boolean

Whether the plugin may be attached and used by agents or assistants at runtime.

Response

201 - undefined

Before you start

Platform API

Create an agent plugin

Authorizations

Body

Response