Class SessionToolsApi

java.lang.Object

com.github.copilot.generated.rpc.SessionToolsApi

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

API methods for the tools namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	execute(SessionToolsExecuteParams params)	Executes one tool from the session's currently offered tool set through the native invocation pipeline.
CompletableFuture<SessionToolsGetBuiltinDescriptorsResult>	getBuiltinDescriptors(SessionToolsGetBuiltinDescriptorsParams params)	Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set.
CompletableFuture<SessionToolsGetCurrentMetadataResult>	getCurrentMetadata()	Returns lightweight metadata for the session's currently initialized tools.
CompletableFuture<SessionToolsHandlePendingToolCallResult>	handlePendingToolCall(SessionToolsHandlePendingToolCallParams params)	Provides the result for a pending external tool call.
CompletableFuture<Void>	initializeAndValidate()	Resolves, builds, and validates the runtime tool list for the session.
CompletableFuture<SessionToolsListPendingRequestsResult>	listPendingRequests()	Lists the external tool calls of the session and its sub-agents that are still waiting for session.tools.handlePendingToolCall.
CompletableFuture<Void>	set(SessionToolsSetParams params)	Atomically replaces the complete externally implemented tool list supplied by the calling connection.
CompletableFuture<SessionToolsTaskCompleteEventDataResult>	taskCompleteEventData(SessionToolsTaskCompleteEventDataParams params)	Projects a completed task_complete tool call into its label-safe session event payload.
CompletableFuture<Void>	updateSubagentSettings(SessionToolsUpdateSubagentSettingsParams params)	Sets the current session's live subagent settings override, which takes precedence over persisted user settings until cleared.

Methods inherited from class Object

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

Method Details

execute

@CopilotExperimental
public CompletableFuture<Void> execute(SessionToolsExecuteParams params)

Executes one tool from the session's currently offered tool set through the native invocation pipeline.

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

Since:

1.0.0

getBuiltinDescriptors

@CopilotExperimental
public CompletableFuture<SessionToolsGetBuiltinDescriptorsResult> getBuiltinDescriptors(SessionToolsGetBuiltinDescriptorsParams params)

Returns the Rust-owned built-in tool descriptors used to construct the session's offered tool set.

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

Since:

1.0.0

taskCompleteEventData

@CopilotExperimental
public CompletableFuture<SessionToolsTaskCompleteEventDataResult> taskCompleteEventData(SessionToolsTaskCompleteEventDataParams params)

Projects a completed task_complete tool call into its label-safe session event payload.

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

Since:

1.0.0

handlePendingToolCall

@CopilotExperimental
public CompletableFuture<SessionToolsHandlePendingToolCallResult> handlePendingToolCall(SessionToolsHandlePendingToolCallParams params)

Provides the result for a pending external tool call.

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

Since:

1.0.0

listPendingRequests

@CopilotExperimental
public CompletableFuture<SessionToolsListPendingRequestsResult> listPendingRequests()

Lists the external tool calls of the session and its sub-agents that are still waiting for session.tools.handlePendingToolCall.

Since:

1.0.0

initializeAndValidate

@CopilotExperimental
public CompletableFuture<Void> initializeAndValidate()

Resolves, builds, and validates the runtime tool list for the session.

Since:

1.0.0

getCurrentMetadata

@CopilotExperimental
public CompletableFuture<SessionToolsGetCurrentMetadataResult> getCurrentMetadata()

Returns lightweight metadata for the session's currently initialized tools.

Since:

1.0.0

set

@CopilotExperimental
public CompletableFuture<Void> set(SessionToolsSetParams params)

Atomically replaces the complete externally implemented tool list supplied by the calling connection. Built-in, MCP/plugin, extension-discovered, subagent, and tools supplied by other connections remain unchanged.

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

Since:

1.0.0

updateSubagentSettings

@CopilotExperimental
public CompletableFuture<Void> updateSubagentSettings(SessionToolsUpdateSubagentSettingsParams params)

Sets the current session's live subagent settings override, which takes precedence over persisted user settings until cleared. Persisted user settings remain the source of truth for future sessions.

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

Since:

1.0.0