Class SessionMcpApi

java.lang.Object

com.github.copilot.generated.rpc.SessionMcpApi

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

API methods for the mcp namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final SessionMcpAppsApi	apps	API methods for the mcp.apps sub-namespace.
final SessionMcpOauthApi	oauth	API methods for the mcp.oauth sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionMcpCancelSamplingExecutionResult>	cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params)	The requestId previously passed to executeSampling that should be cancelled.
CompletableFuture<SessionMcpConfigureGitHubResult>	configureGitHub(SessionMcpConfigureGitHubParams params)	Opaque auth info used to configure GitHub MCP.
CompletableFuture<Void>	disable(SessionMcpDisableParams params)	Name of the MCP server to disable for the session.
CompletableFuture<Void>	enable(SessionMcpEnableParams params)	Name of the MCP server to enable for the session.
CompletableFuture<SessionMcpExecuteSamplingResult>	executeSampling(SessionMcpExecuteSamplingParams params)	Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.
CompletableFuture<SessionMcpIsServerRunningResult>	isServerRunning(SessionMcpIsServerRunningParams params)	Server name to check running status for.
CompletableFuture<SessionMcpListResult>	list()	Identifies the target session.
CompletableFuture<SessionMcpListToolsResult>	listTools(SessionMcpListToolsParams params)	Server name whose tool list should be returned.
CompletableFuture<Void>	registerExternalClient(SessionMcpRegisterExternalClientParams params)	Registration parameters for an external MCP client.
CompletableFuture<Void>	reload()	Identifies the target session.
CompletableFuture<SessionMcpReloadWithConfigResult>	reloadWithConfig(SessionMcpReloadWithConfigParams params)	Opaque MCP reload configuration.
CompletableFuture<SessionMcpRemoveGitHubResult>	removeGitHub()	Identifies the target session.
CompletableFuture<Void>	restartServer(SessionMcpRestartServerParams params)	Server name and opaque configuration for an individual MCP server restart.
CompletableFuture<SessionMcpSetEnvValueModeResult>	setEnvValueMode(SessionMcpSetEnvValueModeParams params)	Mode controlling how MCP server env values are resolved (`direct` or `indirect`).
CompletableFuture<Void>	startServer(SessionMcpStartServerParams params)	Server name and opaque configuration for an individual MCP server start.
CompletableFuture<Void>	stopServer(SessionMcpStopServerParams params)	Server name for an individual MCP server stop.
CompletableFuture<Void>	unregisterExternalClient(SessionMcpUnregisterExternalClientParams params)	Server name identifying the external client to remove.

Methods inherited from class Object

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

Field Details

oauth

public final SessionMcpOauthApi oauth

API methods for the mcp.oauth sub-namespace.

apps

public final SessionMcpAppsApi apps

API methods for the mcp.apps sub-namespace.

Method Details

list

@CopilotExperimental
public CompletableFuture<SessionMcpListResult> list()

Identifies the target session.

Since:

1.0.0

listTools

@CopilotExperimental
public CompletableFuture<SessionMcpListToolsResult> listTools(SessionMcpListToolsParams params)

Server name whose tool list should be returned.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

enable

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

Name of the MCP server to enable for the session.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

disable

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

Name of the MCP server to disable for the session.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

reload

@CopilotExperimental
public CompletableFuture<Void> reload()

Identifies the target session.

Since:

1.0.0

reloadWithConfig

@CopilotExperimental
public CompletableFuture<SessionMcpReloadWithConfigResult> reloadWithConfig(SessionMcpReloadWithConfigParams params)

Opaque MCP reload configuration.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

executeSampling

@CopilotExperimental
public CompletableFuture<SessionMcpExecuteSamplingResult> executeSampling(SessionMcpExecuteSamplingParams params)

Identifiers and raw MCP CreateMessageRequest params used to run a sampling inference.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

cancelSamplingExecution

@CopilotExperimental
public CompletableFuture<SessionMcpCancelSamplingExecutionResult> cancelSamplingExecution(SessionMcpCancelSamplingExecutionParams params)

The requestId previously passed to executeSampling that should be cancelled.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

setEnvValueMode

@CopilotExperimental
public CompletableFuture<SessionMcpSetEnvValueModeResult> setEnvValueMode(SessionMcpSetEnvValueModeParams params)

Mode controlling how MCP server env values are resolved (`direct` or `indirect`).

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

removeGitHub

@CopilotExperimental
public CompletableFuture<SessionMcpRemoveGitHubResult> removeGitHub()

Identifies the target session.

Since:

1.0.0

configureGitHub

@CopilotExperimental
public CompletableFuture<SessionMcpConfigureGitHubResult> configureGitHub(SessionMcpConfigureGitHubParams params)

Opaque auth info used to configure GitHub MCP.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

startServer

@CopilotExperimental
public CompletableFuture<Void> startServer(SessionMcpStartServerParams params)

Server name and opaque configuration for an individual MCP server start.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

restartServer

@CopilotExperimental
public CompletableFuture<Void> restartServer(SessionMcpRestartServerParams params)

Server name and opaque configuration for an individual MCP server restart.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

stopServer

@CopilotExperimental
public CompletableFuture<Void> stopServer(SessionMcpStopServerParams params)

Server name for an individual MCP server stop.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

registerExternalClient

@CopilotExperimental
public CompletableFuture<Void> registerExternalClient(SessionMcpRegisterExternalClientParams params)

Registration parameters for an external MCP client.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

unregisterExternalClient

@CopilotExperimental
public CompletableFuture<Void> unregisterExternalClient(SessionMcpUnregisterExternalClientParams params)

Server name identifying the external client to remove.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

isServerRunning

@CopilotExperimental
public CompletableFuture<SessionMcpIsServerRunningResult> isServerRunning(SessionMcpIsServerRunningParams params)

Server name to check running status for.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0