github/copilot-sdk

Project overview

A multi-platform SDK that embeds the same production-tested agent runtime powering Copilot CLI, enabling applications to programmatically handle planning, tool invocation, and file edits. It requires a GitHub Copilot subscription or a user-provided LLM API key, and is designed for developers who need to integrate agentic workflows without building custom orchestration.

Project type

AI Agent · AI Coding

Use cases

Automation

Deployment

Refer to project documentation

License

MIT

Best for

• Developers integrating agentic workflows into applications using Python, TypeScript, Go, .NET, Java, or Rust without building custom orchestration.
• AI engineers who need to define custom agents and tools while maintaining programmatic control over tool permissions.

Key capabilities

• Invokes the production-tested Copilot CLI agent runtime programmatically to handle planning, tool invocation, file edits, and other agent behaviors.
• Provides SDK client libraries for Python, TypeScript, Go, .NET, Java, and Rust.
• Manages the Copilot CLI server process lifecycle automatically via JSON-RPC.
• Allows configuration of the SDK to use user-provided API keys from supported LLM providers instead of standard GitHub authentication.
• Allows users to define custom agents, skills, and tools to extend agent functionality.
• Provides a permission handler so applications can approve, deny, or customize tool calls.

Limitations and risks

• The Copilot CLI is not bundled by default for the Go, Java, and Rust SDKs.
• BYOK uses key-based authentication only; Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported.
• SDK usage counts towards a Copilot usage allowance with associated billing.

Getting started

• Install the SDK via a standard package manager, such as npm install @github/copilot-sdk, to begin integration.

Evidence and sources

• README: The GitHub Copilot SDK exposes the same engine behind Copilot CLI: a production-tested agent runtime you can invoke programmatically. No need to build your own orchestration—you d…
• README: The GitHub Copilot SDK is generally available and follows semantic versioning.
• README: Embed Copilot's agentic workflows in your application with the GitHub Copilot SDK for Python, TypeScript, Go, .NET, Java, and Rust.
• README: All SDKs communicate with the Copilot CLI server via JSON-RPC: ``` Your Application ↓ SDK Client ↓ JSON-RPC Copilot CLI (server mode) ``` The SDK manages the CLI process lifecycle…
• README: Yes, the GitHub Copilot SDK supports BYOK (Bring Your Own Key). You can configure the SDK to use your own API keys from supported LLM providers (e.g. OpenAI, Azure AI Foundry, Ant…

Reviewed at: 2026-07-16T19:45:57Z