用途:将 GitHub Copilot 的智能体能力以编程方式嵌入各类应用,支持 Python、TypeScript、Go、.NET 四种语言。它暴露与 Copilot CLI 相同的运行时,开发者只需定义智能体行为,规划、工具调用与文件编辑由 Copilot 处理,无需自建编排层。
主要能力:创建会话并发送提示(如 sendAndWait);通过 streaming 选项和 assistant.message_delta、session.idle 事件实现流式输出;用 defineTool 定义自定义工具(描述、参数 schema、处理函数),Copilot 按需调用;通过 mcpServers/mcp_servers 连接 MCP 服务器(如 GitHub MCP)获取现成工具;支持自定义智能体(customAgents)。
前置条件:需要 GitHub Copilot 访问权限和已认证环境;语言运行时为 Node.js ^20.19.0 或 >=22.12.0、Python 3.11+、Go 1.24+ 或兼容 .NET Standard 2.0 的实现。Go 需安装并认证 GitHub Copilot CLI;TypeScript、Python、.NET 包默认自带运行时,无需单独安装 CLI。
安装:Node.js/TypeScript 执行 npm install @github/copilot-sdk tsx;Python 执行 pip install github-copilot-sdk,可选 python -m copilot download-runtime 预下载运行时;Go 执行 go get github.com/github/copilot-sdk/go;.NET 执行 dotnet add package GitHub.Copilot.SDK。
用法示例(TypeScript):创建 CopilotClient,createSession 时传入 onPermissionRequest: approveAll 与 model,调用 session.sendAndWait 获取回复。
限制:具体模型可用性、权限审批行为、收费与价格资料暂未提供;MCP 集成需要相应服务器地址与认证。资料在 Custom Agents 段落处截断,该部分细节暂未提供。