Skip to content

Add Copilot SDK integration guide and Node.js sample#1

Merged
thegovind merged 2 commits intomainfrom
copilot-sdk-integration
Feb 6, 2026
Merged

Add Copilot SDK integration guide and Node.js sample#1
thegovind merged 2 commits intomainfrom
copilot-sdk-integration

Conversation

@thegovind
Copy link
Owner

Summary

  • Add docs/copilot-sdk-integration.md — guide for using GitHub Copilot SDK with Foundry Local for agentic workflows (tool calling, planning, multi-turn) via BYOK
  • Add samples/js/copilot-sdk-foundry-local/ — working Node.js sample demonstrating the BYOK pattern (Foundry Local SDK for lifecycle, OpenAI client for inference)
  • Update docs/README.md with new Integration Guides section

Context

This is part of a cross-repo effort:

  • github/copilot-sdk: Companion PR adds Foundry Local to the public BYOK provider docs
  • github/copilot-agent-runtime: Companion PR adds internal docs highlighting Foundry Local as a BYOK target

What's New

Integration Guide (docs/copilot-sdk-integration.md)

  • Architecture overview (App → Copilot SDK → Foundry Local → Local Model)
  • Quick start for Node.js/TypeScript and Python
  • "When to use which approach" comparison table
  • Limitations and related links

Node.js Sample (samples/js/copilot-sdk-foundry-local/)

  • Bootstraps Foundry Local via SDK
  • Creates OpenAI-compatible client (same pattern Copilot SDK uses with BYOK type "openai")
  • Streams a chat completion from a local model
  • Follows existing hello-foundry-local sample patterns (copyright header, project structure)

Validation

  • All 54 existing SDK unit tests pass (sdk/js vitest suite)
  • node --check passes on src/app.js
  • package.json validates as correct JSON
  • No existing source code modified — only new files + docs/README.md update

thegovind and others added 2 commits February 6, 2026 05:25
Add documentation showing how to use GitHub Copilot SDK with Foundry Local for agentic workflows (tool calling, planning, multi-turn) via BYOK configuration. Update docs/README.md with Integration Guides section.

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Working Node.js sample demonstrating the BYOK pattern: Foundry Local SDK for service/model lifecycle, OpenAI client for inference. Includes package.json, README with setup instructions, and streaming chat completion example.

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-opencode)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
@thegovind thegovind merged commit 2687bd6 into main Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant