Communication Model
The protocol follows the JSON-RPC 2.0 specification with two types of messages:- Methods: Request-response pairs that expect a result or error
- Notifications: One-way messages that don’t expect a response
Message Flow
A typical flow follows this pattern:1
Initialization Phase
- Client → Agent:
initializeto establish connection - Client → Agent:
authenticateif required by the Agent
2
Session Setup - either:
- Client → Agent:
session/newto create a new session - Client → Agent:
session/loadto resume an existing session if supported
3
Prompt Turn
- Client → Agent:
session/promptto send user message - Agent → Client:
session/updatenotifications for progress updates - Agent → Client: File operations or permission requests as needed
- Client → Agent:
session/cancelto interrupt processing if needed - Turn ends and the Agent sends the
session/promptresponse with a stop reason
Agent
Agents are programs that use generative AI to autonomously modify code. They typically run as subprocesses of the Client.Baseline Methods
Send user prompts to the Agent.
Optional Methods
Load an existing session (requires
loadSession capability).Notifications
Cancel ongoing operations (no response
expected).
Client
Clients provide the interface between users and agents. They are typically code editors (IDEs, text editors) but can also be other UIs for interacting with agents. Clients manage the environment, handle user interactions, and control access to resources.Baseline Methods
Request user authorization for tool
calls.
Optional Methods
Read file contents (requires
fs.readTextFile
capability).Write file contents (requires
fs.writeTextFile capability).Create a new terminal (requires
terminal capability).Notifications
Send session updates to inform the
Client of changes (no response expected). This includes: - Message
chunks (agent, user, thought) - Tool calls and
updates - Plans - Available commands
updates - Mode
changes
Argument requirements
- All file paths in the protocol MUST be absolute.
- Line numbers are 1-based
Error Handling
All methods follow standard JSON-RPC 2.0 error handling:- Successful responses include a
resultfield - Errors include an
errorobject withcodeandmessage - Notifications never receive responses (success or error)
Extensibility
The protocol provides built-in mechanisms for adding custom functionality while maintaining compatibility:- Add custom data using
_metafields - Create custom methods by prefixing their name with underscore (
_) - Advertise custom capabilities during initialization
Next Steps
- Learn about Initialization to understand version and capability negotiation
- Understand Session Setup for creating and loading sessions
- Review the Prompt Turn lifecycle
- Explore Extensibility to add custom features