copilot-sdk

GitHub Copilot SDK Integration

Integrate @github/copilot-sdk for AI-powered agent sessions with streaming responses and tool calling.

When to Use This Skill

• Setting up Copilot SDK in Electron main process
• Implementing streaming chat completions
• Defining tools for agent function calling
• Managing conversation context
• Handling tool execution results
• Building decision points with user approval

SDK Setup

Installation and Authentication

// src/main/copilot/client.ts
import { CopilotClient } from '@github/copilot-sdk';

let client: CopilotClient | null = null;

export async function initializeCopilotClient(): Promise<CopilotClient> {
  if (client) return client;

  // The SDK handles GitHub authentication automatically
  // User must be authenticated with GitHub Copilot
  client = new CopilotClient({
    // Optional: Custom endpoint for GitHub Enterprise
    // baseUrl: 'https://api.github.com',
  });

  return client;
}

export function getCopilotClient(): CopilotClient {
  if (!client) {
    throw new Error('Copilot client not initialized. Call initializeCopilotClient first.');
  }
  return client;
}

Tool Definitions

// src/main/copilot/tools.ts
import type { Tool, ToolResult } from '@github/copilot-sdk';

// Define tools the agent can use
export const agentTools: Tool[] = [
  {
    name: 'create_file',
    description: 'Create a new file with the specified content',
    parameters: {
      type: 'object',
      properties: {
        path: {
          type: 'string',
          description: 'The file path relative to the project root',
        },
        content: {
          type: 'string',
          description: 'The content to write to the file',
        },
      },
      required: ['path', 'content'],
    },
  },
  {
    name: 'edit_file',
    description: 'Edit an existing file by replacing content',
    parameters: {
      type: 'object',
      properties: {
        path: {
          type: 'string',
          description: 'The file path relative to the project root',
        },
        search: {
          type: 'string',
          description: 'The exact text to find and replace',
        },
        replace: {
          type: 'string',
          description: 'The replacement text',
        },
      },
      required: ['path', 'search', 'replace'],
    },
  },
  {
    name: 'run_command',
    description: 'Execute a shell command in the project directory',
    parameters: {
      type: 'object',
      properties: {
        command: {
          type: 'string',
          description: 'The shell command to execute',
        },
        cwd: {
          type: 'string',
          description: 'Working directory (optional)',
        },
      },
      required: ['command'],
    },
  },
  {
    name: 'read_file',
    description: 'Read the contents of a file',
    parameters: {
      type: 'object',
      properties: {
        path: {
          type: 'string',
          description: 'The file path to read',
        },
      },
      required: ['path'],
    },
  },
  {
    name: 'request_approval',
    description: 'Request user approval before proceeding with a sensitive action',
    parameters: {
      type: 'object',
      properties: {
        action: {
          type: 'string',
          description: 'Description of the action requiring approval',
        },
        details: {
          type: 'string',
          description: 'Detailed explanation of what will happen',
        },
        risk_level: {
          type: 'string',
          enum: ['low', 'medium', 'high'],
          description: 'Risk level of the action',
        },
      },
      required: ['action', 'details'],
    },
  },
];