Repository navigation
Expand file tree
/
Copy pathindex.html
More file actions
631 lines (558 loc) · 32.2 KB
/
Copy pathindex.html
File metadata and controls
631 lines (558 loc) · 32.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Primary SEO Meta Tags -->
<title>GitHub Copilot Home Assistant Integration | AI Voice Assistant</title>
<meta name="google-site-verification" content="ZtgdIVm5_EYKSzbSzbTij8dwy4zSCTH6idcwJP-JJ44" />
<meta name="description" content="Integrate GitHub Copilot AI into Home Assistant. Supports GPT-4o, Claude 3.5 Sonnet, and more for voice assistants and AI-powered tasks.">
<meta name="keywords" content="GitHub Copilot, Home Assistant, HACS, AI Integration, GPT-4o, Claude 3.5 Sonnet, Voice Assistant, Smart Home AI">
<meta name="author" content="tserra30">
<meta name="robots" content="index, follow">
<link rel="canonical" href="https://tserra30.github.io/Github-Copilot-SDK-integration/">
<link rel="sitemap" type="application/xml" href="/Github-Copilot-SDK-integration/sitemap.xml">
<!-- Favicon -->
<link rel="icon" type="image/png" sizes="512x512" href="https://tserra30.github.io/Github-Copilot-SDK-integration/icon@2x.png">
<link rel="icon" type="image/png" sizes="256x256" href="https://tserra30.github.io/Github-Copilot-SDK-integration/icon.png">
<link rel="apple-touch-icon" sizes="256x256" href="https://tserra30.github.io/Github-Copilot-SDK-integration/icon.png">
<!-- Open Graph / Facebook -->
<meta property="og:type" content="website">
<meta property="og:title" content="GitHub Copilot Home Assistant Integration">
<meta property="og:description" content="Bring GitHub Copilot AI capabilities to Home Assistant using the Copilot SDK.">
<meta property="og:url" content="https://tserra30.github.io/Github-Copilot-SDK-integration/">
<meta property="og:image" content="https://tserra30.github.io/Github-Copilot-SDK-integration/logo@2x.png">
<meta property="og:image:alt" content="GitHub Copilot Home Assistant Integration logo">
<meta property="og:site_name" content="GitHub Copilot Home Assistant Integration">
<!-- Twitter Card -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="GitHub Copilot Home Assistant Integration">
<meta name="twitter:description" content="Bring GitHub Copilot AI capabilities to Home Assistant using the Copilot SDK.">
<meta name="twitter:image" content="https://tserra30.github.io/Github-Copilot-SDK-integration/logo@2x.png">
<meta name="twitter:image:alt" content="GitHub Copilot Home Assistant Integration logo">
<!-- Structured Data for Search Engines -->
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "SoftwareApplication",
"name": "GitHub Copilot Home Assistant Integration",
"applicationCategory": "HomeAutomation",
"operatingSystem": "Home Assistant",
"description": "Integration to bring GitHub Copilot AI capabilities to Home Assistant using the GitHub Copilot SDK.",
"softwareVersion": "latest",
"url": "https://tserra30.github.io/Github-Copilot-SDK-integration/",
"downloadUrl": "https://github.com/tserra30/Github-Copilot-SDK-integration",
"license": "https://www.gnu.org/licenses/gpl-3.0.html",
"author": {
"@type": "Person",
"name": "tserra30",
"url": "https://github.com/tserra30"
},
"offers": {
"@type": "Offer",
"price": "0",
"priceCurrency": "USD"
}
}
</script>
<style>
/* ── CSS variables ──────────────────────────────────────────── */
:root {
--bg: #ffffff;
--bg-alt: #f6f8fa;
--border: #d0d7de;
--text: #1f2328;
--text-muted: #656d76;
--link: #0969da;
--link-hover: #0550ae;
--code-bg: rgba(175, 184, 193, 0.2);
--btn-bg: #2ea44f;
--btn-hover: #2c974b;
--accent: #0969da;
--card-shadow: 0 1px 3px rgba(31, 35, 40, 0.12);
--nav-bg: #24292f;
--nav-text: #f0f6fc;
--warn-bg: #fff8c5;
--warn-border: #d4a72c;
--tip-bg: #dafbe1;
--tip-border: #2ea44f;
}
@media (prefers-color-scheme: dark) {
:root {
--bg: #0d1117;
--bg-alt: #161b22;
--border: #30363d;
--text: #e6edf3;
--text-muted: #8b949e;
--link: #58a6ff;
--link-hover: #79c0ff;
--code-bg: rgba(110, 118, 129, 0.4);
--btn-bg: #238636;
--btn-hover: #2ea44f;
--accent: #58a6ff;
--card-shadow: 0 1px 3px rgba(0, 0, 0, 0.4);
--nav-bg: #161b22;
--nav-text: #f0f6fc;
--warn-bg: #2d2a00;
--warn-border: #d4a72c;
--tip-bg: #0a290f;
--tip-border: #2ea44f;
}
}
/* ── Reset & Base ───────────────────────────────────────────── */
*, *::before, *::after { box-sizing: border-box; }
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
font-size: 16px;
line-height: 1.7;
color: var(--text);
background-color: var(--bg);
margin: 0;
padding: 0;
}
a { color: var(--link); text-decoration: none; }
a:hover { color: var(--link-hover); text-decoration: underline; }
/* ── Navigation ─────────────────────────────────────────────── */
nav {
background: var(--nav-bg);
padding: 0 1.5rem;
position: sticky;
top: 0;
z-index: 100;
display: flex;
align-items: center;
gap: 1.5rem;
min-height: 56px;
flex-wrap: wrap;
}
nav .nav-brand {
color: var(--nav-text);
font-weight: 600;
font-size: 1rem;
text-decoration: none;
white-space: nowrap;
}
nav .nav-links {
display: flex;
gap: 0.25rem;
flex-wrap: wrap;
list-style: none;
margin: 0;
padding: 0;
}
nav .nav-links a {
color: rgba(240, 246, 252, 0.8);
font-size: 0.875rem;
padding: 0.4rem 0.75rem;
border-radius: 6px;
transition: background 0.15s, color 0.15s;
text-decoration: none;
}
nav .nav-links a:hover {
background: rgba(255, 255, 255, 0.1);
color: var(--nav-text);
text-decoration: none;
}
/* ── Layout ─────────────────────────────────────────────────── */
.container {
max-width: 860px;
margin: 0 auto;
padding: 2.5rem 1.5rem 4rem;
}
/* ── Hero ───────────────────────────────────────────────────── */
.hero {
text-align: center;
padding: 3rem 0 2rem;
border-bottom: 1px solid var(--border);
margin-bottom: 2.5rem;
}
.hero h1 {
font-size: clamp(1.6rem, 4vw, 2.4rem);
font-weight: 700;
margin: 0 0 0.75rem;
line-height: 1.25;
}
.hero p {
font-size: 1.1rem;
color: var(--text-muted);
max-width: 640px;
margin: 0 auto 1.5rem;
}
.badge-container {
display: flex;
flex-wrap: wrap;
justify-content: center;
gap: 8px;
margin-bottom: 1.5rem;
}
.btn {
display: inline-block;
background: var(--btn-bg);
color: #ffffff;
padding: 10px 22px;
text-decoration: none;
border-radius: 6px;
font-weight: 600;
font-size: 0.95rem;
transition: background 0.15s;
border: 1px solid rgba(0, 0, 0, 0.15);
}
.btn:hover { background: var(--btn-hover); text-decoration: none; color: #ffffff; }
.btn-secondary {
background: transparent;
color: var(--text);
border: 1px solid var(--border);
margin-left: 0.5rem;
}
.btn-secondary:hover {
background: var(--bg-alt);
color: var(--text);
}
/* ── Headings ───────────────────────────────────────────────── */
h2 {
font-size: 1.5rem;
font-weight: 600;
margin: 2rem 0 0.75rem;
padding-bottom: 0.4em;
border-bottom: 1px solid var(--border);
}
h3 {
font-size: 1.15rem;
font-weight: 600;
margin: 1.5rem 0 0.5rem;
}
/* ── Feature grid ───────────────────────────────────────────── */
.feature-grid {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(240px, 1fr));
gap: 1rem;
margin: 1rem 0 1.5rem;
}
.feature-card {
background: var(--bg-alt);
border: 1px solid var(--border);
border-radius: 8px;
padding: 1rem 1.25rem;
box-shadow: var(--card-shadow);
}
.feature-card .icon { font-size: 1.5rem; margin-bottom: 0.4rem; }
.feature-card strong { display: block; margin-bottom: 0.25rem; }
.feature-card p { margin: 0; font-size: 0.9rem; color: var(--text-muted); }
/* ── Code / Pre ─────────────────────────────────────────────── */
code {
background-color: var(--code-bg);
border-radius: 4px;
padding: 0.15em 0.45em;
font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, "Liberation Mono", monospace;
font-size: 0.875em;
}
pre {
background-color: var(--bg-alt);
border: 1px solid var(--border);
padding: 1rem 1.25rem;
overflow: auto;
border-radius: 8px;
font-size: 0.875rem;
line-height: 1.55;
}
pre code {
background: none;
padding: 0;
font-size: inherit;
}
/* ── Callouts ───────────────────────────────────────────────── */
.callout {
border-left: 4px solid var(--warn-border);
background: var(--warn-bg);
border-radius: 0 6px 6px 0;
padding: 0.75rem 1rem;
margin: 1rem 0;
font-size: 0.95rem;
}
.callout.tip {
border-left-color: var(--tip-border);
background: var(--tip-bg);
}
.callout p { margin: 0.25rem 0 0; }
.callout strong { display: block; margin-bottom: 0.25rem; }
/* ── Model tags ─────────────────────────────────────────────── */
.model-list {
display: flex;
flex-wrap: wrap;
gap: 0.5rem;
margin: 0.75rem 0;
padding: 0;
list-style: none;
}
.model-list li {
background: var(--code-bg);
border: 1px solid var(--border);
border-radius: 20px;
padding: 0.2em 0.75em;
font-size: 0.875rem;
font-family: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, "Liberation Mono", monospace;
}
/* ── Steps ──────────────────────────────────────────────────── */
ol, ul { padding-left: 1.5rem; }
li { margin-bottom: 0.35rem; }
/* ── Section spacing ────────────────────────────────────────── */
section { margin-bottom: 2.5rem; }
/* ── Footer ─────────────────────────────────────────────────── */
footer {
border-top: 1px solid var(--border);
padding: 2rem 1.5rem;
text-align: center;
font-size: 0.875rem;
color: var(--text-muted);
}
footer a { color: var(--text-muted); }
footer a:hover { color: var(--link); }
/* ── Responsive ─────────────────────────────────────────────── */
@media (max-width: 600px) {
.container { padding: 1.5rem 1rem 3rem; }
.hero { padding: 2rem 0 1.5rem; }
nav { gap: 0.75rem; padding: 0.5rem 1rem; }
.btn-secondary { margin-left: 0; margin-top: 0.5rem; }
}
</style>
</head>
<body>
<!-- ── Navigation ── -->
<nav aria-label="Site navigation">
<a href="#" class="nav-brand">🤖 Copilot for Home Assistant</a>
<ul class="nav-links">
<li><a href="#features">Features</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#bridge-addon">Bridge Add-on</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#models">Models</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/addon/CHANGELOG.md">Changelog</a></li>
<li><a href="https://github.com/tserra30/Github-Copilot-SDK-integration">GitHub</a></li>
</ul>
</nav>
<div class="container">
<!-- ── Hero ── -->
<header class="hero">
<h1>GitHub Copilot Home Assistant Integration</h1>
<p>Bring GitHub Copilot AI capabilities to Home Assistant — enabling AI conversation agents, voice assistants, and smart home automations powered by the Copilot SDK.</p>
<div class="badge-container">
<img src="https://img.shields.io/github/release/tserra30/Github-Copilot-SDK-integration.svg?style=for-the-badge" alt="Latest Release">
<img src="https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge" alt="HACS Custom">
<img src="https://img.shields.io/github/license/tserra30/Github-Copilot-SDK-integration.svg?style=for-the-badge" alt="License">
<img src="https://img.shields.io/github/commit-activity/y/tserra30/Github-Copilot-SDK-integration.svg?style=for-the-badge" alt="Commit Activity">
</div>
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration" class="btn">View on GitHub</a>
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration/releases" class="btn btn-secondary">Releases</a>
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/addon/CHANGELOG.md" class="btn btn-secondary">Changelog</a>
</header>
<!-- ── Features ── -->
<section id="features">
<h2>Key Features</h2>
<div class="feature-grid">
<div class="feature-card">
<div class="icon">🤖</div>
<strong>Conversation Agent</strong>
<p>Use GitHub Copilot as an AI conversation agent within Home Assistant.</p>
</div>
<div class="feature-card">
<div class="icon">🎤</div>
<strong>Voice Assistant Support</strong>
<p>Works seamlessly with Home Assistant's built-in voice pipeline.</p>
</div>
<div class="feature-card">
<div class="icon">🔧</div>
<strong>Configurable Models</strong>
<p>Use automatic model selection or choose a model from the runtime's live catalog.</p>
</div>
<div class="feature-card">
<div class="icon">💬</div>
<strong>Context Preservation</strong>
<p>Maintains conversation history within sessions via the SDK.</p>
</div>
<div class="feature-card">
<div class="icon">🐳</div>
<strong>Bridge Add-on</strong>
<p>Run the Copilot CLI as a Home Assistant add-on — no local CLI needed.</p>
</div>
<div class="feature-card">
<div class="icon">🏗️</div>
<strong>Multi-Architecture</strong>
<p>Supports amd64 and aarch64 for broad hardware compatibility.</p>
</div>
</div>
</section>
<!-- ── Installation ── -->
<section id="installation">
<h2>Installation</h2>
<p>Requires Home Assistant 2025.2.4 or later. Use a current stable release for Home Assistant's built-in MCP server.</p>
<h3>Via HACS (Recommended)</h3>
<ol>
<li>Open <strong>HACS</strong> in Home Assistant.</li>
<li>Go to <strong>Integrations</strong> and click the <strong>+</strong> button.</li>
<li>Search for <code>GitHub Copilot</code>.</li>
<li>Click <strong>Install</strong>, then restart Home Assistant.</li>
<li>Configure via <strong>Settings → Devices & Services → Add Integration</strong>.</li>
</ol>
<h3>Manual Installation</h3>
<ol>
<li>Copy the <code>custom_components/github_copilot</code> directory to your Home Assistant <code>custom_components</code> directory.</li>
<li>Restart Home Assistant.</li>
<li>Configure via <strong>Settings → Devices & Services → Add Integration</strong>.</li>
</ol>
</section>
<!-- ── Bridge Add-on ── -->
<section id="bridge-addon">
<h2>GitHub Copilot Bridge Add-on</h2>
<p>The <strong>GitHub Copilot Bridge</strong> add-on runs the CLI in a dedicated container that the integration connects to over the internal network. Add-on <strong>v3.12.2</strong> uses CLI <strong>v1.0.83</strong>, matching the integration's SDK <strong>1.0.13</strong>.</p>
<div class="callout tip">
<strong>💡 Recommended for Home Assistant OS</strong>
<p>The bridge manages the CLI separately from Home Assistant Core. Alternatively, local mode lets the SDK download its matching runtime automatically; neither mode requires manual binary installation.</p>
</div>
<h3>Add-on Highlights</h3>
<ul>
<li>🐳 Containerized Copilot CLI server on port 8000 (internal network only)</li>
<li>🔄 Automatic retry mechanism — up to 5 restart attempts on failures</li>
<li>🔐 Token-based authentication via environment variables (no interactive prompts)</li>
<li>🏗️ Multi-architecture support: <code>amd64</code> and <code>aarch64</code></li>
<li>✅ SHA256 checksum verification for CLI binary integrity</li>
<li>🛡️ Clear configured-token status, with authentication checked by SDK clients</li>
</ul>
<h3>Installing the Add-on</h3>
<ol>
<li>Go to <strong>Settings → Add-ons → Add-on Store</strong>.</li>
<li>Click the <strong>⋮</strong> menu and choose <strong>Repositories</strong>.</li>
<li>Add: <code>https://github.com/tserra30/Github-Copilot-SDK-integration</code></li>
<li>Find <strong>GitHub Copilot Bridge</strong> in the store and click <strong>Install</strong>.</li>
<li>In the add-on <strong>Configuration</strong> tab, set your fine-grained GitHub token with <strong>Account permissions → Copilot Requests → Read and write</strong>:
<pre><code>github_token: "<GITHUB_FINE_GRAINED_PAT>"
mcp_config: ""</code></pre>
</li>
<li>Start the add-on and check the <strong>Log</strong> tab to confirm success.</li>
</ol>
<p>Configure MCP in the <strong>integration's MCP field</strong>, even when using the bridge. The add-on's optional <code>mcp_config</code> is available to other bridge clients but does not authorize tools for this integration.</p>
<h3>Finding the Add-on URL</h3>
<p>The integration connects to the add-on via its internal hostname (shown in the add-on <strong>Info</strong> tab). The URL format is:</p>
<pre><code>http://<hostname>:8000
# Example:
http://a1b2c3d4-github-copilot-bridge:8000</code></pre>
<p><strong>Note:</strong> Home Assistant generates the hostname from the add-on slug by replacing all underscores (<code>_</code>) with hyphens (<code>-</code>). Always use hyphens — using underscores will cause DNS resolution to fail.</p>
</section>
<!-- ── Configuration ── -->
<section id="configuration">
<h2>Configuration</h2>
<ol>
<li>Go to <strong>Settings → Devices & Services → Add Integration</strong>.</li>
<li>Search for <strong>GitHub Copilot</strong> and select it.</li>
<li>Fill in the fields:
<ul>
<li><strong>GitHub Token</strong> — Fine-grained personal access token with Copilot Requests permission. Required in local mode; optional with a bridge URL because the bridge manages authentication.</li>
<li><strong>Model</strong> — Defaults to <code>auto</code> for new setups; custom model IDs are also accepted. Existing saved choices are preserved.</li>
<li><strong>Copilot CLI URL</strong> (optional) — URL of the bridge, e.g. <code>http://a1b2c3d4-github-copilot-bridge:8000</code>. Leave empty for local mode, where the SDK downloads a matching runtime if no installed or explicit executable is available.</li>
<li><strong>MCP configuration</strong> (optional) — Inline JSON containing <code>mcpServers</code>, or a JSON file path readable by Home Assistant Core, optionally prefixed with <code>@</code>.</li>
</ul>
</li>
</ol>
<div class="callout">
<strong>⚠️ Token & Authentication Note</strong>
<p>When using the Bridge add-on (with CLI URL set), the GitHub token only needs to be set in the <strong>add-on configuration</strong>. The integration will not pass a token to the SDK in remote mode — the bridge server handles authentication entirely.</p>
</div>
<h3>Getting a GitHub Token</h3>
<ol>
<li>Ensure you have an active <strong>GitHub Copilot subscription</strong>.</li>
<li>Generate a <strong>fine-grained PAT</strong> from <a href="https://github.com/settings/personal-access-tokens/new">GitHub token settings</a>.</li>
<li>Grant <strong>Account permissions → Copilot Requests → Read and write</strong>. Repository permissions are not required.</li>
<li>Keep the token secure — never share it publicly.</li>
</ol>
<p>Classic PATs are not a supported fallback. Keep the GitHub token separate from the Home Assistant long-lived token used for MCP.</p>
<h3 id="mcp-configuration">Home Assistant MCP Setup</h3>
<ol>
<li>Add <strong>Model Context Protocol Server</strong> under <strong>Settings → Devices & services</strong>, enable its <strong>Assist API</strong>, and expose a safe test helper to Assist.</li>
<li>Create a <strong>Home Assistant long-lived access token</strong> in your profile's security settings.</li>
<li>Set the following in the <strong>GitHub Copilot integration's MCP configuration field</strong> (not just the add-on options):</li>
</ol>
<pre><code>{
"mcpServers": {
"homeassistant": {
"type": "http",
"url": "http://homeassistant:8123/api/mcp",
"tools": ["*"],
"headers": {
"Authorization": "Bearer <HOME_ASSISTANT_TOKEN>"
}
}
}
}</code></pre>
<p>The URL must be reachable from the <strong>Copilot CLI runtime</strong>; <code>homeassistant</code> is appropriate on the bridge's internal network. Other deployments need an appropriate reachable address. No external MCP server or proxy is needed.</p>
<p><strong>Every server requires an explicit <code>tools</code> list.</strong> Use <code>[]</code> to disable tools, named tools for limited access, or <code>["*"]</code> to authorize all current and future tools on a trusted server. Allowed calls execute without confirmation. Built-in CLI tools and unconfigured MCP access are denied.</p>
<p>Missing <code>tools</code>, invalid JSON, unreadable files, and invalid server definitions produce errors during setup and options changes. Older configurations without a tools list must be updated explicitly. Protect MCP headers and files as credentials, and verify actual helper state changes rather than relying only on a model's success message.</p>
<p>See the <a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/README.md#mcp-configuration">README's MCP configuration guide</a> for details.</p>
<h3>Example Automation</h3>
<pre><code>automation:
- alias: "Morning briefing with Copilot"
trigger:
- platform: time
at: "07:00:00"
action:
- service: conversation.process
data:
text: "Good morning! What should I know today?"
agent_id: conversation.github_copilot</code></pre>
</section>
<!-- ── Supported Models ── -->
<section id="models">
<h2>Supported Models</h2>
<p>New setups default to <code>auto</code>. Open <strong>Settings → Devices & services → GitHub Copilot → Configure</strong> to fetch the runtime's live model catalog and select an available model.</p>
<p>Existing selections are not silently replaced on upgrade. If an older ID such as <code>gpt-4.1</code> produces <strong>Model not available</strong>, choose a currently supported model through <strong>Configure</strong>.</p>
</section>
<!-- ── Troubleshooting ── -->
<section id="troubleshooting">
<h2>Troubleshooting</h2>
<h3>"Unable to connect to Copilot CLI"</h3>
<p>If bridge <strong>v3.12.0</strong> says it is listening but Home Assistant reports connection refused, upgrade the bridge to <strong>v3.12.1</strong>. This fixes its loopback-only listener without publishing port 8000 to the host. The bridge is updated separately from the HACS integration.</p>
<p>This means the Copilot CLI is not reachable. Two options:</p>
<ul>
<li><strong>Option A (Recommended)</strong> — Install and start the <a href="#bridge-addon">GitHub Copilot Bridge add-on</a>, then enter its URL in the <strong>Copilot CLI URL</strong> field.</li>
<li><strong>Local mode</strong> — Leave the CLI URL empty and configure a fine-grained GitHub token in the integration. Check outbound connectivity, a writable SDK runtime cache, and any stale <code>COPILOT_CLI_PATH</code> override.</li>
</ul>
<h3>Authentication Errors</h3>
<p>Bridge v3.12.2 reports that a GitHub token is configured without running an unreliable startup probe. The integration checks SDK authentication status and confirms model access with a real response during setup. The separate <code>COPILOT_CONNECTION_TOKEN</code> warning concerns client-to-bridge access, not GitHub credentials. Keep port 8000 on a trusted internal network.</p>
<ul>
<li>Verify your fine-grained GitHub token is valid and has <strong>Copilot Requests → Read and write</strong> permission.</li>
<li>Ensure your GitHub Copilot subscription is active.</li>
<li>Try regenerating your personal access token.</li>
</ul>
<h3>Connection and Session Logs</h3>
<p>Integration v1.0.8 logs connection and session lifecycle events in <strong>Home Assistant logs</strong> under <code>custom_components.github_copilot</code>, not in the bridge's Log tab. Enable that logger at <code>info</code>, or temporarily <code>debug</code> for request milestones. Prompts, responses, and credentials are not included in those lifecycle messages. See the <a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/README.md#understanding-bridge-and-integration-logs">logging guide</a>.</p>
<h3>SDK Installation Issues (Home Assistant OS)</h3>
<p>Home Assistant installs the official <strong><code>github-copilot-sdk==1.0.13</code></strong> from PyPI in both modes. Its universal <code>py3-none-any</code> wheel supports Home Assistant Core's Alpine/musl container; no custom wheel is required.</p>
<p>In <strong>local mode</strong>, the SDK automatically downloads and verifies a checksummed matching CLI runtime when no installed or explicit executable is available. SDK 1.0.13 pins CLI <strong>1.0.83</strong>, with musl and glibc builds for amd64/arm64. In <strong>remote bridge mode</strong>, no local CLI binary or runtime download is needed. Update the bridge alongside the integration.</p>
<h3>Slow Responses</h3>
<ul>
<li>Choose an available faster model through <strong>Configure</strong>, or increase the response timeout there.</li>
<li>Check your network latency.</li>
<li>Reduce concurrent requests.</li>
</ul>
<p>For more help, <a href="https://github.com/tserra30/Github-Copilot-SDK-integration/issues">open an issue on GitHub</a>.</p>
</section>
<!-- ── Contributing ── -->
<section id="contributing">
<h2>Contributing</h2>
<p>Contributions are welcome! Please read <a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a> for guidelines on how to propose changes, run the linter, and submit pull requests.</p>
</section>
</div><!-- /.container -->
<!-- ── Footer ── -->
<footer>
<p>
Licensed under the <a href="https://www.gnu.org/licenses/gpl-3.0.html">GNU GPLv3</a> ·
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration">GitHub</a> ·
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration/releases">Releases</a> ·
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/addon/CHANGELOG.md">Changelog</a> ·
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration/issues">Issues</a> ·
<a href="https://github.com/tserra30/Github-Copilot-SDK-integration/blob/main/CONTRIBUTING.md">Contributing</a>
</p>
<p>Not officially affiliated with GitHub or Microsoft.</p>
</footer>
</body>
</html>