SuperAPI AI 工具集

copilot-python-sdk

编程与开发

查看项目

更新于 10-16 07:14

技能介绍

用途:通过 Python 代码以 JSON-RPC 协议以编程方式控制 GitHub Copilot CLI,适合在自动化流程或智能体应用中驱动 Copilot 会话。资料说明若要从另一个 agent 驱动 copilot.exe(一次性 -p、resume、winget),应使用 copilot-harness。

主要能力:完整 JSON-RPC 协议支持,stdio 与 TCP 传输,实时流式事件,会话历史(get_messages()),全程类型提示,原生 async/await,异步上下文管理器自动资源清理。支持自定义工具(@define_tool 装饰器配 Pydantic 模型,或底层 Tool/ToolResult API),可覆盖内置工具(需 overrides_built_in_tool=True),可跳过权限提示(skip_permission=True),支持图片附件(文件路径或 base64 blob),支持流式增量输出、无限会话与上下文压缩、自定义 OpenAI 兼容提供方(BYOK,含 Ollama、Azure、Anthropic),以及会话生命周期事件订阅。

必要用法:安装可用 pip install -e ".[telemetry,dev]" 或 uv pip install -e ".[telemetry,dev]";运行示例 cd python/samples 后 python chat.py。核心对象为 CopilotClient,可传 SubprocessConfig(本地 CLI 进程)或 ExternalServerConfig(url=...)(连接已有服务器);create_session() 时 on_permission_request 为必填,可用 PermissionHandler.approve_all,并需指定 model(如 "gpt-5")。

适用场景:需要脚本化驱动 Copilot CLI、将其集成进自动化或多步会话流程、注册项目自有工具或接入自定义模型端点的场景。

限制:该 SDK 处于技术预览,可能以破坏性方式变更;使用自定义提供方时必须显式指定 model;注册与内置工具同名的工具会报错,除非显式声明覆盖;资料未提供收费、价格与平台支持细节。