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")
);
```
### Каталог журналов
CLI записывает журналы в каталог. Вы можете указать пользовательское местоположение:
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]
> Конфигурация логирования Python SDK ограничена. Для продвинутой логировки запускайте CLI вручную с `--log-dir` .`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.
```
## Распространенные проблемы
### "CLI не найден" / "Copilot: команда не найдена"
**Причина:** Copilot CLI не установлен и не установлен в PATH.
**Solution:**
1. Установка CLI: [руководство по установке](/ru/enterprise-cloud@latest/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli)
2. Проверьте установку:
```bash
copilot --version
```
3. Или укажите полный путь:
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")
);
```
### «Не подтвержено»
**Причина:** CLI не аутентифицирован с GitHub.
**Solution:**
1. Аутентифицировать CLI:
```bash
copilot auth login
```
2. Или программно предоставить токен:
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"))
);
```
### «Сессия не найдена»
**Причина:** Попытка использовать сессию, которая была уничтожена или не существует.
**Solution:**
1. Убедитесь, что вы не вызываете методы после `disconnect()`:
```typescript
await session.disconnect();
// Don't use session after this!
```
2. Для возобновления сессий проверьте наличие идентификатора сессии:
```typescript
const sessions = await client.listSessions();
console.log("Available sessions:", sessions);
```
### "Соединение отказано" / "ОТКАЗАНО"
**Причина:** Процесс CLI-сервера вылетел или не запустился.
**Solution:**
1. Проверьте, работает ли CLI самостоятельно:
```bash
copilot --server --stdio
```
2. Проверьте на конфликты портов при использовании режима TCP:
```typescript
const client = new CopilotClient({
useStdio: false,
port: 0, // Use random available port
});
```
## Отладка серверов MCP
Серверы MCP (Model Context Protocol) могут быть сложны в отладке. Для полных рекомендаций по отладке MCP смотрите специальный **[раздел AUTOTITLE](/ru/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging)**.
### Быстрый чек-лист MCP
* [ ] Исполняемый файл сервера MCP существует и работает независимо
* [ ] Путь команды верен (используйте абсолютные пути)
* [ ] Инструменты включены: `tools: ["*"]`
* [ ] Сервер правильно отвечает на `initialize` запрос
* [ ] Рабочая директория (`cwd`) устанавливается при необходимости
### Тестирование сервера MCP
Перед интеграцией с SDK убедитесь, что ваш MCP-сервер работает:
```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
```
См. [Руководство по отладке серверов MCP](/ru/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) для подробного устранения неполадок.
## Проблемы с подключением
### stdio против TCP режима
SDK поддерживает два режима транспорта:
| Режим | Description | Вариант использования |
| ------------------------ | ------------------------------------------------- | --------------------------------- |
| **Stdio** (по умолчанию) | CLI работает как подпроцесс, общается через трубы | Местное развитие, единый процесс |
| **TCP** | CLI работает отдельно, общается через TCP-сокет | Несколько клиентов, удалённый CLI |
**Режим Stdio (по умолчанию):**
```typescript
const client = new CopilotClient({
useStdio: true, // This is the default
});
```
**Режим TCP:**
```typescript
const client = new CopilotClient({
useStdio: false,
port: 8080, // Or 0 for random port
});
```
**Подключитесь к существующему серверу:**
```typescript
const client = new CopilotClient({
cliUrl: "localhost:8080", // Connect to running server
});
```
### Диагностика сбоев соединения
1. **Проверьте состояние клиента:**
```typescript
console.log("Connection state:", client.getState());
// Should be "connected" after start()
```
2. **Слушайте изменения в состоянии:**
```typescript
client.on("stateChange", (state) => {
console.log("State changed to:", state);
});
```
3. **Проверьте, что процесс CLI запущен:**
```bash
# Check for copilot processes
ps aux | grep copilot
```
## Проблемы с выполнением инструментов
### Пользовательский инструмент не вызывается
1. **Проверьте регистрацию инструмента:**
```typescript
const session = await client.createSession({
tools: [myTool],
});
// Check registered tools
console.log("Registered tools:", session.getTools?.());
```
2. **Check Tool Scheme is valid JSON Schema:**
```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. **Убедитесь, что обработчик возвращает действительный результат:**
```typescript
handler: async (args) => {
// Must return something JSON-serializable
return { success: true, data: "result" };
// Don't return undefined or non-serializable objects
}
```
### Ошибки инструмента не появляются
Подписывайтесь на события ошибок:
```typescript
session.on("tool.execution_error", (event) => {
console.error("Tool error:", event.data);
});
session.on("error", (event) => {
console.error("Session error:", event.data);
});
```
## Проблемы, связанные с платформой
### Windows
1. **Сепараторы путей:** Используйте необработанные струны или прямые слэшы:
```csharp
CliPath = @"C:\Program Files\GitHub\copilot.exe"
// or
CliPath = "C:/Program Files/GitHub/copilot.exe"
```
2. **Разрешение PATHEXT:** SDK обрабатывает это автоматически, но если проблемы сохраняются:
```csharp
// Explicitly specify .exe
Command = "myserver.exe" // Not just "myserver"
```
3. **Консольное кодирование:** Убедитесь, что UTF-8 для правильной обработки JSON:
```csharp
Console.OutputEncoding = System.Text.Encoding.UTF8;
```
### macOS
1. **Проблемы с хранителями врат:** Если CLI заблокирован:
```bash
xattr -d com.apple.quarantine /path/to/copilot
```
2. **Проблемы с PATH в GUI-приложениях:** GUI-приложения не могут наследовать PATH оболочки:
```typescript
const client = new CopilotClient({
cliPath: "/opt/homebrew/bin/copilot", // Full path
});
```
### Linux
1. **Проблемы с разрешениями:**
```bash
chmod +x /path/to/copilot
```
2. **Отсутствующие библиотеки:** Проверьте наличие обязательных общих библиотек:
```bash
ldd /path/to/copilot
```
## Получение помощи
Если вы всё ещё застряли:
1. **Собирайте отладочную информацию:**
* Версия пакета SDK
* Версия CLI (`copilot --version`)
* Операционная система
* Логи отладки
* Код минимального воспроизведения
2. **Поиск существующих номеров:**[GitHub Проблемы](https://github.com/github/copilot-sdk/issues)
3. **Откройте новый выпуск** с собранной информацией
## См. также
* [Создайте своё первое приложение на базе Copilot](/ru/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/getting-started)
* [Использование MCP-серверов с SDK GitHub Copilot](/ru/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/mcp) — конфигурация и настройка MCP
* [Руководство по отладке серверов MCP](/ru/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/troubleshooting/mcp-debugging) — подробное устранение неполадок MCP
* [Справочник по интерфейсам API](https://github.com/github/copilot-sdk)