copilot-sdk README

The project's README from github.com/microsoft/copilot-sdk. As one markdown file: README.md.

Microsoft Copilot SDK

[!IMPORTANT] GitHub Copilot SDK is becoming Microsoft Copilot SDK, the programmable interface for the Microsoft Copilot harness, the shared agent foundation used across Microsoft and GitHub products.

The SDK repository will move to the Microsoft organization as part of a phased transition. Existing package names, namespaces, and some documentation may continue to reference GitHub Copilot SDK during the transition. No immediate changes are required for existing users. Learn more about the transition.

Support for the Copilot SDK remains the same. For more information: SUPPORT.md

NPM Downloads PyPI - Downloads NuGet Downloads Go Reference crates.io Maven Central

Agents for every app.

Embed Copilot's agentic workflows in your application with the Microsoft Copilot SDK for Python, TypeScript, Go, .NET, Java, and Rust.

The Microsoft 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 define agent behavior, Copilot handles planning, tool invocation, file edits, and more.

Available SDKs

SDK Location Cookbook Installation API docs
Node.js / TypeScript nodejs/ Cookbook npm install @microsoft/copilot-sdk
Python python/ Cookbook pip install microsoft-copilot-sdk
Go go/ Cookbook go get github.com/microsoft/copilot-sdk/go/v2 API docs
.NET dotnet/ Cookbook dotnet add package Microsoft.Copilot.SDK
Rust rust/ — cargo add copilot-sdk API docs
Java java/ Cookbook Maven coordinates
com.microsoft:copilot-sdk
See instructions for Maven and Gradle
API docs

See the individual SDK READMEs for installation, usage examples, and API reference.

Getting Started

For a complete walkthrough, see the Getting Started Guide.

Quick steps:

  1. (Optional) Install the Copilot CLI

A separate CLI installation is not required. Node.js and .NET include platform runtime artifacts, Python downloads them, and Rust bundles them with its default features. Go applications must run the bundler or provide a compatible runtime package; Java applications must add their platform runtime classifier. Follow the language README before starting a client.

  1. Install your preferred SDK using the commands above.

  2. See the SDK README for usage examples and API documentation.

Architecture

All SDKs drive the Copilot agent runtime over protocol-4 JSON-RPC. By default, SDK v2 loads the native Rust runtime into your application through a C ABI and carries framed JSON-RPC messages over an in-memory connection. It does not embed a Node.js interpreter or start a CLI process:

Your Application
       ↓
  SDK Client
       ↓ JSON-RPC (in memory, C ABI)
  Native Copilot runtime

The SDK manages its runtime host, but the native library remains loaded for the application process lifetime. In-process hosting provides neither crash isolation nor a sandbox. Explicit stdio/TCP subprocess connections and external servers remain supported; see Run the Copilot runtime in process for requirements and v2 migration options.

Portable elicitation schemas

For form elicitation callbacks, the portable schema contract is an object form with modeled properties and optional required fields (type: "object" on the wire; an SDK may represent the object type implicitly). Applications that support multiple SDK languages must use the modeled property definitions and must not depend on additional schema metadata (such as a top-level title) or on the insertion order of properties.

Node.js and Rust pass through the wire schema, including additional metadata and property order. Python, Go, .NET, and Java reconstruct the callback schema from the modeled fields and do not offer that same preservation guarantee. Treat wire-schema preservation as a language-specific capability, not a cross-language requirement.

Agent Finder Skill installation APIs

Runtimes that grant skill-confirmed-installation expose skills.planInstall, skills.applyInstall, skills.planUninstall, skills.applyUninstall, skills.installations.list/recover/status/cancel, and skills.installations.setEnabled. Skill install reviews include the full verified SKILL.md content up to 256 KiB, catalogue identity, file manifest, and non-absolute personal target location. Summaries report ownershipState, configuredEnabled, sessionState, retained catalogue identity and installedAt.

FAQ

Do I need a GitHub Copilot subscription to use the SDK?

Yes, a GitHub Copilot subscription is required to use the Microsoft Copilot SDK, unless you are using BYOK (Bring Your Own Key). With BYOK, you can use the SDK without GitHub authentication by configuring your own API keys from supported LLM providers. For standard usage (non-BYOK), refer to the GitHub Copilot pricing page, which includes a free tier with limited usage.

How does billing work for SDK usage?

Billing for the Microsoft Copilot SDK is based on the same model as the Copilot CLI, with each prompt being counted towards your usage allowance. For more information on Copilot usage billing, see Usage in GitHub Copilot.

Does it support BYOK (Bring Your Own Key)?

Yes, the Microsoft 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, Microsoft Foundry, Anthropic) to access models through those providers. See the BYOK documentation for setup instructions and examples.

Note: BYOK uses key-based authentication only. Microsoft Entra ID (Azure AD), managed identities, and third-party identity providers are not supported.

What authentication methods are supported?

The SDK supports multiple authentication methods:

See the Authentication documentation for details on each method.

Do I need to install the Copilot CLI separately?

No. The default needs a compatible native runtime, not a separately running CLI. Node.js, .NET, Python, and Rust provide acquisition or bundling; Go needs application-level bundling or an explicit runtime package, and Java needs the platform classifier dependency.

Advanced: You can override the CLI binary or connect to an external server. See the individual SDK README for language-specific options.

What tools are enabled by default?

By default, the SDK exposes the Copilot CLI's first-party tools, similar to running the CLI with --allow-all. Tool execution is still governed by each SDK's permission handler, so applications can approve, deny, or customize tool calls. You can customize tool availability by configuring the SDK client options to enable and disable specific tools. Refer to the individual SDK documentation for details on tool configuration and to the Copilot CLI documentation for the list of available tools.

Can I use custom agents, skills or tools?

Yes, the Microsoft Copilot SDK allows you to define custom agents, skills, and tools. You can extend the functionality of the agents by implementing your own logic and integrating additional tools as needed. Refer to the SDK documentation of your preferred language for more details.

Are there instructions or SDK guidance for Copilot to speed up development?

Yes, check out the custom instructions and SDK-specific guidance:

What models are supported?

All models available via Copilot CLI are supported in the SDK. The SDK also exposes a method which will return the models available so they can be accessed at runtime.

Is the SDK production-ready?

The Microsoft Copilot SDK is generally available and follows semantic versioning. See CHANGELOG.md for release notes.

How do I report issues or request features?

Please use the GitHub Issues page to report bugs or request new features. We welcome your feedback to help improve the SDK.

Unofficial, Community-maintained SDKs

⚠️ Disclaimer: These are unofficial, community-driven SDKs and they are not supported by GitHub. Use at your own risk.

SDK Location
Clojure copilot-community-sdk/copilot-sdk-clojure
C++ 0xeb/copilot-sdk-cpp

License

MIT

copilot-sdk (microsoft/copilot-sdk)

Searching Database…

What is this?This is GitHub's official Copilot SDK, letting developers embed GitHub Copilot's agentic workflows (planning, tool invocation, file edits) directly into their own apps and services, with implementations for Python, TypeScript, Go, .NET, Java, and Rust.
Is this a library I import, or a standalone app?It's a library/SDK you add to your own codebase in your language of choice; under the hood it talks to the same engine as the Copilot CLI over JSON-RPC, so you don't have to build your own agent orchestration.
How do I add it to my project?Install the SDK for your language — npm install @github/copilot-sdk, pip install github-copilot-sdk, go get github.com/github/copilot-sdk/go, dotnet add package GitHub.Copilot.SDK, cargo add github-copilot-sdk, or Maven/Gradle for Java — then follow the Getting Started Guide and your SDK's README for usage examples.
Do I need to install the Copilot CLI separately first?Not for Node.js, Python, or .NET — the Copilot CLI is bundled automatically as a dependency. For Go, Java, and Rust you must install the CLI yourself and have it on your PATH; you'll also need a GitHub Copilot subscription, unless you use BYOK with your own LLM provider key.
Does BYOK let me skip GitHub auth entirely?Yes, BYOK lets you use your own API keys from providers like OpenAI, Microsoft Foundry, or Anthropic without GitHub authentication, but it only supports key-based auth — Entra ID, managed identities, and other identity providers aren't supported.
Which authentication methods does the SDK support?It supports GitHub signed-in user (stored OAuth credentials from Copilot CLI login), an OAuth GitHub App flow with user tokens, environment variables like GITHUBTOKEN, or BYOK for provider API keys with no GitHub auth needed.
Can I control which tools the agent is allowed to use?Yes, the SDK exposes Copilot CLI's first-party tools by default (like running with --allow-all), but a permission handler lets your app approve, deny, or customize each tool call, and client options let you enable or disable specific tools.
Is this production-ready?Yes, the SDK is generally available and follows semantic versioning, with a CHANGELOG.md tracking release notes.
Are there SDKs for other languages beyond the official six?Yes, there are unofficial, community-maintained SDKs for Clojure and C++, but GitHub explicitly does not support or vouch for them.
Creator
microsoft
Size
73.3 MB
Stars
10.7K
Age
10mo
Commits · 90 Days