copilot-sdk 2.0.0-preview.2

Rust SDK for programmatic control of the GitHub Copilot CLI via JSON-RPC.
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
//! Wire-format structs for the `session.create` and `session.resume`
//! JSON-RPC payloads.
//!
//! Built explicitly from [`CreateSessionOptions`](crate::types::CreateSessionOptions) and
//! [`ResumeSessionOptions`](crate::types::ResumeSessionOptions) at
//! `Client::create_session` / `Client::resume_session` time via
//! [`CreateSessionOptions::into_wire`](crate::types::CreateSessionOptions::into_wire) and
//! [`ResumeSessionOptions::into_wire`](crate::types::ResumeSessionOptions::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 indexmap::IndexMap;
use serde::Serialize;

use crate::canvas::CanvasDeclaration;
use crate::generated::api_types::{
    AutopilotOptions, ModelCapabilitiesOverride, OpenCanvasInstance, RemoteSessionMode,
    SandboxConfig,
};
use crate::generated::session_events::{PermissionMode, ReasoningSummary};
use crate::types::{
    AskUserVariant, CanvasProviderIdentity, CapiSessionOptions, CloudSessionOptions,
    CustomAgentConfig, DefaultAgentConfig, ExtensionInfo, GitHubMcpToolConfig,
    ImageGenerationConfig, InfiniteSessionConfig, LargeToolOutputConfig, McpServerConfig,
    MemoryConfiguration, NamedProviderConfig, ProviderModelConfig, SessionId, SessionLimitsConfig,
    SystemMessageConfig, Tool, ToolSearchConfig, WorkingDirectoryTrust,
};

/// 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,
    /// Always sent. The runtime requires a string, so a command declared
    /// without a description is serialized as `""` rather than omitted.
    pub description: String,
}

/// The exact JSON shape sent on the `session.create` JSON-RPC request.
#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionCreateWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub session_id: Option<SessionId>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[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 system_message: Option<SystemMessageConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub diagnostics: Option<crate::generated::api_types::DiagnosticsConfiguration>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lifecycle_diagnostics:
        Option<crate::generated::api_types::LifecycleDiagnosticsConfiguration>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub working_directory: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remote_session: Option<RemoteSessionMode>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cloud: Option<CloudSessionOptions>,
    pub inference: SessionInferenceWire,
    pub policy: SessionPolicyWire,
    pub events: SessionEventWire,
    pub interaction: SessionInteractionWire,
    pub tools: SessionToolWire,
    pub canvases: SessionCreateCanvasWire,
    pub extensions: SessionExtensionWire,
    pub agents: SessionAgentWire,
    pub mcp: SessionMcpWire,
    pub state: SessionStateWire,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config_directory: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_config_discovery: Option<bool>,
    pub filesystem: SessionCreateFilesystemWire,
    pub instructions: SessionCreateInstructionWire,
    pub hooks: SessionHookWire,
    pub git: SessionGitWire,
    pub skills: SessionSkillWire,
    pub permissions: SessionPermissionWire,
    pub github: SessionGitHubWire,
    pub plugins: SessionPluginWire,
    pub execution: SessionExecutionWire,
    pub experiments: SessionExperimentWire,
}

/// 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 model: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_message: Option<SystemMessageConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub diagnostics: Option<crate::generated::api_types::DiagnosticsConfiguration>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lifecycle_diagnostics:
        Option<crate::generated::api_types::LifecycleDiagnosticsConfiguration>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub working_directory: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remote_session: Option<RemoteSessionMode>,
    #[serde(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>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allow_transcript_recovery: Option<bool>,
    pub inference: SessionInferenceWire,
    pub policy: SessionPolicyWire,
    pub events: SessionEventWire,
    pub interaction: SessionInteractionWire,
    pub tools: SessionToolWire,
    pub canvases: SessionResumeCanvasWire,
    pub extensions: SessionExtensionWire,
    pub agents: SessionAgentWire,
    pub mcp: SessionMcpWire,
    pub state: SessionStateWire,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub config_directory: Option<PathBuf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_config_discovery: Option<bool>,
    pub instructions: SessionResumeInstructionWire,
    pub hooks: SessionHookWire,
    pub git: SessionGitWire,
    pub skills: SessionSkillWire,
    pub permissions: SessionPermissionWire,
    pub github: SessionGitHubWire,
    pub plugins: SessionPluginWire,
    pub filesystem: SessionResumeFilesystemWire,
    pub execution: SessionExecutionWire,
    pub experiments: SessionExperimentWire,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionInferenceWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allow_multiple_tool_calls: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reasoning_effort: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reasoning_summary: Option<ReasoningSummary>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub context_tier: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_provider: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub providers: Option<Vec<NamedProviderConfig>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub models: Option<Vec<ProviderModelConfig>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_citations: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub capabilities: Option<ModelCapabilitiesOverride>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionPolicyWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub allowed_models: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub excluded_managed_settings: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enforce_managed_model_defaults: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub managed_settings: Option<crate::types::ManagedSettings>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionEventWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub streaming: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_sub_agent_streaming_events: Option<bool>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionInteractionWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ask_user_variant: Option<AskUserVariant>,
    pub request_user_input: bool,
    pub request_exit_plan_mode: bool,
    pub request_auto_mode_switch: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_auto_mode_recovery: Option<bool>,
    pub request_elicitation: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_shell_authentication: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commands: Option<Vec<CommandWireDefinition>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionToolWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub definitions: Option<Vec<Tool>>,
    #[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 large_output: Option<LargeToolOutputConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search: Option<ToolSearchConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image_generation: Option<ImageGenerationConfig>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionCreateCanvasWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub definitions: Option<Vec<CanvasDeclaration>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_renderer: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider: Option<CanvasProviderIdentity>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionExtensionWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sdk_path: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub identity: Option<ExtensionInfo>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionAgentWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub excluded_builtin_agents: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub included_builtin_agents: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub directories: Option<Vec<PathBuf>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub definitions: Option<Vec<CustomAgentConfig>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub local_discovery_only: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default: Option<DefaultAgentConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub selected: Option<String>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionMcpWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub servers: Option<IndexMap<String, McpServerConfig>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auth_client_id_metadata_url: Option<String>,
    pub env_value_mode: &'static str,
    pub enable_apps: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disabled_servers: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub oauth_token_storage: Option<String>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionStateWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub embedding_cache_storage: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub skip_embedding_retrieval: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_cross_session_store: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_memory_store: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub infinite_sessions: Option<InfiniteSessionConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryConfiguration>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionCreateFilesystemWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trust_working_directory: Option<WorkingDirectoryTrust>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub track_file_changes: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub additional_directories: Option<Vec<PathBuf>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionCreateInstructionWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub organization_text: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub refresh_custom_instructions: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_demand_discovery: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub directories: Option<Vec<PathBuf>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionHookWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_repository_hooks: Option<bool>,
    pub has_handlers: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub directories: Option<Vec<PathBuf>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionGitWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_host_git_operations: Option<bool>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionSkillWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_provider: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub directories: Option<Vec<PathBuf>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disabled_skills: Option<Vec<String>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionPermissionWire {
    pub request: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sandbox: Option<SandboxConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mode: Option<PermissionMode>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionGitHubWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mcp: Option<GitHubMcpToolConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub capi: Option<CapiSessionOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub telemetry_enabled: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub token: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub token_provider_registration_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fetch_managed_settings: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub interactive_user: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub telemetry_forwarding: Option<bool>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionPluginWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub directories: Option<Vec<PathBuf>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionExecutionWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limits: Option<SessionLimitsConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub autopilot: Option<AutopilotOptions>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionExperimentWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub flags: Option<HashMap<String, bool>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub assignments: Option<crate::types::CopilotExpAssignmentResponse>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enable_experimental_mode: Option<bool>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionResumeCanvasWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub definitions: Option<Vec<CanvasDeclaration>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub open: Option<Vec<OpenCanvasInstance>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_renderer: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub provider: Option<CanvasProviderIdentity>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionResumeInstructionWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub organization_text: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_demand_discovery: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub directories: Option<Vec<PathBuf>>,
}

#[derive(Debug, Serialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct SessionResumeFilesystemWire {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub track_file_changes: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub additional_directories: Option<Vec<PathBuf>>,
}