The Copilot Engine SDK from Github provides a framework for developers to create custom coding agent engines. It connects directly to the GitHub Copilot agent platform, acting as an MCP server. This SDK supports sending structured events to the platform API and enables Git operations within engines. It is designed for extending the capabilities of the Copilot agent environment. Developers can build specialized tools and interactions for their agent solutions. The SDK uses a token-based authentication model for secure platform communication.

What does Copilot Engine SDK connect to?

The Copilot Engine SDK connects directly to the GitHub Copilot agent platform. It functions as an MCP (Model Context Protocol) server within this ecosystem. Communication with the platform API involves sending structured events, with HTTP serving as the implied transport protocol for these interactions. The platform itself handles connections to AI clients, providing necessary LLM inference tokens and URLs to the engine via environment variables. The SDK acts as an intermediary engine, not directly interfacing with AI models.

Core features and tools

The Copilot Engine SDK exposes specific callable tools for agent engines. These include report_progress for updating task status and reply_to_comment for interacting with discussion threads. The SDK's Platform Client sends structured events, such as assistant messages and tool executions, to the platform API. It also provides utilities for Git repository operations, allowing engines to clone, commit, and push changes. This enables engines to manage code directly within their operational context.

Who is it for?

The Copilot Engine SDK is intended for developers who are building custom coding agent engines designed to run on the GitHub Copilot agent platform. It provides the necessary components to integrate new functionalities and behaviors into the Copilot environment. This SDK is ideal for extending the platform's capabilities with specialized agent logic and interactions. Skip this if you are not developing custom engines for the GitHub Copilot agent platform.

How to get started

The server authenticates using an API key passed as an environment variable. Setup involves configuring the engine to utilize environment variables, such as GITHUB_PLATFORM_API_TOKEN, for initializing components like the PlatformClient.

Use cases

• Building an engine to send structured events (assistant messages, tool executions, progress updates) to the platform API.
• Enabling engines to use Git utilities for repository operations such as cloning, committing, and pushing changes.
• Creating an MCP server that exposes specific tools like report_progress and reply_to_comment.

The Copilot Engine SDK empowers developers to extend the GitHub Copilot agent platform with custom engine logic. It handles platform communication and provides tools for Git operations and event reporting. The SDK's token-based authentication ensures secure integration within the Copilot ecosystem. It is a focused solution for expanding agent capabilities. Start by developing an engine that sends progress updates using report_progress to the platform API.