GitHub Copilot SDK 开发指南：多语言AI代理集成与自动化编程

copilot-sdk by intellectronica/agent-skills

168 周安装量

228 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/intellectronica/agent-skills --skill copilot-sdk

AI/机器学习开发自动化

🇨🇳中文介绍

GitHub Copilot SDK

概述

GitHub Copilot SDK 是一个多平台代理运行时，可将 Copilot 的代理工作流嵌入到应用程序中。它公开了 Copilot CLI 背后的相同引擎，无需开发自定义编排即可实现程序化调用。

状态： 技术预览版（适用于开发和测试）

支持的语言： TypeScript/Node.js、Python、Go、.NET

主要文档

特定语言 SDK 文档

CLI 和配置文档

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

快速开始 (TypeScript)

import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient();
await client.start();

const session = await client.createSession({ model: "gpt-5" });

// 在 send() 之前注册处理器
session.on((event) => {
  if (event.type === "assistant.message") {
    console.log(event.data.content);
  }
});

await session.send({ prompt: "What is 2 + 2?" });

await session.destroy();
await client.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`	完整响应
`assistant.message_delta`	流式传输片段
`session.idle`	准备接收下一个提示
`tool.execution_start/end`	工具调用

有关完整的事件生命周期和 SessionEvent 结构，请参阅 references/event-system.md。

streaming: false (默认) - 内容一次性到达
streaming: true - 内容通过 assistant.message_delta 增量到达

无论流式传输设置如何，最终的 assistant.message 总会触发。

完整列表请参阅支持的 AI 模型。

提供商	模型 ID	备注
OpenAI	`gpt-4.1`, `gpt-5`, `gpt-5-mini`	已包含
OpenAI	`gpt-5.1`, `gpt-5.1-codex`, `gpt-5.2`	高级版
Anthropic	`claude-sonnet-4.5`	高级版 (CLI 默认)
Anthropic	`claude-opus-4.5`	高级版 (3× 乘数)
Google	`gemini-3-pro-preview`	高级版

TypeScript (Zod):

const tool = defineTool("lookup_issue", {
  description: "Fetch issue details",
  parameters: z.object({ id: z.string() }),
  handler: async ({ id }) => fetchIssue(id),
});

Python (Pydantic):

@define_tool(description="Fetch issue details")
async def lookup_issue(params: IssueParams) -> dict:
    return fetch_issue(params.id)

有关所有语言的完整工具示例，请参阅 references/working-examples.md。

概念	TypeScript	Python	Go	.NET
创建会话	`createSession()`	`create_session()`	`CreateSession()`	`CreateSessionAsync()`
增量内容	`deltaContent`	`delta_content`	`DeltaContent`	`DeltaContent`

完整的约定表格，请参阅 references/event-system.md。

配置存储在 ~/.copilot/ 目录下：

config.json - 通用配置
mcp-config.json - MCP 服务器定义

有关自定义代理和 MCP 设置，请参阅 references/cli-agents-mcp.md。

问题	解决方案
事件触发但内容为空	使用 `event.data.content`，而不是 `event.content`
处理器从未触发	在 `send()` 之前注册
Python 枚举问题	使用 `event.type.value`
Go 空指针	在解引用前检查 `!= nil`

有关调试技巧，请参阅 references/troubleshooting.md。

本技能中的详细文档：

references/working-examples.md - 所有语言、自定义工具的完整示例
references/event-system.md - 事件生命周期、SessionEvent 结构、语言约定
references/troubleshooting.md - 常见问题、调试技巧
references/cli-agents-mcp.md - CLI 配置、自定义代理、MCP 服务器设置

🇺🇸English

GitHub Copilot SDK

Overview

The GitHub Copilot SDK is a multi-platform agent runtime that embeds Copilot's agentic workflows into applications. It exposes the same engine behind Copilot CLI, enabling programmatic invocation without requiring custom orchestration development.

Status: Technical Preview (suitable for development and testing)

Supported Languages: TypeScript/Node.js, Python, Go, .NET

Primary Documentation

Language-Specific SDK Docs

CLI and Configuration Docs

Prerequisites

GitHub Copilot Subscription - Pro, Pro+, Business, or Enterprise
GitHub Copilot CLI - Installed and authenticated (copilot --version)
Runtime: Node.js 18+, Python 3.8+, Go 1.21+, or .NET 8.0+

Installation

Language	Command
TypeScript/Node.js	`npm install @github/copilot-sdk`
Python	`pip install github-copilot-sdk`
Go	`go get github.com/github/copilot-sdk/go`
.NET	`dotnet add package GitHub.Copilot.SDK`

Architecture

Application → SDK Client → JSON-RPC → Copilot CLI (server mode)

The SDK manages CLI lifecycle automatically. External server connections supported via cliUrl / cli_url.

Quick Start (TypeScript)

import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient();
await client.start();

const session = await client.createSession({ model: "gpt-5" });

// Register handler BEFORE send()
session.on((event) => {
  if (event.type === "assistant.message") {
    console.log(event.data.content);
  }
});

await session.send({ prompt: "What is 2 + 2?" });

await session.destroy();
await client.stop();

Critical: Register event handlers before calling send() to capture all events.

For complete examples in all languages, see references/working-examples.md.

Core Concepts

Client

Main entry point. Manages CLI server lifecycle and session creation.

Operations: start(), stop(), createSession(), resumeSession()

Config: cliPath, cliUrl, port, useStdio, autoStart, autoRestart

Session

Individual conversation context with message history.

Operations: send(), sendAndWait(), on(), abort(), getMessages(), destroy()

Config: model, streaming, tools, systemMessage

Events

Key events during processing:

Event	Purpose
`assistant.message`	Complete response
`assistant.message_delta`	Streaming chunk
`session.idle`	Ready for next prompt
`tool.execution_start/end`	Tool invocations

For full event lifecycle and SessionEvent structure, see references/event-system.md.

Streaming

streaming: false (default) - Content arrives all at once
streaming: true - Content arrives incrementally via assistant.message_delta

Final assistant.message always fires regardless of streaming setting.

Available Models

See Supported AI Models for full list.

Provider	Model ID	Notes
OpenAI	`gpt-4.1`, `gpt-5`, `gpt-5-mini`	Included
OpenAI	`gpt-5.1`, `gpt-5.1-codex`, `gpt-5.2`	Premium
Anthropic	`claude-sonnet-4.5`	Premium (CLI default)

Custom Tools

TypeScript (Zod):

const tool = defineTool("lookup_issue", {
  description: "Fetch issue details",
  parameters: z.object({ id: z.string() }),
  handler: async ({ id }) => fetchIssue(id),
});

Python (Pydantic):

@define_tool(description="Fetch issue details")
async def lookup_issue(params: IssueParams) -> dict:
    return fetch_issue(params.id)

For complete tool examples in all languages, see references/working-examples.md.

Language Conventions

Concept	TypeScript	Python	Go	.NET
Create session	`createSession()`	`create_session()`	`CreateSession()`	`CreateSessionAsync()`
Delta content	`deltaContent`	`delta_content`	`DeltaContent`

For full conventions table, see references/event-system.md.

CLI Configuration

Config stored in ~/.copilot/:

config.json - General configuration
mcp-config.json - MCP server definitions

For custom agents and MCP setup, see references/cli-agents-mcp.md.

Troubleshooting

Problem	Solution
Events fire but content empty	Use `event.data.content`, not `event.content`
Handler never fires	Register before `send()`
Python enum issues	Use `event.type.value`
Go nil pointer	Check `!= nil` before dereferencing

For debugging techniques, see references/troubleshooting.md.

Skill References

Detailed documentation in this skill:

references/working-examples.md - Complete examples for all languages, custom tools
references/event-system.md - Event lifecycle, SessionEvent structure, language conventions
references/troubleshooting.md - Common issues, debugging techniques
references/cli-agents-mcp.md - CLI configuration, custom agents, MCP server setup

Additional Resources

Weekly Installs

168

Repository

intellectronica…t-skills

GitHub Stars

228

First Seen

Jan 23, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykWarn

Installed on

codex131

opencode130

claude-code127

gemini-cli126

github-copilot122

cursor112

agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试

152,900 周安装

GitHub Copilot SDK 开发指南：多语言AI代理集成与自动化编程

🇨🇳中文介绍

GitHub Copilot SDK

概述

主要文档

特定语言 SDK 文档

CLI 和配置文档

相关 Skills

先决条件

安装

架构

快速开始 (TypeScript)

核心概念

客户端

会话

事件

流式传输

可用模型

自定义工具

语言约定

CLI 配置

故障排除

技能参考

其他资源

🇺🇸English

GitHub Copilot SDK

Overview

Primary Documentation

Language-Specific SDK Docs

CLI and Configuration Docs

Prerequisites

Installation

Architecture

Quick Start (TypeScript)

Core Concepts

Client

Session

Events

Streaming

Available Models

Custom Tools

Language Conventions

CLI Configuration

Troubleshooting

Skill References

Additional Resources

最新 Skills