docs: update SDK/CLI compatibility matrix with missing features#727
Merged
docs: update SDK/CLI compatibility matrix with missing features#727
Conversation
patniko
force-pushed
the
docs/update-compatibility-matrix
branch
from
c1c16c4 to
f402f10
Compare
Add missing SDK features to the Available section: - Session-scoped RPC APIs (model, mode, plan, workspace) - Experimental APIs (fleet, agent management, compaction) - Message delivery modes (steering/queueing) - File and directory attachments - Ping and foreground session management - Session config options (configDir, clientName, disabledSkills) Update CLI-Only section with comprehensive slash commands: - /fleet, /research, /chronicle, /context, /copy, /diagnose - /instructions, /model, /skills, /tasks, /session, /rename - /resume, /reindex, /streamer-mode, /collect-debug-logs, etc. Add missing CLI flags: - Permission flags (--allow-tool, --deny-tool, --allow-url, etc.) - Non-interactive mode (-p, -i, -s, --continue, --agent) - Terminal options (--alt-screen, --mouse, --bash-env) Add workaround sections for plan management and message steering. Update version compatibility table with actual protocol version negotiation details (v2-v3 range, automatic v2 adapters). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
patniko
force-pushed
the
docs/update-compatibility-matrix
branch
from
f402f10 to
60b5fb3
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Updates and reorganizes Copilot SDK documentation to reflect current SDK/CLI feature parity, expand troubleshooting guidance, and add new feature guides/navigation pages.
Changes:
- Expanded
docs/troubleshooting/compatibility.mdwith a more complete SDK-vs-CLI feature matrix, workarounds, and protocol v2–v3 negotiation details. - Added/organized new documentation entry points and feature guides (docs index, features index, streaming events reference, image input, custom agents, OpenTelemetry).
- Fixed/updated many internal doc links to match the new docs structure (features/, troubleshooting/, auth/).
Reviewed changes
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/troubleshooting/mcp-debugging.md | Updates “See Also” links to new MCP and troubleshooting locations |
| docs/troubleshooting/debugging.md | Fixes MCP debugging guide link + updates “See Also” paths |
| docs/troubleshooting/compatibility.md | Major expansion of SDK/CLI compatibility matrix + new workaround sections |
| docs/setup/scaling.md | Fixes “Next Steps” links (session persistence, BYOK) |
| docs/setup/local-cli.md | Fixes BYOK/auth/getting-started/session persistence link paths |
| docs/setup/index.md | Updates BYOK and getting-started link paths |
| docs/setup/github-oauth.md | Updates BYOK/auth docs link paths |
| docs/setup/bundled-cli.md | Updates BYOK/session persistence/getting-started link paths |
| docs/setup/backend-services.md | Updates BYOK/session persistence link paths |
| docs/setup/azure-managed-identity.md | Updates BYOK link paths |
| docs/observability/opentelemetry.md | Adds OpenTelemetry instrumentation guide (new) |
| docs/integrations/microsoft-agent-framework.md | Updates links to new feature guide locations |
| docs/index.md | Adds top-level documentation landing page (new) |
| docs/hooks/user-prompt-submitted.md | Updates Hooks Overview link to hooks index |
| docs/hooks/session-lifecycle.md | Updates Hooks Overview + debugging guide link paths |
| docs/hooks/pre-tool-use.md | Updates Hooks Overview + debugging guide link paths |
| docs/hooks/post-tool-use.md | Updates Hooks Overview link to hooks index |
| docs/hooks/index.md | Updates debugging guide link path |
| docs/hooks/error-handling.md | Updates Hooks Overview + debugging guide link paths |
| docs/guides/setup/byok.md | Removes legacy BYOK setup guide (deleted) |
| docs/getting-started.md | Updates MCP documentation links to new features page |
| docs/features/streaming-events.md | Adds streaming session event field reference (new) |
| docs/features/steering-and-queueing.md | Updates link to hooks index |
| docs/features/skills.md | Updates MCP link to new features/mcp.md |
| docs/features/session-persistence.md | Updates troubleshooting/debugging/hook link paths |
| docs/features/mcp.md | Updates MCP debugging link + related resource links (one link appears broken) |
| docs/features/index.md | Adds Features landing page (new) |
| docs/features/image-input.md | Adds Image Input guide (new) |
| docs/features/hooks.md | Updates hook reference links + debugging guide link |
| docs/features/custom-agents.md | Adds Custom Agents & sub-agent orchestration guide (new) |
| docs/auth/index.md | Updates MCP link to new features/mcp.md |
| README.md | Adds richer docs quick-link navigation to new docs structure |
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.
Summary
Comprehensive update to the SDK/CLI compatibility matrix based on cross-referencing the SDK codebase with the CLI runtime (
copilot-agent-runtime).Changes
Added to "Available in SDK" section
immediate) and queueing (enqueue)configDir,clientName,disabledSkills,workingDirectoryExpanded "CLI-Only" section
/fleet,/research,/chronicle,/context,/copy,/diagnose,/model,/skills,/tasks,/session,/rename,/resume,/reindex,/streamer-mode,/collect-debug-logs, etc.--allow-tool/--deny-tool,--allow-url/--deny-url,-p/-i/-s,--continue,--agent, terminal options/compact→session.rpc.compaction.compact())New workaround sections
session.rpc.plan.*mode: "immediate"Updated version compatibility table