标签： SDK

项目简介

GitHub Copilot SDK 是 GitHub 官方发布的多平台 Agent 运行时 SDK，让你在自己的应用中嵌入 Copilot CLI 的完整智能体引擎。支持 TypeScript、Python、Go、.NET（C#）、Java、Rust 六种语言，通过 JSON-RPC 与 Copilot CLI server 模式通信，SDK 自动管理进程生命周期——你只需定义 Agent 行为，Copilot 负责规划、工具调用和文件编辑。

一句话：把 Copilot CLI 的 Agent 能力，以 SDK 形式嵌入任何应用。

安装要求与过程

环境要求

• Node.js / TypeScript：Node.js ^20.19.0 或 ≥22.12.0
• Python：Python 3.11+
• .NET：.NET 8+ SDK
• Go / Rust / Java：对应语言工具链 + 需额外安装 Copilot CLI
• 认证：GitHub Copilot 订阅，或 BYOK 自带模型 API Key

快速安装

# Node.js / TypeScript
npm install @github/copilot-sdk

# Python
pip install github-copilot-sdk
python -m copilot download-runtime   # 下载运行时二进制

# .NET
dotnet add package GitHub.Copilot.SDK

# Go
go get github.com/github/copilot-sdk/go

# Rust
cargo add github-copilot-sdk

# Java (Maven)
<dependency>
  <groupId>com.github</groupId>
  <artifactId>copilot-sdk-java</artifactId>
</dependency>

Python 快速上手示例

import asyncio
from copilot import CopilotClient
from copilot.session_events import AssistantMessageData, SessionIdleData
from copilot.session import PermissionHandler

async def main():
    async with CopilotClient() as client:
        async with await client.create_session(
            on_permission_request=PermissionHandler.approve_all,
            model="gpt-5",
        ) as session:
            done = asyncio.Event()
            def on_event(event):
                match event.data:
                    case AssistantMessageData() as data:
                        print(data.content)
                    case SessionIdleData():
                        done.set()
            session.on(on_event)
            await session.send("What is 2+2?")
            await done.wait()

asyncio.run(main())

核心功能

1. 六语言官方 SDK：TypeScript/Python/Go/.NET/Java/Rust 全部由 GitHub 官方维护，统一 API 设计，语义化版本管理（GA 状态）。
2. Agent Loop 完整循环：内置完整的工具调用循环（Tool Use Loop），自动处理回合（Turn）与完成信号，无需自建编排层。
3. Hooks 拦截机制：可在工具调用前后拦截、改写结果、处理错误——实现权限控制、日志审计、输出过滤等中间件逻辑。
4. Custom Agents + Fleet Mode：定义带独立工具集和指令的子智能体；Fleet Mode 支持并行派发多个子智能体处理大型独立任务流。
5. MCP Servers 集成：原生接入 Model Context Protocol 服务器，扩展外部工具能力；同时支持 Skills 提示词模块与 Plugin Directories 插件打包。
6. 40+ Streaming Events：实时订阅会话事件流（assistant.message、tool.call、session.idle 等），构建响应式 UI。

典型使用场景

场景一：IDE 插件内嵌 AI 编程助手

在 VS Code / JetBrains 插件中集成 Copilot Agent，用户选中代码后调用 SDK 发起对话，Agent 自动读取文件上下文、执行重构建议、直接编辑文件。相比自己对接 LLM API + 构建工具链，SDK 已封装好文件读写、终端命令、Git 操作等全套工具。

场景二：CI/CD 流水线中的自动化 Review Bot

在 GitHub Actions 中用 Python SDK 启动 Copilot Session，将 PR diff 作为输入发送给 Agent，让它分析变更影响、生成 review 评论。通过 Hooks 可限制 Agent 只读不写，确保安全可控。

场景三：SaaS 产品中的 AI 功能模块

在 Web 后端通过 TypeScript SDK 创建带预算限制的 Session（Session Limits），为每个用户分配 AI Credits 配额。结合 Remote Sessions 功能，让用户在浏览器中实时看到 Agent 工作过程。BYOK 模式下可使用自有模型 Key，降低运营成本。

推荐理由

作为 GitHub 官方出品，Copilot SDK 的最大优势是「不用重复造轮子」。过去要在应用里嵌入 AI Agent 能力，你需要自己处理模型选择、提示词模板、工具定义、权限控制、错误恢复……现在这些全部由 Copilot CLI 引擎托管，SDK 只暴露简洁的 Session API。

六种语言的覆盖面也令人印象深刻——从脚本到企业级后端，从前端到系统编程，几乎覆盖了主流开发栈。特别是 Python 和 TypeScript SDK 内置了 CLI 二进制，开箱即用体验非常顺滑。

当然，它需要 Copilot 订阅或 BYOK 配置，不是完全免费的方案。但考虑到它提供的生产级 Agent 运行时能力，这个成本是合理的。如果你正在评估「如何在产品中加入 AI Agent 能力」，Copilot SDK 值得作为首选方案之一认真试用。

下载地址

• GitHub 仓库：github.com/github/copilot-sdk
• 官方文档：docs/README.md
• Cookbook：awesome-copilot/cookbook/copilot-sdk
• NPM：@github/copilot-sdk
• PyPI：github-copilot-sdk