Skip to content

docs: clarify model RPC availability #798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
haosenwang1018 wants to merge 1 commit into from
Closed

docs: clarify model RPC availability #798

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/troubleshooting/compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must b

## Feature Comparison

> [!NOTE]
> The SDK may expose RPC methods before the bundled Copilot CLI fully implements them end-to-end.
> At the time of writing, the repository's Node.js, Python, Go, and .NET E2E tests still mark
> `session.model.switchTo()` and `session.model.getCurrent()` as not yet implemented in the CLI,
> so treat these model RPCs as provisional rather than broadly available.

### ✅ Available in SDK

| Feature | SDK Method | Notes |
Expand Down Expand Up @@ -39,8 +45,8 @@ The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must b
| **Models** | | |
| List models | `listModels()` | With capabilities, billing, policy |
| Set model (at creation) | `model` in session config | Per-session |
| Switch model (mid-session) | `session.setModel()` | Also via `session.rpc.model.switchTo()` |
| Get current model | `session.rpc.model.getCurrent()` | Query active model |
| Switch model (mid-session) | `session.setModel()` | SDK surface exists, but current CLI support is still incomplete; see note below |
| Get current model | `session.rpc.model.getCurrent()` | RPC is defined in schema, but current CLI support is still incomplete |
| Reasoning effort | `reasoningEffort` config | For supported models |
| **Agent Mode** | | |
| Get current mode | `session.rpc.mode.get()` | Returns current mode |
Expand Down Expand Up @@ -101,7 +107,7 @@ The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must b
| Diff mode dialog | `/diff` | Interactive UI |
| Feedback dialog | `/feedback` | Interactive UI |
| Theme picker | `/theme` | Terminal UI |
| Model picker | `/model` | Interactive UI (use SDK `setModel()` instead) |
| Model picker | `/model` | Interactive UI |
| Copy to clipboard | `/copy` | Terminal-specific |
| Context management | `/context` | Interactive UI |
| **Research & History** | | |
Expand Down