Expose session context in listSessions and add filtering #427

jmoseley · 2026-02-10T21:06:42Z

Summary

Exposes the working directory and repository context for sessions via listSessions(), and adds optional filtering support.

New Types

SessionContext

interface SessionContext {
    cwd: string;        // Working directory where session was created
    gitRoot?: string;   // Git repository root (if in a git repo)
    repository?: string; // GitHub repo in owner/repo format
    branch?: string;    // Current git branch
}

SessionListFilter

interface SessionListFilter {
    cwd?: string;
    gitRoot?: string;
    repository?: string;
    branch?: string;
}

API Changes

SessionMetadata

Added context?: SessionContext field.

listSessions()

Now accepts optional filter parameter:

// List all sessions
const sessions = await client.listSessions();

// Filter by repository
const sessions = await client.listSessions({ repository: 'github/copilot-sdk' });

// Filter by cwd
const sessions = await client.listSessions({ cwd: '/path/to/project' });

Changes

Added SessionContext type to types.ts
Added SessionListFilter type to types.ts
Updated SessionMetadata to include context field
Updated listSessions() to accept optional filter and return context
Updated documentation and cookbook examples
Added tests

Fixes #413
Fixes #200

Copilot

Pull request overview

Adds session “working directory / git repo” context to Node SDK SessionMetadata returned by listSessions(), and introduces an optional filter parameter to support server-side session filtering.

Changes:

Added new public types SessionContext and SessionListFilter, and extended SessionMetadata with context?: SessionContext.
Updated CopilotClient.listSessions() to accept an optional filter and to return the new context field.
Updated Node docs/cookbook examples and added an E2E assertion for the new context field.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
nodejs/src/types.ts	Introduces `SessionContext` / `SessionListFilter` and adds `context` onto `SessionMetadata`.
nodejs/src/client.ts	Extends `listSessions()` to accept a filter and map `context` from the JSON-RPC response.
nodejs/src/index.ts	Re-exports `SessionListFilter` from the package entrypoint (but currently not `SessionContext`).
nodejs/test/e2e/session.test.ts	Adds an E2E test asserting `listSessions()` returns a `context.cwd`.
nodejs/README.md	Documents `SessionMetadata.context` and the `SessionContext` fields (but doesn’t yet document filtering).
cookbook/nodejs/persisting-sessions.md	Adds example printing session context information.
cookbook/nodejs/multiple-sessions.md	Adds example showing `context?.cwd` when listing sessions.

Copilot · 2026-02-10T21:12:14Z

nodejs/src/client.ts

     * }
     * ```
     */
-    async listSessions(): Promise<SessionMetadata[]> {
+    async listSessions(filter?: SessionListFilter): Promise<SessionMetadata[]> {
        if (!this.connection) {
            throw new Error("Client not connected");
        }

-        const response = await this.connection.sendRequest("session.list", {});
+        const response = await this.connection.sendRequest("session.list", { filter });


Now that listSessions accepts an optional filter, the method-level docs should be updated to document that parameter and include a filtered example (e.g. by repository or cwd). Otherwise IDE docs and generated docs will be misleading.

Copilot · 2026-02-10T21:12:14Z

nodejs/src/index.ts

    SessionEventHandler,
    SessionEventPayload,
    SessionEventType,
+    SessionListFilter,


SessionMetadata.context is typed as SessionContext, but SessionContext itself isn’t re-exported from the package entrypoint. This makes it awkward for consumers to reference the type directly (and the README now documents it). Re-export SessionContext alongside SessionListFilter in this file.

Suggested change

SessionListFilter,

SessionListFilter,

SessionContext,

Copilot · 2026-02-10T21:12:15Z

nodejs/README.md

 ##### `listSessions(): Promise<SessionMetadata[]>`

 List all available sessions.

+**SessionMetadata:**


The README still documents listSessions(): Promise<SessionMetadata[]>, but the implementation now accepts an optional filter. Update the method signature docs and add a short description/example for the SessionListFilter parameter so the docs match the API.

Copilot · 2026-02-10T21:12:15Z

nodejs/src/client.ts

        const { sessions } = response as {
            sessions: Array<{
                sessionId: string;
                startTime: string;
                modifiedTime: string;
                summary?: string;
                isRemote: boolean;
+                context?: {
+                    cwd: string;
+                    gitRoot?: string;
+                    repository?: string;
+                    branch?: string;
+                };


SessionContext is re-declared inline in the response cast, which can drift from the exported SessionContext interface over time. Reuse SessionContext in the response typing (e.g., context?: SessionContext) to keep a single source of truth.

Copilot · 2026-02-10T21:12:15Z

nodejs/src/client.ts

+    async listSessions(filter?: SessionListFilter): Promise<SessionMetadata[]> {
        if (!this.connection) {
            throw new Error("Client not connected");
        }

-        const response = await this.connection.sendRequest("session.list", {});
+        const response = await this.connection.sendRequest("session.list", { filter });


Filtering support was added to listSessions(filter?: SessionListFilter), but there’s no test exercising the filter behavior (only the presence of context). Add an E2E test that creates at least two sessions with different workingDirectory/repo context (or uses a filterable field) and asserts listSessions({ ... }) returns the expected subset.

Copilot · 2026-02-10T21:12:15Z

cookbook/nodejs/persisting-sessions.md

+        console.log(`  Repository: ${session.context.repository}`);
+        console.log(`  Branch: ${session.context.branch}`);


This example prints Repository: / Branch: even when those fields are undefined, which will produce noisy output like Repository: undefined. Consider printing those lines only when the value is present (or using a fallback like "(none)").

Suggested change

console.log(` Repository: ${session.context.repository}`);

console.log(` Branch: ${session.context.branch}`);

if (session.context.repository) {

console.log(` Repository: ${session.context.repository}`);

}

if (session.context.branch) {

console.log(` Branch: ${session.context.branch}`);

}

Adds SessionContext to SessionMetadata so SDK consumers can see the working directory and repository information for each session. Also adds optional filter parameter to listSessions() for filtering by context fields (cwd, gitRoot, repository, branch). Implemented in all SDK clients: - Node.js - Python - Go - .NET Fixes #413 Fixes #200

github-actions · 2026-02-10T21:24:09Z

Cross-SDK Consistency Review: ✅ Excellent Consistency

I've reviewed this PR for cross-language SDK consistency. This PR adds session context information (SessionContext) and filtering capabilities (SessionListFilter) to the listSessions() method across all four SDK implementations. The changes maintain excellent consistency across languages.

✅ What's Consistent

1. Type Definitions

All SDKs define the same two new types with equivalent fields:

SessionContext:

cwd (string, required) - Working directory where session was created
gitRoot (string, optional) - Git repository root
repository (string, optional) - GitHub repository in "owner/repo" format
branch (string, optional) - Current git branch

SessionListFilter:

cwd (string, optional) - Filter by exact cwd match
gitRoot (string, optional) - Filter by git root
repository (string, optional) - Filter by repository
branch (string, optional) - Filter by branch

All field names use consistent casing (camelCase for TypeScript, snake_case for Python, PascalCase for .NET/Go).

2. API Changes

All SDKs updated their listSessions method with equivalent signatures:

Node.js: listSessions(filter?: SessionListFilter)
Python: list_sessions(filter: SessionListFilter | None = None)
Go: ListSessions(ctx context.Context, filter *SessionListFilter)
.NET: ListSessionsAsync(SessionListFilter? filter = null, ...)

The filter parameter is optional/nullable in all implementations.

3. SessionMetadata Updates

All SDKs added the context field to SessionMetadata as an optional field.

4. Code Changes

All SDKs properly:

Export/expose the new types in their public API
Pass the filter to the JSON-RPC call correctly
Parse and populate the context field in responses

5. Tests

Node.js: Added test verifying context field is populated ✅
Go: Updated existing tests to pass nil filter ✅
Python: Existing tests still work (no filter passed) ✅
.NET: (no new tests, but existing integration should work)

📝 Minor Documentation Gap (Non-blocking)

The following READMEs document the new SessionContext type but don't yet document the filtering parameter:

Python README: No mention of SessionListFilter or the filter parameter (though docstrings in code are complete)
.NET README: Signature still shows ListSessionsAsync() with no parameters documented (line 119)

These are documentation-only gaps and don't affect API consistency. The in-code documentation (docstrings/JSDoc/XML comments) is complete in all languages.

🎯 Recommendation

Approve - This PR maintains excellent cross-SDK consistency. The API design is parallel across all four languages, accounting for language-specific idioms. The minor documentation gaps can be addressed in a follow-up if desired, but they don't affect the functionality or API design consistency.

Great work maintaining feature parity across all SDKs! 🚀

AI generated by SDK Consistency Review Agent

github-actions · 2026-02-10T22:06:41Z

✅ Cross-SDK Consistency Review

I've reviewed PR #427 for consistency across all four SDK implementations (Node.js, Python, Go, .NET), and I'm pleased to report that this PR maintains excellent cross-SDK consistency!

What was added:

SessionContext type - provides working directory context (cwd, gitRoot, repository, branch)
SessionListFilter type - enables filtering sessions by these context fields
Enhanced listSessions() method to accept optional filter parameter
Added context field to SessionMetadata

Consistency verification:

✅ All four SDKs updated - Node.js, Python, Go, and .NET all include the changes
✅ Type definitions match - All SDKs define the same fields with matching JSON names
✅ API signatures are parallel - Each SDK follows its language conventions:

Node.js: listSessions(filter?: SessionListFilter)
Python: list_sessions(filter: SessionListFilter | None = None)
Go: ListSessions(ctx context.Context, filter *SessionListFilter)
.NET: ListSessionsAsync(SessionListFilter? filter = null, CancellationToken cancellationToken = default)

✅ Naming conventions respected - camelCase (Node/Python JSON), PascalCase (Go/C#) as appropriate
✅ Documentation complete - All SDKs have comprehensive doc comments
✅ Tests updated - Go tests pass nil, Node.js has a skipped test ready for runtime support

Language-specific differences (appropriate):

Go includes context.Context as first parameter (Go standard practice)
.NET includes CancellationToken parameter (idiomatic for async methods)
These differences are correct and expected

No consistency issues found. This PR successfully maintains feature parity across all SDK implementations while respecting each language's conventions. Nice work! 🎉

AI generated by SDK Consistency Review Agent

IeuanWalker · 2026-02-10T23:08:46Z

@jmoseley does the SDK track if the git branch changes? if it does could it expose an event for it?

Copilot AI review requested due to automatic review settings February 10, 2026 21:06

jmoseley requested a review from a team as a code owner February 10, 2026 21:06

Copilot started reviewing on behalf of jmoseley February 10, 2026 21:07 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

jmoseley force-pushed the jm/sdk-413 branch from c7701ba to ef5001c Compare February 10, 2026 21:15

Merge main into jm/sdk-413

395add5

Skip context test until runtime PR merges

7ce7ae3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose session context in listSessions and add filtering #427

Expose session context in listSessions and add filtering #427

jmoseley commented Feb 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

Copilot AI Feb 10, 2026

Uh oh!

github-actions bot commented Feb 10, 2026

Uh oh!

github-actions bot commented Feb 10, 2026

Uh oh!

IeuanWalker commented Feb 10, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		console.log(` Repository: ${session.context.repository}`);
		console.log(` Branch: ${session.context.branch}`);

Expose session context in listSessions and add filtering #427

Are you sure you want to change the base?

Expose session context in listSessions and add filtering #427

Conversation

jmoseley commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New Types

SessionContext

SessionListFilter

API Changes

SessionMetadata

listSessions()

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 10, 2026

Cross-SDK Consistency Review: ✅ Excellent Consistency

✅ What's Consistent

1. Type Definitions

2. API Changes

3. SessionMetadata Updates

4. Code Changes

5. Tests

📝 Minor Documentation Gap (Non-blocking)

🎯 Recommendation

Uh oh!

github-actions bot commented Feb 10, 2026

✅ Cross-SDK Consistency Review

What was added:

Consistency verification:

Language-specific differences (appropriate):

Uh oh!

IeuanWalker commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jmoseley commented Feb 10, 2026 •

edited

Loading

IeuanWalker commented Feb 10, 2026 •

edited

Loading