README

colmugx/acp/protocol/session does not have a README file

#
CancelParams

pub(all) struct CancelParams {
session_id : String
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

Parameters for the session/cancel notification.

#
CloseSessionParams

pub(all) struct CloseSessionParams {
session_id : String
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

Parameters for session/close.

#
CloseSessionResult

Result of session/close.

#
DeleteSessionParams

pub(all) struct DeleteSessionParams {
session_id : String
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

Parameters for session/delete.

#
DeleteSessionResult

Result of session/delete.

#
ListSessionsResult

Result of session/list.

#
LoadSessionParams

pub(all) struct LoadSessionParams {
mcp_servers : Array[
McpServer
]
cwd : String
additional_directories :
ProtocolNullable
[Array[String]]
session_id : String
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

Parameters for session/load.

#
LoadSessionResult

Result of session/load.

The runtime must replay the restored history after this result is accepted. The codec deliberately carries no storage or replay state.

#
NewSessionParams

Parameters for session/new.

#
PromptParams

Parameters for session/prompt.

#
PromptResult

Result of session/prompt.

#
ResumeSessionParams

Parameters for session/resume.

#
ResumeSessionResult

Result of session/resume.

Unlike LoadSessionResult, accepting this result must not replay history. The distinction is represented by the wire type and not by hidden state.

#
SessionConfigValue

pub(all) enum SessionConfigValue {
Boolean(Bool)
ValueId(String)
} derive(Eq,
Debug
)

A value accepted by session/set_config_option.

#
SessionMode

pub(all) struct SessionMode {
id : String
name : String
description :
ProtocolNullable
[String]
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

One mode available for a session.

#
SessionModeState

pub(all) struct SessionModeState {
current_mode_id : String
available_modes : Array[SessionMode]
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

The current mode and the complete set of modes available to a session.

#
SessionUpdateParams

Parameters for the session/update notification.

#
SetSessionConfigOptionParams

pub(all) struct SetSessionConfigOptionParams {
session_id : String
config_id : String
value : SessionConfigValue
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

Parameters for session/set_config_option.

#
SetSessionConfigOptionResult

Result of session/set_config_option.

#
SetSessionModeParams

pub(all) struct SetSessionModeParams {
session_id : String
mode_id : String
meta :
ProtocolNullable
[Json]
} derive(Eq,
Debug
)

Parameters for session/set_mode.

#
SetSessionModeResult

Result of session/set_mode.

#
StopReason

pub(all) enum StopReason {
EndTurn
MaxTokens
MaxTurnRequests
Refusal
Cancelled
} derive(Eq,
Debug
)

Why an agent stopped processing one prompt turn.

#
cancel_params_from_json

fn cancel_params_from_json(value : Json, path? : String) -> CancelParams raise
ProtocolDecodeError

Decode session/cancel notification parameters.

#
cancel_params_to_json

Encode session/cancel notification parameters.

#
close_session_params_from_json

fn close_session_params_from_json(value : Json, path? : String) -> CloseSessionParams raise
ProtocolDecodeError

Decode session/close parameters.

#
close_session_params_to_json

Encode session/close parameters.

#
close_session_result_from_json

fn close_session_result_from_json(value : Json, path? : String) -> CloseSessionResult raise
ProtocolDecodeError

Decode the result of session/close.

#
close_session_result_to_json

Encode the result of session/close.

#
delete_session_params_from_json

fn delete_session_params_from_json(value : Json, path? : String) -> DeleteSessionParams raise
ProtocolDecodeError

Decode session/delete parameters.

#
delete_session_params_to_json

Encode session/delete parameters.

#
delete_session_result_from_json

fn delete_session_result_from_json(value : Json, path? : String) -> DeleteSessionResult raise
ProtocolDecodeError

Decode the result of session/delete.

#
delete_session_result_to_json

Encode the result of session/delete.

#
list_sessions_params_from_json

fn list_sessions_params_from_json(value : Json, path? : String) -> ListSessionsParams raise
ProtocolDecodeError

Decode session/list parameters.

#
list_sessions_params_to_json

Encode session/list parameters.

#
list_sessions_result_from_json

fn list_sessions_result_from_json(value : Json, path? : String) -> ListSessionsResult raise
ProtocolDecodeError

Decode the result of session/list.

#
list_sessions_result_to_json

Encode the result of session/list.

#
load_session_params_from_json

fn load_session_params_from_json(value : Json, path? : String) -> LoadSessionParams raise
ProtocolDecodeError

Decode session/load parameters.

#
load_session_params_to_json

Encode session/load parameters.

#
load_session_result_from_json

fn load_session_result_from_json(value : Json, path? : String) -> LoadSessionResult raise
ProtocolDecodeError

Decode the result of session/load.

#
load_session_result_to_json

Encode the result of session/load.

#
new_session_params_from_json

fn new_session_params_from_json(value : Json, path? : String) -> NewSessionParams raise
ProtocolDecodeError

Decode session/new parameters.

#
new_session_params_to_json

Encode session/new parameters.

#
new_session_result_from_json

fn new_session_result_from_json(value : Json, path? : String) -> NewSessionResult raise
ProtocolDecodeError

Decode the result of session/new.

#
new_session_result_to_json

Encode the result of session/new.

#
prompt_params_from_json

fn prompt_params_from_json(value : Json, path? : String) -> PromptParams raise
ProtocolDecodeError

Decode session/prompt parameters.

#
prompt_params_to_json

Encode session/prompt parameters.

#
prompt_result_from_json

fn prompt_result_from_json(value : Json, path? : String) -> PromptResult raise
ProtocolDecodeError

Decode the result of session/prompt.

#
prompt_result_to_json

Encode the result of session/prompt.

#
resume_session_params_from_json

fn resume_session_params_from_json(value : Json, path? : String) -> ResumeSessionParams raise
ProtocolDecodeError

Decode session/resume parameters.

#
resume_session_params_to_json

Encode session/resume parameters.

#
resume_session_result_from_json

fn resume_session_result_from_json(value : Json, path? : String) -> ResumeSessionResult raise
ProtocolDecodeError

Decode the result of session/resume.

#
resume_session_result_to_json

Encode the result of session/resume.

#
session_mode_from_json

fn session_mode_from_json(value : Json, path? : String) -> SessionMode raise
ProtocolDecodeError

Decode one session mode.

#
session_mode_state_from_json

fn session_mode_state_from_json(value : Json, path? : String) -> SessionModeState raise
ProtocolDecodeError

Decode the mode state returned by session lifecycle methods.

#
session_mode_state_to_json

Encode the mode state returned by session lifecycle methods.

#
session_mode_to_json

Encode one session mode.

#
session_update_params_from_json

fn session_update_params_from_json(value : Json, path? : String) -> SessionUpdateParams raise
ProtocolDecodeError

Decode session/update notification parameters.

#
session_update_params_to_json

Encode session/update notification parameters.

#
set_session_config_option_params_from_json

fn set_session_config_option_params_from_json(value : Json, path? : String) -> SetSessionConfigOptionParams raise
ProtocolDecodeError

Decode session/set_config_option parameters.

#
set_session_config_option_params_to_json

fn set_session_config_option_params_to_json(value : SetSessionConfigOptionParams) -> Json raise
ProtocolDecodeError

Encode session/set_config_option parameters.

#
set_session_config_option_result_from_json

fn set_session_config_option_result_from_json(value : Json, path? : String) -> SetSessionConfigOptionResult raise
ProtocolDecodeError

Decode the result of session/set_config_option.

#
set_session_config_option_result_to_json

fn set_session_config_option_result_to_json(value : SetSessionConfigOptionResult) -> Json raise
ProtocolDecodeError

Encode the result of session/set_config_option.

#
set_session_mode_params_from_json

fn set_session_mode_params_from_json(value : Json, path? : String) -> SetSessionModeParams raise
ProtocolDecodeError

Decode session/set_mode parameters.

#
set_session_mode_params_to_json

Encode session/set_mode parameters.

#
set_session_mode_result_from_json

fn set_session_mode_result_from_json(value : Json, path? : String) -> SetSessionModeResult raise
ProtocolDecodeError

Decode the result of session/set_mode.

#
set_session_mode_result_to_json

Encode the result of session/set_mode.