copilot-sdk

What it does

Build applications that programmatically interact with GitHub Copilot. The SDK wraps the Copilot CLI via JSON-RPC, providing session management, custom tools, hooks, MCP server integration, and streaming across Node.js, Python, Go, and .NET.

How it works

• Prerequisites include a Copilot CLI installation and authentication, a Copilot subscription (unless using BYOK), and runtime support per language.
• Installation enumerates language-specific packages and commands to install them.
• Architecture describes a flow: Your App → SDK Client → [stdio/TCP] → Copilot CLI → Model Provider, with MCP Servers connected in the middle.
• Transport modes include Stdio (default) for local development and TCP for multi-client/backend use.
• Core pattern: create a client, create a session, and send messages.
• The skill provides concrete code examples for Node.js/TypeScript, Python, Go, and .NET showing session creation, sending prompts, and stopping the client.
• Streaming can be enabled by setting streaming: true and subscribing to delta events, with examples in Node.js and Python.
• Custom Tools demonstrate defining tools in each language with parameters, handlers, and integration into sessions.
• Hooks cover pre/post tool use, user prompt submission, session lifecycle, and error handling with code samples.
• MCP Server Integration explains local stdio and remote HTTP MCP servers with configuration fields and debugging tips.
• Authentication outlines multiple token methods and a sample client creation, plus BYOK and disable auto-login options.
• BYOK describes provider configurations for OpenAI, Azure OpenAI in various setups, and Anthropic.

When to use it

Use when building programmatic integrations with Copilot across Node.js/TypeScript, Python, Go, or .NET, including advanced features like tools, hooks, MCP servers, streaming, and BYOK deployment patterns.

What it can touch

The skill references the following tool usage:

• Tool: copilot (as declared)
• Code samples show importing CopilotClient and related APIs from language-specific packages, and using methods like createSession, start/stop, and streaming event handlers.

Caveats

• Prerequisites explicitly require GitHub Copilot CLI installed and authenticated, and a Copilot subscription (unless BYOK).
• Runtime compatibility per language is listed (Node.js 18+, Python 3.8+, Go 1.21+, .NET 8.0+).
• BYOK mode allows using open providers without a Copilot subscription.
• No licensing caveats beyond MIT as stated for the skill.