Class ServerMcpApi

java.lang.Object

com.github.copilot.generated.rpc.ServerMcpApi

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

API methods for the mcp namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final ServerMcpConfigApi	config	API methods for the mcp.config sub-namespace.
final ServerMcpInstallationsApi	installations	API methods for the mcp.installations sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<McpInstallationResult>	applyInstall(McpApplyInstallParams params)	Applies exactly one previously prepared operation on its original connection.
CompletableFuture<McpInstallationResult>	applyUninstall(McpApplyUninstallParams params)	One-use application of the exact retained removal plan.
CompletableFuture<McpDiscoverResult>	discover(McpDiscoverParams params)	Optional working directory used as context for MCP server discovery.
CompletableFuture<McpPlanInstallResult>	planInstall(McpPlanInstallParams params)	A side-effect-free request for an MCP install plan.
CompletableFuture<McpPlanInstallResult>	planInstall(McpPlanInstallRequest request)	A side-effect-free request for an MCP install plan.
CompletableFuture<McpInstallationManagementResult>	planUninstall(McpPlanUninstallParams params)	Read-only preparation of one owned removal under fresh selected-session authority.
CompletableFuture<McpInstallationManagementResult>	prepareInstall(McpPrepareInstallParams params)	Side-effect-free preparation of one original bound remote MCP choice.

Methods inherited from class Object

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

Field Details

config

public final ServerMcpConfigApi config

API methods for the mcp.config sub-namespace.

installations

public final ServerMcpInstallationsApi installations

API methods for the mcp.installations sub-namespace.

Method Details

discover

@CopilotExperimental
public CompletableFuture<McpDiscoverResult> discover(McpDiscoverParams params)

Optional working directory used as context for MCP server discovery.

Since:

1.0.0

planInstall

@CopilotExperimental
public CompletableFuture<McpPlanInstallResult> planInstall(McpPlanInstallParams params)

A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers.

Since:

1.0.0

planInstall

@CopilotExperimental
public CompletableFuture<McpPlanInstallResult> planInstall(McpPlanInstallRequest request)

A side-effect-free request for an MCP install plan. Computing a plan never writes configuration, stores a secret, or reloads MCP servers.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0

prepareInstall

@CopilotExperimental
public CompletableFuture<McpInstallationManagementResult> prepareInstall(McpPrepareInstallParams params)

Side-effect-free preparation of one original bound remote MCP choice.

Since:

1.0.0

applyInstall

@CopilotExperimental
public CompletableFuture<McpInstallationResult> applyInstall(McpApplyInstallParams params)

Applies exactly one previously prepared operation on its original connection.

Since:

1.0.0

planUninstall

@CopilotExperimental
public CompletableFuture<McpInstallationManagementResult> planUninstall(McpPlanUninstallParams params)

Read-only preparation of one owned removal under fresh selected-session authority.

Since:

1.0.0

applyUninstall

@CopilotExperimental
public CompletableFuture<McpInstallationResult> applyUninstall(McpApplyUninstallParams params)

One-use application of the exact retained removal plan.

Since:

1.0.0