Skip to main content
PATCH
Update an agent plugin

Authorizations

Authorization
string
header
required

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

Path Parameters

agentPluginId
string
required

Body

application/json
kind
enum<string>

Replacement plugin execution provider kind.

Available options:
tools,
mcp_server,
skill,
package
name
string

Updated plugin name.

Minimum string length: 1
description
string

Updated plugin description.

routing
object

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

category
string

Updated plugin category.

metadata
object

Replacement 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:
remoteId
string

Updated upstream plugin identifier.

version
number

Optimistic version expected by the client.

Required range: x >= 0
executionMode
enum<string>

Replacement execution mode.

Available options:
sync,
background
componentId
string

Replacement component id. Required when kind is explicitly set to tools, and forbidden for MCP server patches.

Minimum string length: 1
componentVersion
number

Replacement fixed component version for tools patches. Forbidden for MCP server patches.

Required range: x >= 0
componentToolset
object

Replacement component-backed toolset. Forbidden for MCP server and skill patches.

mcpServer
object

Replacement remote MCP server configuration. Required when kind is explicitly set to mcp_server, and forbidden for tools patches.

mcpToolset
object

Replacement per-tool MCP governance and loading configuration for MCP server patches. Forbidden for tools patches.

skill
object

Replacement Markdown skill configuration. Required when kind is explicitly set to skill.

package
object

Replacement Markdown package manifest. Required when kind is explicitly set to package.

providerSource
enum<string>

Replacement provider source recorded for discovery, auditability, and telemetry.

Available options:
tenant_plugin,
community_plugin
inputSchema
object

Replacement strict structured input schema for tools plugins. Forbidden for MCP server patches. Must be an object schema with additionalProperties=false and descriptions on every declared property.

outputSchema
object

Replacement structured output schema for tools plugins. Forbidden for MCP server patches.

approvalPolicy
object

Replacement approval contract.

mutationIntent
enum<string>

Declared mutation intent used for governance and approval safety.

Available options:
read,
write,
destructive,
external
reversibility
enum<string>

Replacement reversibility declaration.

Available options:
reversible,
operator_reversible,
irreversible,
unknown
targetScope
enum<string>

Replacement target scope.

Available options:
assistant_thread,
agent,
tenant,
external
sideEffectSummary
string

Replacement side-effect declaration.

sideEffectCategories
string[]

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

timeoutMs
number

Replacement execution timeout in milliseconds.

Required range: x >= 1000
Example:

30000

resultMaxBytes
number

Replacement 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

Updated active flag used to gate runtime attachment.

Response

200 - undefined
Last modified on September 5, 2026