Class ServerPluginsApi

java.lang.Object

com.github.copilot.generated.rpc.ServerPluginsApi

@Generated("copilot-sdk-codegen")
public final class ServerPluginsApi
extends Object

API methods for the plugins namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final ServerPluginsBuiltinApi	builtin	API methods for the plugins.builtin sub-namespace.
final ServerPluginsMarketplacesApi	marketplaces	API methods for the plugins.marketplaces sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<PluginInstallationResult>	applyInstall(PluginsApplyInstallParams params)	Consumes one verified Agent Plugin installation plan, requests explicit human consent through installations.confirm on the original connection, then reacquires and verifies every file and registers the plugin, disabled, exactly as a direct plugin install.
CompletableFuture<Void>	disable(PluginsDisableParams params)	Disables installed plugins for new sessions.
CompletableFuture<Void>	enable(PluginsEnableParams params)	Enables installed plugins for new sessions.
CompletableFuture<PluginsInstallResult>	install(PluginsInstallParams params)	Installs a plugin from a marketplace, GitHub repo, URL, or local path.
CompletableFuture<PluginsListResult>	list()	Lists plugins installed in user/global state.
CompletableFuture<PluginInstallationManagementResult>	planInstall(PluginsPlanInstallParams params)	Plans installation of an Agent Plugin search candidate from its verified Agent Finder materialisation without writing files.
CompletableFuture<Void>	uninstall(PluginsUninstallParams params)	Uninstalls an installed plugin.
CompletableFuture<PluginsUpdateResult>	update(PluginsUpdateParams params)	Updates an installed plugin to its latest published version.
CompletableFuture<PluginsUpdateAllResult>	updateAll()	Updates every installed plugin to its latest published version.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

builtin

public final ServerPluginsBuiltinApi builtin

API methods for the plugins.builtin sub-namespace.

marketplaces

public final ServerPluginsMarketplacesApi marketplaces

API methods for the plugins.marketplaces sub-namespace.

Method Details

planInstall

@CopilotExperimental
public CompletableFuture<PluginInstallationManagementResult> planInstall(PluginsPlanInstallParams params)

Plans installation of an Agent Plugin search candidate from its verified Agent Finder materialisation without writing files. Only candidates that carry a handle can be planned. The review shows only verified data, and installing leaves the plugin disabled until it is enabled through plugins.enable.

Since:

1.0.0

applyInstall

@CopilotExperimental
public CompletableFuture<PluginInstallationResult> applyInstall(PluginsApplyInstallParams params)

Consumes one verified Agent Plugin installation plan, requests explicit human consent through installations.confirm on the original connection, then reacquires and verifies every file and registers the plugin, disabled, exactly as a direct plugin install. The installed plugin is listed, enabled and uninstalled through the existing plugins methods.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<PluginsListResult> list()

Lists plugins installed in user/global state.

Since:

1.0.0

install

@CopilotExperimental
public CompletableFuture<PluginsInstallResult> install(PluginsInstallParams params)

Installs a plugin from a marketplace, GitHub repo, URL, or local path.

Since:

1.0.0

uninstall

@CopilotExperimental
public CompletableFuture<Void> uninstall(PluginsUninstallParams params)

Uninstalls an installed plugin.

Since:

1.0.0

update

@CopilotExperimental
public CompletableFuture<PluginsUpdateResult> update(PluginsUpdateParams params)

Updates an installed plugin to its latest published version.

Since:

1.0.0

updateAll

@CopilotExperimental
public CompletableFuture<PluginsUpdateAllResult> updateAll()

Updates every installed plugin to its latest published version.

Since:

1.0.0

enable

@CopilotExperimental
public CompletableFuture<Void> enable(PluginsEnableParams params)

Enables installed plugins for new sessions.

Since:

1.0.0

disable

@CopilotExperimental
public CompletableFuture<Void> disable(PluginsDisableParams params)

Disables installed plugins for new sessions.

Since:

1.0.0