Class ServerRpc

java.lang.Object

com.github.copilot.generated.rpc.ServerRpc

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

Typed client for server-level RPC methods.

Provides strongly-typed access to all server-level API namespaces.

Obtain an instance by calling new ServerRpc(caller).

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final ServerAccountApi	account	API methods for the account namespace.
final ServerAgentRegistryApi	agentRegistry	API methods for the agentRegistry namespace.
final ServerAgentsApi	agents	API methods for the agents namespace.
final ServerInstructionsApi	instructions	API methods for the instructions namespace.
final ServerMcpApi	mcp	API methods for the mcp namespace.
final ServerModelsApi	models	API methods for the models namespace.
final ServerPluginsApi	plugins	API methods for the plugins namespace.
final ServerRuntimeApi	runtime	API methods for the runtime namespace.
final ServerSecretsApi	secrets	API methods for the secrets namespace.
final ServerSessionFsApi	sessionFs	API methods for the sessionFs namespace.
final ServerSessionsApi	sessions	API methods for the sessions namespace.
final ServerSkillsApi	skills	API methods for the skills namespace.
final ServerToolsApi	tools	API methods for the tools namespace.
final ServerUserApi	user	API methods for the user namespace.

Constructor Summary

Constructors

Constructor	Description
ServerRpc(RpcCaller caller)	Creates a new server RPC client.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<ConnectResult>	connect(ConnectParams params)	Optional connection token presented by the SDK client during the handshake.
CompletableFuture<PingResult>	ping(PingParams params)	Optional message to echo back to the caller.

Methods inherited from class Object

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

Field Details

models

public final ServerModelsApi models

API methods for the models namespace.

tools

public final ServerToolsApi tools

API methods for the tools namespace.

account

public final ServerAccountApi account

API methods for the account namespace.

secrets

public final ServerSecretsApi secrets

API methods for the secrets namespace.

mcp

public final ServerMcpApi mcp

API methods for the mcp namespace.

plugins

public final ServerPluginsApi plugins

API methods for the plugins namespace.

skills

public final ServerSkillsApi skills

API methods for the skills namespace.

agents

public final ServerAgentsApi agents

API methods for the agents namespace.

instructions

public final ServerInstructionsApi instructions

API methods for the instructions namespace.

user

public final ServerUserApi user

API methods for the user namespace.

runtime

public final ServerRuntimeApi runtime

API methods for the runtime namespace.

sessionFs

public final ServerSessionFsApi sessionFs

API methods for the sessionFs namespace.

sessions

public final ServerSessionsApi sessions

API methods for the sessions namespace.

agentRegistry

public final ServerAgentRegistryApi agentRegistry

API methods for the agentRegistry namespace.

Constructor Details

ServerRpc

public ServerRpc(RpcCaller caller)

Creates a new server RPC client.

Parameters:

caller - the RPC transport function (e.g., jsonRpcClient::invoke)

Method Details

ping

public CompletableFuture<PingResult> ping(PingParams params)

Optional message to echo back to the caller.

Since:

1.0.0

connect

public CompletableFuture<ConnectResult> connect(ConnectParams params)

Optional connection token presented by the SDK client during the handshake.

Since:

1.0.0