先决条件

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+

安装

架构

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

SDK 自动管理 CLI 生命周期。支持通过 cliUrl / cli_url 进行外部服务器连接。

快速开始 (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

事件

处理过程中的关键事件：

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

流式传输

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

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

可用模型

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

自定义工具

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。

语言约定

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

CLI 配置

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

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

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

故障排除

调试技巧，请参阅 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

每周安装量

204

仓库

doggy8088/agent-skills

首次出现

2026 年 1 月 29 日

安全审计

Gen Agent Trust HubPassSocketPassSnykWarn

安装于

github-copilot198

gemini-cli98

codex88

opencode55

claude-code40

antigravity39

Prerequisites

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

Installation

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:

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.

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

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

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

• SDK Samples
• SDK Releases
• Cookbook
• awesome-copilot

Weekly Installs

204

Repository

doggy8088/agent-skills

First Seen

Jan 29, 2026

Security Audits

Gen Agent Trust HubPassSocketPassSnykWarn

Installed on

github-copilot198

gemini-cli98

codex88

opencode55

claude-code40

antigravity39