1# Integrating Copilot SDK into Existing Projects
2 
3Add Copilot SDK AI features to an existing application.
4 
5## Project Analysis
6 
7Detect the project type by scanning for indicator files:
8 
9| Indicator | Language | Framework hints |
10|-----------|----------|-----------------|
11| `package.json` | Node.js | Express, Fastify, Next.js |
12| `requirements.txt` / `pyproject.toml` | Python | Flask, FastAPI, Django |
13| `go.mod` | Go | Gin, Echo, net/http |
14| `*.csproj` / `*.sln` | .NET | ASP.NET, Minimal API |
15 
16## Study Template Patterns
17 
18Read the template via MCP for reference implementation:
19 
20`github-mcp-server-get_file_contents` with `owner: "azure-samples"`, `repo: "copilot-sdk-service"`. Read `AGENTS.md` first.
21 
22Use `github-mcp-server-get_file_contents` with `owner: "github"`, `repo: "copilot-sdk"` for current SDK API examples. If context7 is available, you can also use it (`context7-resolve-library-id` then `context7-query-docs`). If context7 is not available, instruct the user to install it: `npx -y @upstash/context7-mcp@latest`.
23 
24## Integration Steps
25 
26### 1. Add SDK dependency
27 
28| Language | Package |
29|----------|---------|
30| Node.js | `@github/copilot-sdk` |
31| Python | `github-copilot-sdk` |
32| Go / .NET | See SDK repo |
33 
34### 2. Create Copilot endpoint
35 
36Add a route (e.g., `/api/chat`) that creates a `CopilotClient`, starts a session, and returns the response. Use `sendAndWait` for one-shot or SSE streaming for chat.
37 
38Adapt to the app's existing routing pattern (Express router, FastAPI route, etc.).
39 
40### 3. Configure authentication
41 
42Use `gh auth token` for local dev; for production, use Key Vault.
43 
44### 4. Wire into existing app
45 
46Register the new route with the existing server/app instance. Do NOT create a separate server.
47 
48> ⚠️ **Warning:** Do not duplicate server startup logic.
49 
50## BYOM Support
51 
52If the user wants Azure BYOM, add on top of standard integration:
53 
541. Add `@azure/identity` dependency
552. Get fresh token per request: `credential.getToken("https://cognitiveservices.azure.com/.default")`
563. Pass `provider` config with `bearerToken` to `createSession`
574. Set `model` to Azure deployment name (required)
585. Set env vars: `AZURE_OPENAI_ENDPOINT`, `MODEL_NAME`
59 
60See [Azure Model Configuration](azure-model-config.md).
61 
62## Testing
63 
64```bash
65curl -s -X POST http://localhost:<port>/api/chat \
66  -H "Content-Type: application/json" \
67  -d '{"message":"test"}'
68```
69 
70## Errors
71 
72| Error | Fix |
73|-------|-----|
74| SDK not found | Verify dependency installed and import path |
75| Auth fails locally | Run `gh auth login` then `gh auth refresh --scopes copilot` |
76| Route conflicts | Ensure endpoint path doesn't collide |
77