Files
awesome-copilot/cookbook
Jon GallowayandCopilot a19b3101cc Update .NET Copilot SDK cookbook for current SDK releases (#3548)
* Update .NET Copilot SDK cookbook: fix On<T> breaking change, add in-process runtime, tool search, and message provenance recipes

- Fix breaking change: Session.On is now generic (On<T> where T : SessionEvent).
  Updated all recipes that used the old non-generic session.On(evt => ...) pattern:
  error-handling, pr-visualization, managing-local-files, accessibility-report,
  ralph-loop (both .md and .cs where applicable).
- Add new 'In-Process Runtime' recipe (in-process-runtime.md + recipe/in-process-runtime.cs)
  demonstrating RuntimeConnection.ForInProcess(), live-tested.
- Document tool search / deferred loading (SessionConfig.ToolSearch / ToolSearchConfig)
  in pr-visualization.md, live-tested.
- Document typed message provenance (MessageOptions.Source / MessageSource) in
  error-handling.md, live-tested.
- Fix dotnet/README.md recipe index: it was missing Ralph Loop and Accessibility
  Report entries; also added the new In-Process Runtime entry.
- Add In-Process Runtime entry to the top-level cookbook/copilot-sdk/README.md
  .NET section.
- Update dotnet/recipe/README.md runnable-examples table with the new recipe.

All existing .NET cookbook recipes were rebuilt and rechecked against the current
GitHub Copilot SDK (Copilot CLI 1.0.85); no other breaking changes were found.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update cookbook model names to current supported models

- Replace stale/nonexistent model IDs (gpt-5, claude-sonnet-4.5,
  claude-opus-4.6, gpt-5.1-codex-mini) with current values from the
  supported AI models list
- Prefer Model = "auto" wherever a specific model isn't load-bearing
  to the recipe's teaching point
- ralph-loop: pin gpt-5.3-codex (current codex-family GA model), since
  a dedicated coding model is a deliberate, documented choice for the
  autonomous loop
- multiple-sessions: reshape the model narrative so it demonstrates a
  real explicit-override use case (A/B testing via claude-sonnet-5)
  instead of two sessions sharing the same hardcoded model

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Use SendAndWaitAsync in in-process runtime recipe

Replace the event-based TaskCompletionSource pattern with SendAndWaitAsync so the example waits for the final assistant response, propagates session errors, and uses the SDK timeout behavior.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-09-22 00:15:06 +00:00
..
2026-04-06 15:20:20 -04:00

GitHub Copilot Cookbook

A collection of practical recipes and examples for working with GitHub Copilot tools and features. Each recipe provides focused, copy-paste-ready code snippets and real-world examples to help you accomplish common tasks.

What's in the Cookbook

The cookbook is organized by tool or product, with recipes collected by language where applicable:

GitHub Copilot SDK

Ready-to-use recipes for building with the GitHub Copilot SDK across multiple languages.

  • Copilot SDK Cookbook - Recipes for .NET, Go, Java, Node.js, and Python
    • Error handling, session management, file operations, and more
    • Runnable examples for each language
    • Best practices and complete implementation guides

Getting Started

  1. Browse the tool or product folder that matches what you want to build
  2. Find the recipe that solves your use case
  3. Copy the code snippet or check the recipe/ subfolder for complete, runnable examples
  4. Refer to the language-specific documentation for setup and execution instructions

Planned Expansions

The cookbook is designed to grow alongside the GitHub Copilot ecosystem. Future additions may include recipes for:

  • Additional Copilot tools and integrations
  • Advanced patterns and workflows
  • Integration with external services and APIs
  • Language-specific optimizations and best practices

Contributing

Have a recipe to share? We'd love to include it! See CONTRIBUTING.md for guidelines on submitting new recipes.

Resources

Official Documentation

External Cookbooks

Other