github-copilot-sdk 1.0.1

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
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
use std::collections::HashMap;
use std::path::Path;

use github_copilot_sdk::rpc::{
    McpConfigureGitHubResult, McpIsServerRunningRequest, McpListToolsRequest,
    McpStartServersResult, McpStopServerRequest,
};
use github_copilot_sdk::session::Session;
use github_copilot_sdk::session_events::McpServerStatus;
use github_copilot_sdk::{Error, McpServerConfig, McpStdioServerConfig};
use serde::de::DeserializeOwned;
use serde_json::{Value, json};

use super::support::{wait_for_condition, with_e2e_context};

#[tokio::test]
async fn should_list_tools_and_report_running_status_for_connected_server() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_list_tools_and_report_running_status_for_connected_server",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let server_name = "rpc-lifecycle-list-server";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), server_name),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await;

                let tools = session
                    .rpc()
                    .mcp()
                    .list_tools(McpListToolsRequest {
                        server_name: server_name.to_string(),
                    })
                    .await
                    .expect("list MCP tools");
                assert!(!tools.tools.is_empty());
                assert!(tools.tools.iter().all(|tool| !tool.name.trim().is_empty()));

                assert!(is_mcp_server_running(&session, server_name).await);
                assert!(
                    !is_mcp_server_running(
                        &session,
                        &format!("missing-{}", uuid::Uuid::new_v4().simple())
                    )
                    .await
                );

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_throw_when_listing_tools_for_unconnected_server() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_throw_when_listing_tools_for_unconnected_server",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let server_name = "rpc-lifecycle-unconnected-host";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), server_name),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await;

                let err = session
                    .rpc()
                    .mcp()
                    .list_tools(McpListToolsRequest {
                        server_name: format!("missing-{}", uuid::Uuid::new_v4().simple()),
                    })
                    .await
                    .expect_err("missing server should fail");
                assert_error_contains(&err, "not connected");

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_stop_running_mcp_server() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_stop_running_mcp_server",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let server_name = "rpc-lifecycle-stop-server";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), server_name),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await;
                assert!(is_mcp_server_running(&session, server_name).await);

                session
                    .rpc()
                    .mcp()
                    .stop_server(McpStopServerRequest {
                        server_name: server_name.to_string(),
                    })
                    .await
                    .expect("stop MCP server");

                wait_for_mcp_running(&session, server_name, false).await;

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_start_and_restart_mcp_server() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_start_and_restart_mcp_server",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let host_server = "rpc-lifecycle-host-server";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), host_server),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await;

                let started_server = "rpc-lifecycle-started-server";
                let config = test_mcp_server_config(ctx.repo_root());
                let config_value = serde_json::to_value(&config).expect("serialize MCP config");
                call_session_rpc(
                    &session,
                    "session.mcp.startServer",
                    json!({ "serverName": started_server, "config": config_value }),
                )
                .await
                .expect("start MCP server");
                wait_for_mcp_running(&session, started_server, true).await;

                let tools = session
                    .rpc()
                    .mcp()
                    .list_tools(McpListToolsRequest {
                        server_name: started_server.to_string(),
                    })
                    .await
                    .expect("list started MCP tools");
                assert!(!tools.tools.is_empty());

                let config_value = serde_json::to_value(&config).expect("serialize MCP config");
                call_session_rpc(
                    &session,
                    "session.mcp.restartServer",
                    json!({ "serverName": started_server, "config": config_value }),
                )
                .await
                .expect("restart MCP server");
                wait_for_mcp_running(&session, started_server, true).await;

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_register_and_unregister_external_mcp_client() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_register_and_unregister_external_mcp_client",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let host_server = "rpc-lifecycle-extclient-host";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), host_server),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await;

                let external_name = "rpc-lifecycle-external-client";
                assert!(!is_mcp_server_running(&session, external_name).await);

                call_session_rpc(
                    &session,
                    "session.mcp.registerExternalClient",
                    json!({
                        "serverName": external_name,
                        "client": { "id": external_name },
                        "transport": { "kind": "in-process" },
                        "config": { "command": "noop" }
                    }),
                )
                .await
                .expect("register external MCP client");
                assert!(is_mcp_server_running(&session, external_name).await);

                call_session_rpc(
                    &session,
                    "session.mcp.unregisterExternalClient",
                    json!({ "serverName": external_name }),
                )
                .await
                .expect("unregister external MCP client");
                assert!(!is_mcp_server_running(&session, external_name).await);

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_reload_mcp_servers_with_config() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_reload_mcp_servers_with_config",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let host_server = "rpc-lifecycle-reload-host";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), host_server),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await;

                let result: McpStartServersResult = call_session_rpc_typed(
                    &session,
                    "session.mcp.reloadWithConfig",
                    json!({
                        "config": {
                            "mcpServers": {},
                            "disabledServers": []
                        }
                    }),
                )
                .await
                .expect("reload MCP with config");

                assert!(result.filtered_servers.is_empty());

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_configure_github_mcp_server() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_configure_github_mcp_server",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let host_server = "rpc-lifecycle-configure-host";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), host_server),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await;

                let result: McpConfigureGitHubResult = call_session_rpc_typed(
                    &session,
                    "session.mcp.configureGitHub",
                    json!({ "authInfo": { "type": "api-key" } }),
                )
                .await
                .expect("configure GitHub MCP");

                assert!(!result.changed);

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

#[tokio::test]
async fn should_respond_to_mcp_oauth_request_without_pending_request() {
    with_e2e_context(
        "rpc_mcp_lifecycle",
        "should_respond_to_mcp_oauth_request_without_pending_request",
        |ctx| {
            Box::pin(async move {
                ctx.set_default_copilot_user();
                let host_server = "rpc-lifecycle-oauth-host";
                let client = ctx.start_client().await;
                let session =
                    client
                        .create_session(ctx.approve_all_session_config().with_mcp_servers(
                            create_test_mcp_servers(ctx.repo_root(), host_server),
                        ))
                        .await
                        .expect("create session");
                wait_for_mcp_server_status(&session, host_server, McpServerStatus::Connected).await;

                let result = call_session_rpc(
                    &session,
                    "session.mcp.oauth.respond",
                    json!({
                        "requestId": format!("missing-{}", uuid::Uuid::new_v4().simple())
                    }),
                )
                .await
                .expect("respond to missing MCP OAuth request");
                assert!(result.is_object());

                session.disconnect().await.expect("disconnect session");
                client.stop().await.expect("stop client");
            })
        },
    )
    .await;
}

fn create_test_mcp_servers(
    repo_root: &Path,
    server_name: &str,
) -> HashMap<String, McpServerConfig> {
    HashMap::from([(server_name.to_string(), test_mcp_server_config(repo_root))])
}

fn test_mcp_server_config(repo_root: &Path) -> McpServerConfig {
    let harness_dir = repo_root.join("test").join("harness");
    let server_path = harness_dir
        .join("test-mcp-server.mjs")
        .to_string_lossy()
        .to_string();
    McpServerConfig::Stdio(McpStdioServerConfig {
        tools: Some(vec!["*".to_string()]),
        command: if cfg!(windows) {
            "node.exe".to_string()
        } else {
            "node".to_string()
        },
        args: vec![server_path],
        working_directory: Some(harness_dir.to_string_lossy().to_string()),
        ..McpStdioServerConfig::default()
    })
}

async fn wait_for_mcp_server_status(
    session: &Session,
    server_name: &str,
    expected_status: McpServerStatus,
) {
    wait_for_condition("MCP server status", || async {
        session
            .rpc()
            .mcp()
            .list()
            .await
            .expect("list MCP servers")
            .servers
            .iter()
            .any(|server| server.name == server_name && server.status == expected_status)
    })
    .await;
}

async fn wait_for_mcp_running(session: &Session, server_name: &str, expected_running: bool) {
    wait_for_condition("MCP server running state", || async {
        is_mcp_server_running(session, server_name).await == expected_running
    })
    .await;
}

async fn is_mcp_server_running(session: &Session, server_name: &str) -> bool {
    session
        .rpc()
        .mcp()
        .is_server_running(McpIsServerRunningRequest {
            server_name: server_name.to_string(),
        })
        .await
        .expect("check MCP running")
        .running
}

async fn call_session_rpc(
    session: &Session,
    method: &'static str,
    mut params: Value,
) -> Result<Value, Error> {
    params["sessionId"] = json!(session.id());
    session.client().call(method, Some(params)).await
}

async fn call_session_rpc_typed<T: DeserializeOwned>(
    session: &Session,
    method: &'static str,
    params: Value,
) -> Result<T, Error> {
    let value = call_session_rpc(session, method, params).await?;
    Ok(serde_json::from_value(value)?)
}

fn assert_error_contains(err: &Error, expected: &str) {
    let message = err.to_string();
    assert!(
        !message.to_ascii_lowercase().contains("unhandled method"),
        "{message}"
    );
    assert!(
        message
            .to_ascii_lowercase()
            .contains(&expected.to_ascii_lowercase()),
        "expected error to contain {expected:?}, got {message}"
    );
}