Document Copilot SDK mode and custom Copilot command behavior#36649
Closed
Copilot wants to merge 9 commits into
Closed
Document Copilot SDK mode and custom Copilot command behavior#36649Copilot wants to merge 9 commits into
Copilot wants to merge 9 commits into
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
Update Copilot engine docs for SDK driver
Document Copilot SDK mode and custom SDK driver behavior
Jun 3, 2026
Copilot created this pull request from a session on behalf of
pelikhan
June 3, 2026 13:54
View session
pelikhan
reviewed
Jun 3, 2026
| engine: | ||
| id: copilot | ||
| copilot-sdk: true | ||
| harness: custom_copilot_harness.cjs |
Collaborator
There was a problem hiding this comment.
in copilot-sdk mode, you must change the "command" field. Ignore "harness"
Collaborator
|
@copilot in copilot-sdk mode, you must change the "command" field. Ignore "harness" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to explain how engine.id: copilot workflows can run in Copilot SDK-backed mode (copilot-sdk: true), how custom Copilot SDK driver behavior is supplied via a custom engine.harness, and links readers to the Copilot SDK driver specification.
Changes:
- Added a new “Copilot SDK Mode (
copilot-sdk)" section to the engine reference, including configuration examples and behavior notes. - Documented how
engine.harnessinteracts withcopilot-sdkmode for customizing the Copilot SDK driver/harness flow, plus safety constraints for harness filenames. - Added the “Daily Ambient Context Optimizer” workflow to the agent factory status table.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/engines.md | Documents copilot-sdk mode behavior, custom harness usage, and links to the SDK driver spec. |
| docs/src/content/docs/agent-factory-status.mdx | Adds a new daily workflow entry to the status table. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
Comment on lines
+143
to
+145
| Your custom harness must use a filename ending in `.js`, `.cjs`, or `.mjs`. Do not include path separators, `..`, or shell metacharacters. | ||
|
|
||
| These restrictions keep the harness selection safe for sandboxed execution and prevent path traversal or shell injection through workflow configuration. Valid examples include `my_harness.cjs` and `custom-sdk-driver.mjs`. Invalid examples include `../harness.js` and `harness;rm.cjs`. |
Contributor
Author
Copilot
AI
changed the title
Document Copilot SDK mode and custom SDK driver behavior
Document Copilot SDK mode and custom Copilot command behavior
Jun 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This updates the Copilot engine reference to cover
copilot-sdkmode, explain how custom Copilot CLI behavior is supplied throughengine.command, and point readers to the Copilot SDK driver specification.Copilot SDK mode
copilot-sdksection to the engine reference.engine.id: copilotand uses a headless Copilot CLI sidecar plus@github/copilot-sdk.Custom Copilot command behavior
engine.commandchanges the executable used for the headless Copilot CLI sidecar incopilot-sdkmode.engine.harnessdoes not replace the built-in harness or bundledcopilot_sdk_driver.cjsin SDK mode.Specification link