跳到正文
FunCoding

搜索

搜索文档、Skill 和 MCP

Copilot SDK

将 Copilot 会话、流式输出与工具调用接入应用,并选择运行与认证方式。

Copilot SDK 将会话、事件、工具和 Hooks 提供给应用代码。常见方式是 SDK 通过 JSON-RPC 与 Copilot runtime 通信;runtime 可以由 SDK 管理为 CLI 子进程,也可以作为独立服务运行。实验性的进程内模式保留 JSON-RPC 协议,但不启动 CLI 子进程。

先选择运行方式

场景文档
首次调用、接收流式响应、定义工具快速开始
随应用分发匹配 runtime自动管理 CLI
固定本机 CLI 路径或使用 Go 等 SDK本地 CLI
在宿主进程加载原生库进程内 runtime
长期运行的后端或多个客户端共用服务后端服务
多个用户、工作区或租户多租户配置、扩展与存储

再选择身份来源

本机个人工具可以使用已登录 CLI 的凭据。面向用户的应用通常通过GitHub OAuth接入;服务自动化可以使用组织安装令牌。

使用自有模型时采用BYOK,Azure 部署还可用Managed Identity。令牌优先级见认证,短期用户令牌的回调刷新见会话令牌轮换。

不把 SDK 选项当作应用授权

SDK 提供会话状态和会话级身份机制,但请求路由、用户登录、会话归属和业务工具授权由应用负责。共享服务器必须显式设置可用工具与身份,不能用个人 CLI 默认配置直接承接所有用户。

会话与交互

扩展与输入输出

Hooks

SDK Hooks涵盖工具执行前后、输入转换、会话生命周期、停止前验证和错误恢复。SDK 回调与 CLI/云端的配置文件 Hooks 分开说明。

远程运行与维护

本节文档