Compatibilité du Kit de développement logiciel (SDK) et de l’interface

Kit de développement logiciel (SDK) GitHub Copilot communique avec CLI GitHub Copilot via le protocole JSON-RPC. Les fonctionnalités doivent être explicitement exposées via ce protocole pour être disponibles dans le Kit de développement logiciel (SDK). De nombreuses fonctionnalités cli interactives sont spécifiques au terminal et non disponibles par programme.

Comparaison des fonctionnalités

Disponible dans le Kit de développement logiciel (SDK)

Non disponible dans le Kit de développement logiciel (CLI uniquement)

Solutions de contournement

Exportation de session

L’option --share n’est pas disponible via le Kit de développement logiciel (SDK). Pour contourner ce problème :

• Collectez manuellement les événements : Abonnez-vous aux événements de session et générez votre propre exportation :

  TypeScript

  const events: SessionEvent[] = [];
  session.on((event) => events.push(event));
  // ... after conversation ...
  const messages = await session.getMessages();
  // Format as markdown yourself
  

• Utilisez l’interface CLI directement pour les exportations ponctuelles.

Contrôle d’autorisation

Le Kit de développement logiciel (SDK) utilise un modèle d'autorisation qui refuse par défaut. Toutes les demandes d’autorisation (écritures de fichiers, commandes d’interpréteur de commandes, extractions d’URL et autres) sont refusées, sauf si votre application fournit un onPermissionRequest gestionnaire.

Au lieu de --allow-all-paths ou --yolo, utilisez le gestionnaire d’autorisations :

const session = await client.createSession({
  onPermissionRequest: approveAll,
});

const session = await client.createSession({
  onPermissionRequest: approveAll,
});

Suivi de l’utilisation des jetons

Au lieu de/usage, abonnez-vous aux événements d’utilisation

session.on("assistant.usage", (event) => {
  console.log("Tokens used:", {
    input: event.data.inputTokens,
    output: event.data.outputTokens,
  });
});

session.on("assistant.usage", (event) => {
  console.log("Tokens used:", {
    input: event.data.inputTokens,
    output: event.data.outputTokens,
  });
});

Compactage de contexte

Au lieu de /compact, configurez le compactage automatique ou déclenchez-le manuellement :

// Automatic compaction via config
const session = await client.createSession({
  infiniteSessions: {
    enabled: true,
    backgroundCompactionThreshold: 0.80,  // Start background compaction at 80% context utilization
    bufferExhaustionThreshold: 0.95,      // Block and compact at 95% context utilization
  },
});

// Manual compaction (experimental)
const result = await session.rpc.compaction.compact();
console.log(`Removed ${result.tokensRemoved} tokens, ${result.messagesRemoved} messages`);

// Automatic compaction via config
const session = await client.createSession({
  infiniteSessions: {
    enabled: true,
    backgroundCompactionThreshold: 0.80,  // Start background compaction at 80% context utilization
    bufferExhaustionThreshold: 0.95,      // Block and compact at 95% context utilization
  },
});

// Manual compaction (experimental)
const result = await session.rpc.compaction.compact();
console.log(`Removed ${result.tokensRemoved} tokens, ${result.messagesRemoved} messages`);

Gestion du plan

Lire et écrire des plans de session programmatiquement.

// Read the current plan
const plan = await session.rpc.plan.read();
if (plan.exists) {
  console.log(plan.content);
}

// Update the plan
await session.rpc.plan.update({ content: "# My Plan\n- Step 1\n- Step 2" });

// Delete the plan
await session.rpc.plan.delete();

// Read the current plan
const plan = await session.rpc.plan.read();
if (plan.exists) {
  console.log(plan.content);
}

// Update the plan
await session.rpc.plan.update({ content: "# My Plan\n- Step 1\n- Step 2" });

// Delete the plan
await session.rpc.plan.delete();

Direction des messages

Injecter un message dans le tour actuel du LLM sans interrompre :

// Steer the agent mid-turn
await session.send({ prompt: "Focus on error handling first", mode: "immediate" });

// Default: enqueue for next turn
await session.send({ prompt: "Next, add tests" });

// Steer the agent mid-turn
await session.send({ prompt: "Focus on error handling first", mode: "immediate" });

// Default: enqueue for next turn
await session.send({ prompt: "Next, add tests" });

Limitations du protocole

Le Kit de développement logiciel (SDK) peut accéder uniquement aux fonctionnalités exposées via le protocole JSON-RPC de l’interface CLI. Si vous avez besoin d’une fonctionnalité CLI qui n’est pas disponible :

• Recherchez les alternatives : De nombreuses fonctionnalités ont des équivalents du SDK (voir Solutions de contournement ci-dessus).
• Utilisez directement l’interface CLI : Pour les opérations ponctuelles, appelez l’interface CLI.
• Demandez la fonctionnalité : Ouvrez un problème dans le dépôt github/copilot-sdk pour demander la prise en charge du protocole.

Compatibilité des versions

Le Kit de développement logiciel (SDK) négocie les versions du protocole avec l’interface CLI au démarrage. Le SDK prend en charge les versions de protocole 2 à 3. Lors de la connexion à un serveur CLI v2, le SDK adapte automatiquement les messages tool.call et permission.request au modèle d’événement v3, sans qu’aucun changement de code ne soit nécessaire.

Vous pouvez vérifier les versions au moment de l’exécution :

const status = await client.getStatus();
console.log("Protocol version:", status.protocolVersion);

const status = await client.getStatus();
console.log("Protocol version:", status.protocolVersion);