Repository navigation
Clarify SDK architecture and in-process runtime transport #2804
Description
Activity
Thanks for the report. I've labeled this as
documentation.Gap: The root
README.mdarchitecture section says SDKs talk to the Copilot CLI server over JSON-RPC. That's only the default out-of-process transport. It doesn't mention the experimental in-process transport (native C ABI/FFI, no CLI child process), and it blurs the agent runtime with the CLI interface.Affected docs:
README.md(architecture section and diagram)docs/setup/in-process-runtime.md(the detailed page to link to)- Possibly the per-language READMEs where they repeat the "SDK → CLI server" description.
Suggested improvements:
- Distinguish the Copilot agent runtime from the Copilot CLI interface.
- Describe the default out-of-process JSON-RPC path.
- Add a short note on the experimental in-process path (loads the Rust runtime through the C ABI, no child process).
- Link to
docs/setup/in-process-runtime.mdfor details.
Open PR #2805 appears to address this.
Generated by Documentation Handler for #2804 · copilot · auto · 13.9 AIC · ⌖ 5.31 AIC · ⊞ 6.8K · ◷
Description
The root README architecture section says that all SDKs communicate with the Copilot CLI server through JSON-RPC. That describes the default child-process transport, but it does not mention the experimental in-process transport now available across the supported SDKs.
The in-process transport loads the Rust runtime through its native C ABI and does not start a CLI child process. The current wording can therefore imply that the CLI server is the only supported architecture.
Suggested change
Update the root README architecture section to:
docs/setup/in-process-runtime.mdfor details.This is a documentation-only clarification. It does not change SDK behavior.