github / github/copilot-sdk

Expose real-time context/usage metrics in the Copilot SDK

Abierto
#1,516 0 comentarios 2 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Java
Estrellas
10.5k
Forks
1.5k
Merge medio
1 d 11 h
PR fusionados (30 d)
128

Descripción

**Summary**

Today the Copilot CLI provides /context and /usage as first-class UX commands, but the SDK docs do not expose an equivalent stable API for apps to fetch the same information directly.

This makes it hard to build a UI that shows live session context pressure, token usage, and compaction status in real time or near-real time. The closest available surfaces appear to be streaming events like session.usage_info, assistant.usage, and compaction/session lifecycle events, but these are event-based and ephemeral rather than a documented queryable API.

**Request**

- Add a documented SDK method or session API for retrieving current context/window usage on demand.
- Add a documented session usage API for current/aggregate token and cost metrics.
- Clarify which usage events are ephemeral vs persisted and what is available after resume.
- Provide a stable event/schema contract for session.idle and related lifecycle events.

Why this matters

- Enables apps to render accurate live context bars and usage dashboards.
- Avoids relying on internal/undocumented event shapes.
- Makes Copilot SDK easier to integrate into production UIs.

Docs gap noted

- The SDK docs mention session.usage_info and assistant.usage, but there is no explicit “fetch current context usage now” API like the CLI’s /context command.
- session.idle appears to have inconsistent payload documentation across pages.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza revisando la documentación del SDK para session.usage_info, assistant.usage, session.idle y los eventos de compaction o del ciclo de vida; después, compara esas superficies con los comandos /context y /usage de la CLI. Se considera terminado cuando el SDK documenta APIs estables bajo demanda para el contexto y el uso, explica la persistencia de eventos y el comportamiento al reanudar, y define los esquemas de los eventos relevantes del ciclo de vida.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
api, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.