TypeScript
```typescript
import { CopilotClient } from "@github/copilot-sdk";
const client = new CopilotClient({
logLevel: "debug", // Options: "none", "error", "warning", "info", "debug", "all"
});
```
Python
```python
from copilot import CopilotClient
client = CopilotClient(log_level="debug")
```
Go
```golang
import copilot "github.com/github/copilot-sdk/go"
client := copilot.NewClient(&copilot.ClientOptions{
LogLevel: "debug",
})
```
.NET
```csharp
using GitHub.Copilot;
using Microsoft.Extensions.Logging;
// Using ILogger
var loggerFactory = LoggerFactory.Create(builder =>
{
builder.SetMinimumLevel(LogLevel.Debug);
builder.AddConsole();
});
var client = new CopilotClient(new CopilotClientOptions
{
LogLevel = "debug",
Logger = loggerFactory.CreateLogger
()
});
```
Java
```java
import com.github.copilot.CopilotClient;
import com.github.copilot.rpc.*;
var client = new CopilotClient(new CopilotClientOptions()
.setLogLevel("debug")
);
```
### Directorio de logs
La CLI escribe registros en un directorio. Puede especificar una ubicación personalizada:
TypeScript
```typescript
const client = new CopilotClient({
cliArgs: ["--log-dir", "/path/to/logs"],
});
```
Python
```python
# The Python SDK does not currently support passing extra CLI arguments.
# Logs are written to the default location or can be configured via
# the CLI when running in server mode.
```
> \[!NOTE]
> La configuración de registro del SDK de Python está limitada. Para el registro avanzado, ejecute la CLI manualmente con `--log-dir` y conéctese mediante `RuntimeConnection.for_uri(...)`.
Go
```golang
client := copilot.NewClient(&copilot.ClientOptions{
Connection: copilot.StdioConnection{
Args: []string{"--log-dir", "/path/to/logs"},
},
})
```
.NET
```csharp
var client = new CopilotClient(new CopilotClientOptions
{
Connection = RuntimeConnection.ForStdio(args: new[] { "--log-dir", "/path/to/logs" })
});
```
Java
```java
// The Java SDK does not currently support passing extra CLI arguments.
// For custom log directories, run the CLI manually with --log-dir
// and connect via cliUrl.
```
## Problemas comunes
### "CLI no encontrada" / "Copilot: comando no encontrado"
**Cause:** La CLI de Copilot no está instalada o no en PATH.
**Solution:**
1. Instalación de la CLI: [Guía de instalación](/es/enterprise-cloud@latest/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli)
2. Compruebe la instalación:
```bash
copilot --version
```
3. O especifique la ruta de acceso completa:
JavaScript
```typescript
const client = new CopilotClient({
cliPath: "/usr/local/bin/copilot",
});
```
Python
```python
client = CopilotClient({"cli_path": "/usr/local/bin/copilot"})
```
Go
```golang
client := copilot.NewClient(&copilot.ClientOptions{
Connection: copilot.StdioConnection{Path: "/usr/local/bin/copilot"},
})
```
.NET
```csharp
var client = new CopilotClient(new CopilotClientOptions
{
CliPath = "/usr/local/bin/copilot"
});
```
Java
```java
var client = new CopilotClient(new CopilotClientOptions()
.setCliPath("/usr/local/bin/copilot")
);
```
### "No autenticado"
**Cause:** La CLI no se autentica con GitHub.
**Solution:**
1. Autenticar la CLI:
```bash
copilot auth login
```
2. O bien, proporcione un token mediante programación:
JavaScript
```typescript
const client = new CopilotClient({
gitHubToken: process.env.GITHUB_TOKEN,
});
```
Python
```python
import os
client = CopilotClient({"github_token": os.environ.get("GITHUB_TOKEN")})
```
Go
```golang
client := copilot.NewClient(&copilot.ClientOptions{
GitHubToken: os.Getenv("GITHUB_TOKEN"),
})
```
.NET
```csharp
var client = new CopilotClient(new CopilotClientOptions
{
GitHubToken = Environment.GetEnvironmentVariable("GITHUB_TOKEN")
});
```
Java
```java
var client = new CopilotClient(new CopilotClientOptions()
.setGitHubToken(System.getenv("GITHUB_TOKEN"))
);
```
### "Sesión no encontrada"
**Causa:** Intentar usar una sesión que se destruyó o no existe.
**Solution:**
1. Asegúrese de que no llama a métodos después de `disconnect()`.
```typescript
await session.disconnect();
// Don't use session after this!
```
2. Para reanudar sesiones, compruebe que el identificador de sesión existe:
```typescript
const sessions = await client.listSessions();
console.log("Available sessions:", sessions);
```
### "Conexión rechazada" / "ECONNREFUSED"
**Causa:** El proceso del servidor de la CLI se bloqueó o no se pudo iniciar.
**Solution:**
1. Compruebe si la CLI se ejecuta correctamente de forma independiente:
```bash
copilot --server --stdio
```
2. Compruebe si hay conflictos de puertos si usa el modo TCP:
```typescript
const client = new CopilotClient({
useStdio: false,
port: 0, // Use random available port
});
```
## Depuración del servidor MCP
Los servidores MCP (Protocolo de Contexto de Modelo) pueden resultar complicados de depurar. Para obtener una guía completa sobre la depuración de MCP, consulte **[Guía de depuración del servidor MCP](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging)**.
### Lista de comprobación rápida de MCP
* [ ] El ejecutable del servidor MCP existe y se ejecuta de forma independiente
* [ ] La ruta de acceso del comando es correcta (utilice rutas de acceso absolutas)
* [ ] Las herramientas están habilitadas: `tools: ["*"]`
* [ ] El servidor responde a la `initialize` solicitud correctamente
* [ ] El directorio de trabajo (`cwd`) se establece si es necesario.
### Prueba del servidor MCP
Antes de realizar la integración con el SDK, compruebe que el servidor MCP funciona:
```bash
echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"test","version":"1.0"}}}' | /path/to/your/mcp-server
```
Consulte [Guía de depuración del servidor MCP](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) para obtener una solución de problemas detallada.
## Problemas de conexión
### stdio frente al modo TCP
El SDK admite dos modos de transporte:
| Modo | Description | Caso de uso |
| -------------------------------- | -------------------------------------------------------------------------- | ------------------------------- |
| **Stdio** (valor predeterminado) | La CLI se ejecuta como subproceso, se comunica a través de canalizaciones. | Desarrollo local, proceso único |
| **TCP** | La CLI se ejecuta por separado, se comunica a través del socket TCP. | Varios clientes, CLI remota |
**Modo Stdio (valor predeterminado):**
```typescript
const client = new CopilotClient({
useStdio: true, // This is the default
});
```
**Modo TCP:**
```typescript
const client = new CopilotClient({
useStdio: false,
port: 8080, // Or 0 for random port
});
```
**Conéctese al servidor existente:**
```typescript
const client = new CopilotClient({
cliUrl: "localhost:8080", // Connect to running server
});
```
### Diagnóstico de errores de conexión
1. **Compruebe el estado del cliente:**
```typescript
console.log("Connection state:", client.getState());
// Should be "connected" after start()
```
2. **Escuche los cambios de estado:**
```typescript
client.on("stateChange", (state) => {
console.log("State changed to:", state);
});
```
3. **Compruebe que el proceso de la CLI se está ejecutando:**
```bash
# Check for copilot processes
ps aux | grep copilot
```
## Problemas de ejecución de herramientas
### No se llama a la herramienta personalizada
1. **Compruebe el registro de herramientas:**
```typescript
const session = await client.createSession({
tools: [myTool],
});
// Check registered tools
console.log("Registered tools:", session.getTools?.());
```
2. **Comprobar el esquema de la herramienta es un esquema JSON válido:**
```typescript
const myTool = {
name: "get_weather",
description: "Get weather for a location",
parameters: {
type: "object",
properties: {
location: { type: "string", description: "City name" },
},
required: ["location"],
},
handler: async (args) => {
return { temperature: 72 };
},
};
```
3. **Asegúrese de que el controlador devuelve un resultado válido:**
```typescript
handler: async (args) => {
// Must return something JSON-serializable
return { success: true, data: "result" };
// Don't return undefined or non-serializable objects
}
```
### Errores de herramientas que no se muestran
Suscríbase a eventos de error:
```typescript
session.on("tool.execution_error", (event) => {
console.error("Tool error:", event.data);
});
session.on("error", (event) => {
console.error("Session error:", event.data);
});
```
## Problemas específicos de la plataforma
### Windows
1. **Separadores de ruta:** Use cadenas literales o barras diagonales:
```csharp
CliPath = @"C:\Program Files\GitHub\copilot.exe"
// or
CliPath = "C:/Program Files/GitHub/copilot.exe"
```
2. **Resolución PATHEXT:** El SDK controla esto automáticamente, pero si los problemas persisten:
```csharp
// Explicitly specify .exe
Command = "myserver.exe" // Not just "myserver"
```
3. **Codificación de la consola:** Asegúrese de usar UTF-8 para un manejo correcto de JSON:
```csharp
Console.OutputEncoding = System.Text.Encoding.UTF8;
```
### macOS
1. **Problemas de Gatekeeper:** Si la CLI está bloqueada:
```bash
xattr -d com.apple.quarantine /path/to/copilot
```
2. **Problemas de PATH en las aplicaciones de GUI:** Es posible que las aplicaciones de GUI no hereden path del shell:
```typescript
const client = new CopilotClient({
cliPath: "/opt/homebrew/bin/copilot", // Full path
});
```
### Linux
1. **Problemas de permisos:**
```bash
chmod +x /path/to/copilot
```
2. **Faltan bibliotecas:** Compruebe si hay bibliotecas compartidas necesarias:
```bash
ldd /path/to/copilot
```
## Obtener ayuda
Si sigues atascado:
1. **Recopilar información de depuración:**
* Versión del SDK
* Versión de la CLI (`copilot --version`)
* Sistema operativo
* Registros de depuración
* Código de reproducción mínimo
2. **Buscar problemas existentes:**[problemas de GitHub](https://github.com/github/copilot-sdk/issues)
3. **Abrir una nueva incidencia** con la información recopilada
## Consulte también
* [Crea tu primera aplicación con tecnología Copilot](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/getting-started)
* [Uso de servidores MCP con el SDK de GitHub Copilot](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/mcp) - configuración y puesta en marcha de MCP
* [Guía de depuración del servidor MCP](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) : solución de problemas detallada de MCP
* [Referencia de API](https://github.com/github/copilot-sdk)