copilot-sdk

Install the SDK package for your language, create a CopilotClient, then call createSession with a model and permission handler. Send prompts with sendAndWait and always call client.stop() in a finally block to clean up the CLI process.

Define a tool with a name, description, parameter schema, and handler function, then pass it in the session's tools array. Copilot decides when to invoke it based on the user's question and the tool description, and the result is fed back into the response.

The SDK supports TypeScript/Node.js 18+, Python 3.8+, Go 1.21+, and .NET 8.0+. All languages require the GitHub Copilot CLI to be installed and authenticated, since the SDK controls the CLI's agent runtime via JSON-RPC.

Yes, pass an mcpServers configuration when creating a session, specifying the server type and URL, such as the GitHub MCP server at https://api.githubcopilot.com/mcp/. This gives the agent access to ready-made tools for repositories, issues, and pull requests.

Common causes are a missing Copilot CLI (ENOENT error) or an unreachable server (ECONNREFUSED). Verify the CLI with copilot --version, ensure it is authenticated, and check the cliUrl or port configuration if connecting to an external server.

No, the SDK is in Technical Preview and may introduce breaking changes. Pin your SDK versions and retest when upgrading, and avoid relying on it for production workloads until it reaches general availability.