Skip to content

Commit cce34f9

Browse files
Kaleb ColeCopilot
andcommitted
Clarify SDK runtime architecture
Explain the default CLI JSON-RPC transport and the experimental in-process native runtime transport. Link the in-process setup guide for details. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 19e9a4b commit cce34f9

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ For Go, Java, and Rust, [install the CLI manually](https://github.com/features/c
4545

4646
## Architecture
4747

48-
All SDKs communicate with the Copilot CLI server via JSON-RPC:
48+
The Copilot agent runtime is the engine that powers sessions, tools, and events. The Copilot CLI is the default process interface to that runtime.
49+
50+
By default, all SDKs communicate with the Copilot CLI server out of process via JSON-RPC:
4951

5052
```
5153
Your Application
@@ -57,6 +59,8 @@ Your Application
5759

5860
The SDK manages the CLI process lifecycle automatically. You can also connect to an external CLI server—see the [Getting Started Guide](./docs/getting-started.md#connecting-to-an-external-cli-server) for details on running the CLI in server mode.
5961

62+
As an experimental alternative, each SDK can load the native Copilot agent runtime in the application process through its C ABI/FFI without starting a CLI child process. See [Run the Copilot runtime in process](./docs/setup/in-process-runtime.md) for setup requirements and examples.
63+
6064
### Agent Finder Skill installation APIs
6165

6266
Runtimes that grant `skill-confirmed-installation` expose

0 commit comments

Comments
 (0)