copilot-sdk
Programmatic agent runtime for embedding Copilot's agentic workflows in applications across Python, TypeScript, Go, and .NET.
- Exposes the same production-tested engine behind Copilot CLI with support for streaming responses, custom tool definitions, and multi-turn conversations
- Supports four language runtimes (Node.js 18+, Python 3.8+, Go 1.21+, .NET 8.0+) with consistent APIs across all platforms
- Enables integration with MCP servers for pre-built tools, custom agent personas with specialized prompts, and session persistence across restarts
- Includes event-driven architecture for tool invocation, streaming chunks, reasoning visibility, and error handling; configurable client and session options for model selection, timeouts, and resource management
Microsoft Copilot SDK
Embed Copilot's agentic workflows in any application using Python, TypeScript, Go, or .NET.
Overview
The Microsoft Copilot SDK is transitioning from the GitHub Copilot SDK. It is becoming the programmable interface for the Microsoft Copilot harness, the shared agent foundation used across Microsoft and GitHub products. This transition is happening in phases, and no immediate changes are required for existing users. Package names, namespaces, and some documentation may continue to use GitHub branding during the transition.
This guide keeps the currently published package names and imports in its examples. Follow the official transition announcement for migration updates.
The SDK provides a production-tested agent runtime you can invoke programmatically. You define agent behavior, while Copilot handles planning, tool invocation, file edits, and more.
Prerequisites
- GitHub Copilot access and an authenticated environment
- Language runtime: Node.js ^20.19.0 or >=22.12.0, Python 3.11+, Go 1.24+, or a .NET Standard 2.0-compatible implementation
- Go: GitHub Copilot CLI installed and authenticated (Installation guide)
The TypeScript, Python, and .NET packages use a bundled Copilot runtime by default, so they do not need a separate CLI installation.