github-copilot-sdk 1.0.5

Rust SDK for programmatic control of the GitHub Copilot CLI via JSON-RPC.
Documentation
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
use std::collections::HashMap;
use std::path::PathBuf;
use std::process::Stdio;
use std::sync::Arc;

use async_trait::async_trait;
use github_copilot_sdk::handler::{McpAuthHandler, McpAuthRequest, McpAuthResult};
use github_copilot_sdk::rpc::{McpAppsCallToolRequest, McpListToolsRequest};
use github_copilot_sdk::session::Session;
use github_copilot_sdk::session_events::{McpOauthRequestReason, McpServerStatus};
use github_copilot_sdk::{McpHttpServerConfig, McpServerConfig, RequestId, SessionId};
use parking_lot::Mutex;
use serde::Deserialize;
use serde_json::Value;
use tokio::io::{AsyncBufReadExt, BufReader};
use tokio::process::{Child, Command};

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

const EXPECTED_TOKEN: &str = "sdk-host-token";
const REFRESH_TOKEN: &str = "sdk-host-token-refresh";
const UPSCOPE_TOKEN: &str = "sdk-host-token-upscope";
const REAUTH_TOKEN: &str = "sdk-host-token-reauth";

#[tokio::test]
async fn should_satisfy_mcp_oauth_using_host_provided_token() {
    with_e2e_context_no_snapshot(|ctx| {
        Box::pin(async move {
            ctx.set_default_copilot_user();
            let mut oauth_server = OAuthMcpServer::start(
                ctx.repo_root()
                    .join("test/harness/test-mcp-oauth-server.mjs"),
            )
            .await;
            let server_name = "oauth-protected-mcp";
            let handler = Arc::new(TokenAuthHandler::default());
            let client = ctx.start_client().await;
            let session = client
                .create_session(
                    ctx.approve_all_session_config()
                        .with_mcp_auth_handler(handler.clone())
                        .with_mcp_servers(HashMap::from([(
                            server_name.to_string(),
                            McpServerConfig::Http(McpHttpServerConfig {
                                tools: Some(vec!["*".to_string()]),
                                timeout: None,
                                url: format!("{}/mcp", oauth_server.url),
                                headers: HashMap::new(),
                            }),
                        )])),
                )
                .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.iter().any(|tool| tool.name == "whoami"));

            let request = handler
                .request
                .lock()
                .clone()
                .expect("MCP auth handler should be invoked");
            assert_eq!(request.server_name, server_name);
            assert_eq!(request.server_url, format!("{}/mcp", oauth_server.url));
            assert_eq!(request.reason, McpOauthRequestReason::Initial);
            let www_authenticate = request
                .www_authenticate_params
                .expect("WWW-Authenticate params");
            assert_eq!(
                www_authenticate.resource_metadata_url,
                Some(format!(
                    "{}/.well-known/oauth-protected-resource",
                    oauth_server.url
                ))
            );
            assert_eq!(www_authenticate.scope.as_deref(), Some("mcp.read"));
            assert_eq!(www_authenticate.error.as_deref(), Some("invalid_token"));
            let metadata: Value = serde_json::from_str(
                request
                    .resource_metadata
                    .as_deref()
                    .expect("resource metadata"),
            )
            .expect("parse resource metadata");
            assert_eq!(metadata["resource"], format!("{}/mcp", oauth_server.url));

            let requests = oauth_server.requests().await;
            assert!(
                requests
                    .iter()
                    .any(|request| request.authorization.is_none())
            );
            assert!(
                requests.iter().any(
                    |request| request.authorization.as_deref() == Some("Bearer sdk-host-token")
                )
            );

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

#[tokio::test]
async fn should_request_replacement_tokens_across_mcp_oauth_lifecycle() {
    with_e2e_context_no_snapshot(|ctx| {
        Box::pin(async move {
            ctx.set_default_copilot_user();
            let mut oauth_server = OAuthMcpServer::start(
                ctx.repo_root()
                    .join("test/harness/test-mcp-oauth-server.mjs"),
            )
            .await;
            let server_name = "oauth-lifecycle-mcp";
            let handler = Arc::new(LifecycleAuthHandler::default());
            let client = ctx.start_client().await;
            let session = client
                .create_session(
                    ctx.approve_all_session_config()
                        .with_enable_mcp_apps(true)
                        .with_mcp_auth_handler(handler.clone())
                        .with_mcp_servers(HashMap::from([(
                            server_name.to_string(),
                            McpServerConfig::Http(McpHttpServerConfig {
                                tools: Some(vec!["*".to_string()]),
                                timeout: None,
                                url: format!("{}/mcp", oauth_server.url),
                                headers: HashMap::new(),
                            }),
                        )])),
                )
                .await
                .expect("create session");

            wait_for_mcp_server_status(&session, server_name, McpServerStatus::Connected).await;
            call_whoami(&session, server_name, "refresh").await;
            call_whoami(&session, server_name, "upscope").await;
            call_whoami(&session, server_name, "reauth").await;

            assert_eq!(
                handler.reasons.lock().as_slice(),
                [
                    McpOauthRequestReason::Initial,
                    McpOauthRequestReason::Refresh,
                    McpOauthRequestReason::Upscope,
                    McpOauthRequestReason::Refresh,
                    McpOauthRequestReason::Reauth,
                ]
            );

            let requests = oauth_server.requests().await;
            assert!(
                requests
                    .iter()
                    .any(|request| request.authorization.as_deref()
                        == Some("Bearer sdk-host-token-refresh"))
            );
            assert!(
                requests
                    .iter()
                    .any(|request| request.authorization.as_deref()
                        == Some("Bearer sdk-host-token-upscope"))
            );
            assert!(
                requests
                    .iter()
                    .any(|request| request.authorization.as_deref()
                        == Some("Bearer sdk-host-token-reauth"))
            );

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

#[tokio::test]
async fn should_cancel_pending_mcp_oauth_request() {
    with_e2e_context_no_snapshot(|ctx| {
        Box::pin(async move {
            ctx.set_default_copilot_user();
            let mut oauth_server = OAuthMcpServer::start(
                ctx.repo_root()
                    .join("test/harness/test-mcp-oauth-server.mjs"),
            )
            .await;
            let server_name = "oauth-cancelled-mcp";
            let handler = Arc::new(CancelAuthHandler::default());
            let client = ctx.start_client().await;
            let session = client
                .create_session(
                    ctx.approve_all_session_config()
                        .with_mcp_auth_handler(handler.clone())
                        .with_mcp_servers(HashMap::from([(
                            server_name.to_string(),
                            McpServerConfig::Http(McpHttpServerConfig {
                                tools: Some(vec!["*".to_string()]),
                                timeout: None,
                                url: format!("{}/mcp", oauth_server.url),
                                headers: HashMap::new(),
                            }),
                        )])),
                )
                .await
                .expect("create session");

            wait_for_mcp_server_status(&session, server_name, McpServerStatus::Failed).await;

            let request = handler
                .request
                .lock()
                .clone()
                .expect("MCP auth handler should be invoked");
            assert_eq!(request.server_name, server_name);
            assert_eq!(request.reason, McpOauthRequestReason::Initial);

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

#[derive(Default)]
struct TokenAuthHandler {
    request: Mutex<Option<McpAuthRequest>>,
}

#[async_trait]
impl McpAuthHandler for TokenAuthHandler {
    async fn handle(
        &self,
        _session_id: SessionId,
        request_id: RequestId,
        request: McpAuthRequest,
    ) -> McpAuthResult {
        assert_eq!(request.request_id, request_id);
        *self.request.lock() = Some(request);
        McpAuthResult::Token {
            access_token: EXPECTED_TOKEN.to_string(),
            token_type: Some("Bearer".to_string()),
            expires_in: Some(3600),
        }
    }
}

#[derive(Default)]
struct LifecycleAuthHandler {
    reasons: Mutex<Vec<McpOauthRequestReason>>,
    refresh_count: Mutex<usize>,
}

#[async_trait]
impl McpAuthHandler for LifecycleAuthHandler {
    async fn handle(
        &self,
        _session_id: SessionId,
        request_id: RequestId,
        request: McpAuthRequest,
    ) -> McpAuthResult {
        assert_eq!(request.request_id, request_id);
        let reason = request.reason.clone();
        self.reasons.lock().push(reason.clone());
        let token = match reason {
            McpOauthRequestReason::Refresh => {
                let www_authenticate = request
                    .www_authenticate_params
                    .as_ref()
                    .expect("refresh WWW-Authenticate params");
                assert_eq!(www_authenticate.resource_metadata_url, None);
                assert_eq!(www_authenticate.error.as_deref(), Some("invalid_token"));
                let mut refresh_count = self.refresh_count.lock();
                *refresh_count += 1;
                if *refresh_count > 1 {
                    return McpAuthResult::Cancelled;
                }
                REFRESH_TOKEN
            }
            McpOauthRequestReason::Upscope => {
                let www_authenticate = request
                    .www_authenticate_params
                    .as_ref()
                    .expect("upscope WWW-Authenticate params");
                assert!(
                    www_authenticate
                        .resource_metadata_url
                        .as_deref()
                        .is_some_and(|url| url.ends_with("/.well-known/oauth-protected-resource"))
                );
                assert_eq!(www_authenticate.scope.as_deref(), Some("mcp.write"));
                assert_eq!(
                    www_authenticate.error.as_deref(),
                    Some("insufficient_scope")
                );
                UPSCOPE_TOKEN
            }
            McpOauthRequestReason::Reauth => REAUTH_TOKEN,
            _ => EXPECTED_TOKEN,
        };
        McpAuthResult::Token {
            access_token: token.to_string(),
            token_type: None,
            expires_in: None,
        }
    }
}

#[derive(Default)]
struct CancelAuthHandler {
    request: Mutex<Option<McpAuthRequest>>,
}

#[async_trait]
impl McpAuthHandler for CancelAuthHandler {
    async fn handle(
        &self,
        _session_id: SessionId,
        request_id: RequestId,
        request: McpAuthRequest,
    ) -> McpAuthResult {
        assert_eq!(request.request_id, request_id);
        *self.request.lock() = Some(request);
        McpAuthResult::Cancelled
    }
}

#[derive(Deserialize)]
struct OAuthMcpRequest {
    authorization: Option<String>,
}

struct OAuthMcpServer {
    child: Child,
    url: String,
}

impl OAuthMcpServer {
    async fn start(script: PathBuf) -> Self {
        let mut child = Command::new("node")
            .arg(script)
            .env("EXPECTED_TOKEN", EXPECTED_TOKEN)
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
            .kill_on_drop(true)
            .spawn()
            .expect("start OAuth MCP server");
        let stdout = child.stdout.take().expect("OAuth MCP stdout");
        let mut lines = BufReader::new(stdout).lines();
        let line = tokio::time::timeout(std::time::Duration::from_secs(10), lines.next_line())
            .await
            .expect("OAuth MCP server startup timeout")
            .expect("read OAuth MCP startup line")
            .expect("OAuth MCP server stdout closed");
        let url = line
            .strip_prefix("Listening: ")
            .unwrap_or_else(|| panic!("unexpected OAuth MCP startup line: {line}"))
            .to_string();
        Self { child, url }
    }

    async fn requests(&self) -> Vec<OAuthMcpRequest> {
        let text = reqwest::get(format!("{}/__requests", self.url))
            .await
            .expect("fetch OAuth MCP requests")
            .error_for_status()
            .expect("OAuth MCP request status")
            .text()
            .await
            .expect("read OAuth MCP requests");
        serde_json::from_str(&text).expect("decode OAuth MCP requests")
    }

    async fn stop(&mut self) {
        let _ = self.child.kill().await;
        let _ = self.child.wait().await;
    }
}

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 call_whoami(session: &Session, server_name: &str, scenario: &str) {
    let result = session
        .rpc()
        .mcp()
        .apps()
        .call_tool(McpAppsCallToolRequest {
            arguments: Some(HashMap::from([(
                "scenario".to_string(),
                serde_json::Value::String(scenario.to_string()),
            )])),
            origin_server_name: server_name.to_string(),
            server_name: server_name.to_string(),
            tool_name: "whoami".to_string(),
        })
        .await
        .expect("call whoami");
    let content = result.get("content").expect("whoami content");
    assert_eq!(
        content,
        &serde_json::json!([{ "type": "text", "text": "oauth-test-user" }])
    );
}