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)	A tool name and arguments to execute through the session's native invocation pipeline.
CompletableFuture<SessionToolsGetBuiltinDescriptorsResult>	getBuiltinDescriptors(SessionToolsGetBuiltinDescriptorsParams params)	Options controlling how Rust-owned built-in tool descriptors are materialized.
CompletableFuture<SessionToolsGetCurrentMetadataResult>	getCurrentMetadata()	Identifies the target session.
CompletableFuture<SessionToolsHandlePendingToolCallResult>	handlePendingToolCall(SessionToolsHandlePendingToolCallParams params)	Pending external tool call request ID, with the tool result or an error describing why it failed.
CompletableFuture<Void>	initializeAndValidate()	Identifies the target session.
CompletableFuture<Void>	set(SessionToolsSetParams params)	Complete externally implemented tool list for the calling connection.
CompletableFuture<SessionToolsTaskCompleteEventDataResult>	taskCompleteEventData(SessionToolsTaskCompleteEventDataParams params)	Task-completion tool arguments and final result used to build a label-safe session event payload.
CompletableFuture<Void>	updateSubagentSettings(SessionToolsUpdateSubagentSettingsParams params)	Subagent settings to apply to the current session

Methods inherited from class Object

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

Method Details

execute

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

A tool name and arguments to execute through the session's 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)

Options controlling how Rust-owned built-in tool descriptors are materialized.

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)

Task-completion tool arguments and final result used to build a 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)

Pending external tool call request ID, with the tool result or an error describing why it failed.

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

Since:

1.0.0

initializeAndValidate

@CopilotExperimental
public CompletableFuture<Void> initializeAndValidate()

Identifies the target session.

Since:

1.0.0

getCurrentMetadata

@CopilotExperimental
public CompletableFuture<SessionToolsGetCurrentMetadataResult> getCurrentMetadata()

Identifies the target session.

Since:

1.0.0

set

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

Complete externally implemented tool list for the calling connection. An empty list removes every tool previously supplied by that connection.

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)

Subagent settings to apply to the current 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