Github Copilot Sdk

GitHub Copilot SDK

Use the Copilot SDK with explicit permissions, lifecycle management, and completion handling.

When to invoke

• Embed Copilot in a TypeScript, Python, Go, or .NET application.
• Create or resume Copilot SDK sessions.
• Stream responses and tool events.
• Register custom tools or MCP servers.

Prerequisites and context

• GitHub Copilot CLI is installed, authenticated, and available to the runtime.
• Select a supported language runtime and repository package-management convention.
• Define the permission policy before enabling tools or filesystem/process access.

Procedure

1. Verify CLI availability and authentication.
2. Install the language SDK using the repository's package manager.
3. Create a client with an explicit permission handler.
4. Start the client and create or resume a session before sending a prompt.
5. Register only the required tools and MCP servers with typed schemas.
6. For streaming, handle content deltas, tool events, errors, and the session-idle completion signal.
7. Stop/dispose the session and client on success, error, cancellation, and process shutdown.
8. Validate permission denial, tool failure, cancellation, and normal completion paths.

Installation

Minimal TypeScript shape:

const client = new CopilotClient({ permissionHandler: approveRequired });
await client.start();
const session = await client.createSession();
const response = await session.sendAndWait({ prompt: "Summarize this repository" });
console.log(response?.data.content);
await client.stop();

For streaming, process assistant.message_delta and treat session.idle as completion; do not assume the first text event is the final response.

Output template

## GitHub Copilot SDK result

**Status:** IMPLEMENTED | BLOCKED
**Language:** <TypeScript | Python | Go | .NET>

### Integration
- Client lifecycle: <start/stop behavior>
- Session: <create/resume behavior>
- Permissions: <handler and denied path>
- Tools or MCP: <registered surface or none>
- Streaming: <events and completion signal>

### Validation
- <test/command and result>

Limits

• Do not approve every tool by default in production.
• Do not leave clients, sessions, processes, or streams undisposed.
• Do not expose secrets in prompts, tool schemas, logs, or MCP configuration.
• Verify SDK APIs against current official documentation before version-sensitive implementation.

Progressive disclosure and bundled resources

• Extended SDK guide: tools, MCP, session management, events, and language-specific examples.

Related primitives

Quality gate

• CLI availability and authentication are checked.
• Permission handling is explicit and tested.
• A session exists before messages are sent.
• Streaming handles deltas, errors, and idle completion.
• Client and session resources are disposed on every exit path.

References

• GitHub Copilot SDK