github-copilot-sdk 1.0.0-beta.7

Rust SDK for programmatic control of the GitHub Copilot CLI via JSON-RPC. Technical preview, pre-1.0.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

//! Wire-format structs for the `session.create` and `session.resume`
//! JSON-RPC payloads.
//!
//! Built explicitly from [`SessionConfig`](crate::types::SessionConfig) and
//! [`ResumeSessionConfig`](crate::types::ResumeSessionConfig) at
//! `Client::create_session` / `Client::resume_session` time via
//! [`SessionConfig::into_wire`](crate::types::SessionConfig::into_wire) and
//! [`ResumeSessionConfig::into_wire`](crate::types::ResumeSessionConfig::into_wire),
//! respectively.
//!
//! Keeping the wire shape separate from the user-facing config avoids
//! having callback fields on a serializable struct: the user-facing
//! configs hold trait-object handlers, the wire structs hold only the
//! plain data the runtime needs.

use std::collections::HashMap;
use std::path::PathBuf;

use serde::Serialize;

use crate::canvas::CanvasDeclaration;
use crate::generated::api_types::{
    ModelCapabilitiesOverride, OpenCanvasInstance, RemoteSessionMode,
};
use crate::types::{
    CloudSessionOptions, CustomAgentConfig, DefaultAgentConfig, ExtensionInfo,
    InfiniteSessionConfig, McpServerConfig, ProviderConfig, SessionId, SystemMessageConfig, Tool,
};

/// Wire representation of a slash command (name + description only). The
/// runtime executes the command; the SDK's `CommandHandler` callback is
/// invoked from a separate dispatch path and never crosses the wire.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct CommandWireDefinition {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// The exact JSON shape sent on the `session.create` JSON-RPC request.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionCreateWire {
    pub session_id: SessionId,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reasoning_effort: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub streaming: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_message: Option<SystemMessageConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tools: Option<Vec<Tool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub canvases: Option<Vec<CanvasDeclaration>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_canvas_renderer: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_extensions: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extension_info: Option<ExtensionInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub available_tools: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub excluded_tools: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mcp_servers: Option<HashMap<String, McpServerConfig>>,
    pub env_value_mode: &'static str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_config_discovery: Option<bool>,
    pub request_user_input: bool,
    pub request_permission: bool,
    pub request_exit_plan_mode: bool,
    pub request_auto_mode_switch: bool,
    pub request_elicitation: bool,
    pub hooks: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub skill_directories: Option<Vec<PathBuf>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub instruction_directories: Option<Vec<PathBuf>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disabled_skills: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_agents: Option<Vec<CustomAgentConfig>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_agent: Option<DefaultAgentConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub agent: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub infinite_sessions: Option<InfiniteSessionConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider: Option<ProviderConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_session_telemetry: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model_capabilities: Option<ModelCapabilitiesOverride>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config_dir: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub working_directory: Option<PathBuf>,
    #[serde(rename = "gitHubToken", skip_serializing_if = "Option::is_none")]
    pub github_token: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remote_session: Option<RemoteSessionMode>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cloud: Option<CloudSessionOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_sub_agent_streaming_events: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commands: Option<Vec<CommandWireDefinition>>,
}

/// The exact JSON shape sent on the `session.resume` JSON-RPC request.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionResumeWire {
    pub session_id: SessionId,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reasoning_effort: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub streaming: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_message: Option<SystemMessageConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tools: Option<Vec<Tool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub canvases: Option<Vec<CanvasDeclaration>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub open_canvases: Option<Vec<OpenCanvasInstance>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_canvas_renderer: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_extensions: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extension_info: Option<ExtensionInfo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub available_tools: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub excluded_tools: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mcp_servers: Option<HashMap<String, McpServerConfig>>,
    pub env_value_mode: &'static str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_config_discovery: Option<bool>,
    pub request_user_input: bool,
    pub request_permission: bool,
    pub request_exit_plan_mode: bool,
    pub request_auto_mode_switch: bool,
    pub request_elicitation: bool,
    pub hooks: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub skill_directories: Option<Vec<PathBuf>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub instruction_directories: Option<Vec<PathBuf>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disabled_skills: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_agents: Option<Vec<CustomAgentConfig>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_agent: Option<DefaultAgentConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub agent: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub infinite_sessions: Option<InfiniteSessionConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider: Option<ProviderConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_session_telemetry: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model_capabilities: Option<ModelCapabilitiesOverride>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config_dir: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub working_directory: Option<PathBuf>,
    #[serde(rename = "gitHubToken", skip_serializing_if = "Option::is_none")]
    pub github_token: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remote_session: Option<RemoteSessionMode>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_sub_agent_streaming_events: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commands: Option<Vec<CommandWireDefinition>>,
    /// Maps to wire field `disableResume`.
    #[serde(rename = "disableResume", skip_serializing_if = "Option::is_none")]
    pub suppress_resume_event: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub continue_pending_work: Option<bool>,
}