# GitHub Copilot SDK ## 概述 GitHub Copilot SDK 是一个多平台代理运行时，它将 Copilot 的代理工作流程嵌入到应用程序中。它在 Copilot CLI 背后公开了相同的引擎，无需自定义编排开发即可实现编程调用。 **状态：** 技术预览（适合开发和测试） **支持的语言：** TypeScript/Node.js、Python、Go、.NET ## 主要文档 * [GitHub Copilot SDK 存储库]() * [入门指南]() * [食谱食谱]() ### 特定语言的 SDK 文档 * [Node.js/TypeScript SDK]() * [Python SDK]() * [Go SDK]() * [.NET SDK]() ### CLI 和配置文档 * [关于 GitHub Copilot CLI]() * [使用 GitHub Copilot CLI]() * [创建自定义代理]() * [自定义代理配置参考]() * [使用 MCP 增强代理模式]() * [支持的AI模型]() ** ** ## 先决条件 1. **GitHub Copilot 订阅** \- Pro、Pro+、Business 或 Enterprise 2. **GitHub Copilot CLI** \-已安装并经过身份验证（`copilot --version`） 3. **运行时：** Node.js 18+、Python 3.8+、Go 1.21+ 或 .NET 8.0+ ## 安装语言 |命令 ---|--- TypeScript/Node.js | `npm install @github/copilot-sdk` 蟒蛇 | `pip 安装 github-copilot-sdk` 去 | `去获取 github.com/github/copilot-sdk/go` .NET | `dotnet 添加包 GitHub.Copilot.SDK` ## 架构应用程序 → SDK 客户端 → JSON-RPC → Copilot CLI（服务器模式） SDK 自动管理 CLI 生命周期。通过 `cliUrl` / `cli_url` 支持外部服务器连接。 ** ** ## 快速入门（TypeScript）从“@github/copilot-sdk”导入 { CopilotClient }； const client = new CopilotClient(); 等待客户端.start(); const session = wait client.createSession({ model: "gpt-5" }); // 在 send() 之前注册处理程序会话.on((事件) => { if (event.type === "assistant.message") { console.log(事件.数据.内容); } }); wait session.send({ 提示: "2 + 2 是什么？" }); 等待会话.destroy(); 等待客户端.stop(); **关键：**在调用 `send()` 捕获所有事件之前**注册事件处理程序。有关所有语言的完整示例，请参阅“references/working-examples.md”。 ** ** ## 核心概念 ### 客户端主要入口点。管理 CLI 服务器生命周期和会话创建。 **操作：** `start()`、`stop()`、`createSession()`、`resumeSession()` **配置：** `cliPath`、`cliUrl`、`port`、`useStdio`、`autoStart`、`autoRestart` ### 会议带有消息历史记录的个人对话上下文。 **操作：** `send()`、`sendAndWait()`、`on()`、`abort()`、`getMessages()`、`destroy()` **配置：** `model`、`streaming`、`tools`、`systemMessage` ### 活动处理过程中的关键事件：活动 |目的 ---|--- `助手消息` |完整回复 `assistant.message_delta` |流媒体块 `会话.空闲` |准备好接受下一个提示 `tool.execution_start/end` |工具调用有关完整的事件生命周期和 SessionEvent 结构，请参阅“references/event-system.md”。 ### 流媒体 * `streaming: false` (默认) - 内容一次性到达 * `streaming: true` \- 内容通过 `assistant.message_delta` 增量到达无论流设置如何，最终的“assistant.message”**始终触发**。 ** ** ## 可用型号有关完整列表，请参阅[支持的 AI 模型]()。供应商|型号 ID |注释 ---|---|--- 开放人工智能 | `gpt-4.1`、`gpt-5`、`gpt-5-mini` |包含开放人工智能 | `gpt-5.1`、`gpt-5.1-codex`、`gpt-5.2` |高级版人择 | `克劳德十四行诗-4.5` |高级（CLI 默认）人择 | `克劳德-opus-4.5` |溢价（3× 乘数）谷歌 | `gemini-3-pro-预览版` |高级版 ** ** ## 自定义工具 **打字稿（Zod）：** const tool = DefineTool("lookup_issue", { 描述：“获取问题详细信息”，参数：z.object({ id: z.string() }), 处理程序： async ({ id }) => fetchIssue(id), }); **Python（Pydantic）：** @define_tool(description="获取问题详细信息") 异步 def Lookup_issue(params: IssueParams) -> dict: 返回 fetch_issue(params.id) 有关所有语言的完整工具示例，请参阅“references/working-examples.md”。 ** ** ## 语言约定概念 |打字稿 |蟒蛇 |去 | .NET ---|---|---|---|--- 创建会话 | `createSession()` | `create_session()` | `创建会话()` | `CreateSessionAsync()` 达美内容 | `增量内容` | `增量内容` | `DeltaContent` | `Delta内容` 有关完整的约定表，请参阅“references/event-system.md”。 ** ** ## CLI 配置配置存储在`~/.copilot/`中： * `config.json` \- 通用配置 * `mcp-config.json` \- MCP 服务器定义有关自定义代理和 MCP 设置，请参阅“references/cli-agents-mcp.md”。 ** ** ## 故障排除问题 |解决方案 ---|--- 事件触发但内容为空 |使用“event.data.content”，而不是“event.content” 处理程序从不开火 | **在** `send()` 之前注册 Python 枚举问题 |使用`event.type.value` 转到 nil 指针 |在取消引用之前检查 `!= nil` 有关调试技术，请参阅“references/troubleshooting.md”。 ** ** ## 技能参考该技能的详细文档： * `references/working-examples.md` \- 所有语言、自定义工具的完整示例 * `references/event-system.md` \- 事件生命周期、SessionEvent 结构、语言约定 * `references/troubleshooting.md` \- 常见问题、调试技巧 * `references/cli-agents-mcp.md` \- CLI 配置、自定义代理、MCP 服务器设置 ** ** ## 其他资源 * [SDK 示例]() * [SDK 版本]() * [食谱]() * [awesome-copilot]()

副驾驶SDK

包含技能