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")
);
```
### Diretório de log
A CLI grava logs em um diretório. Você pode especificar um local personalizado:
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]
> A configuração de logging do SDK do Python é limitada. Para logs avançados, execute a CLI manualmente com `--log-dir` e conecte-se por meio de `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 comuns
### "CLI não encontrada" / "Copilot: comando não encontrado"
**Cause:** A CLI do Copilot não está instalada ou não está no PATH.
**Solution:**
1. Instalar a CLI: [Guia de instalação](/pt/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli)
2. Verifique a instalação:
```bash
copilot --version
```
3. Ou especifique o caminho completo:
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")
);
```
### "Não autenticado"
**Cause:** a CLI não é autenticada com GitHub.
**Solution:**
1. Autenticar a interface de linha de comando (CLI):
```bash
copilot auth login
```
2. Ou forneça um token programaticamente:
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"))
);
```
### "Sessão não encontrada"
**Causa:** Tentando usar uma sessão que foi destruída ou não existe.
**Solution:**
1. Verifique se você não está chamando métodos após `disconnect()`:
```typescript
await session.disconnect();
// Don't use session after this!
```
2. Para retomar as sessões, verifique se a ID da sessão existe:
```typescript
const sessions = await client.listSessions();
console.log("Available sessions:", sessions);
```
### "Conexão recusada" / "ECONNREFUSED"
**Causa:** O processo do servidor da CLI falhou ou falhou ao iniciar.
**Solution:**
1. Verifique se a CLI é executada corretamente autônoma:
```bash
copilot --server --stdio
```
2. Verifique se há conflitos de porta se estiver usando o modo TCP:
```typescript
const client = new CopilotClient({
useStdio: false,
port: 0, // Use random available port
});
```
## Depuração do servidor MCP
Os servidores MCP (Protocolo de Contexto de Modelo) podem ser complicados de depurar. Para obter orientações completas sobre a depuração do MCP, consulte o **[Guia de depuração do servidor MCP](/pt/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging)** específico.
### Lista de verificação rápida do MCP
* [ ] O executável do servidor MCP existe e é executado de forma independente
* [ ] O caminho do comando está correto (use caminhos absolutos)
* [ ] As ferramentas estão habilitadas: `tools: ["*"]`
* [ ] O servidor responde à `initialize` solicitação corretamente
* [ ] O diretório de trabalho (`cwd`) é definido, se necessário
### Testar o servidor MCP
Antes de integrar com o SDK, verifique se o 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 [Guia de depuração do servidor MCP](/pt/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) para obter uma solução de problemas detalhada.
## Problemas de conexão
### modo stdio vs TCP
O SDK dá suporte a dois modos de transporte:
| Modo | Description | Caso de uso |
| ------------------ | -------------------------------------------------------------------- | ------------------------------------- |
| **Stdio** (padrão) | A CLI é executada como subprocesso, comunica-se por meio de pipes | Desenvolvimento local, processo único |
| **TCP** | A CLI é executada separadamente, comunica-se por meio do soquete TCP | Vários clientes, CLI remota |
**Modo stdio (padrão):**
```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
});
```
**Conecte-se ao servidor existente:**
```typescript
const client = new CopilotClient({
cliUrl: "localhost:8080", // Connect to running server
});
```
### Diagnosticando falhas de conexão
1. **Verifique o estado do cliente:**
```typescript
console.log("Connection state:", client.getState());
// Should be "connected" after start()
```
2. **Ouça as alterações de estado:**
```typescript
client.on("stateChange", (state) => {
console.log("State changed to:", state);
});
```
3. **Verifique se o processo da CLI está em execução:**
```bash
# Check for copilot processes
ps aux | grep copilot
```
## Problemas de execução da ferramenta
### Ferramenta personalizada não está sendo chamada
1. **Verificar o registro da ferramenta:**
```typescript
const session = await client.createSession({
tools: [myTool],
});
// Check registered tools
console.log("Registered tools:", session.getTools?.());
```
2. **Verificar se o esquema da ferramenta é um 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. **Verifique se o manipulador retorna o 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
}
```
### Erros de ferramenta que não são exibidos
Inscreva-se em eventos de erro:
```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 da plataforma
### Windows
1. **Separadores de caminho:** use strings brutas ou barras:
```csharp
CliPath = @"C:\Program Files\GitHub\copilot.exe"
// or
CliPath = "C:/Program Files/GitHub/copilot.exe"
```
2. **Resolução PATHEXT:** O SDK lida com isso automaticamente, mas se os problemas persistirem:
```csharp
// Explicitly specify .exe
Command = "myserver.exe" // Not just "myserver"
```
3. **Codificação do console:** Certifique-se de UTF-8 para tratamento JSON adequado:
```csharp
Console.OutputEncoding = System.Text.Encoding.UTF8;
```
### macOS
1. **Problemas do gatekeeper:** Se a CLI estiver bloqueada:
```bash
xattr -d com.apple.quarantine /path/to/copilot
```
2. **Problemas de PATH em aplicativos de GUI:** Os aplicativos de GUI podem não herdar o PATH do shell:
```typescript
const client = new CopilotClient({
cliPath: "/opt/homebrew/bin/copilot", // Full path
});
```
### Linux
1. **Problemas de permissão:**
```bash
chmod +x /path/to/copilot
```
2. **Bibliotecas ausentes:** Verifique se há bibliotecas compartilhadas necessárias:
```bash
ldd /path/to/copilot
```
## Obtendo ajuda
Se você ainda estiver preso:
1. **Coletar informações de depuração:**
* Versão do SDK
* Versão da CLI (`copilot --version`)
* Sistema operacional
* Registros de depuração
* Código de reprodução mínimo
2. **Pesquisar problemas existentes:**[problemas do GitHub](https://github.com/github/copilot-sdk/issues)
3. **Abrir um novo problema** com as informações coletadas
## Consulte também
* [Crie seu primeiro aplicativo com tecnologia do Copilot](/pt/copilot/how-tos/copilot-sdk/getting-started)
* [Usando servidores MCP com o SDK do GitHub Copilot](/pt/copilot/how-tos/copilot-sdk/features/mcp) - Configuração e instalação do MCP
* [Guia de depuração do servidor MCP](/pt/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) – Solução de problemas detalhada do MCP
* [Referência da API](https://github.com/github/copilot-sdk)