Module 18: Terminal Operations

Execute shell commands on the client through the terminal API.

What You’ll Learn

The four-step terminal lifecycle: create, wait, output, release
Implementing terminal handlers on the client
Using the terminal API from the agent side

The Code

Client: Implement terminal handlers

var clientCaps = new ClientCapabilities(
    new FileSystemCapability(false, false),
    true  // terminal enabled
);

AcpSyncClient client = AcpClient.sync(transport)
    .createTerminalHandler(req -> {
        List<String> cmd = new ArrayList<>();
        cmd.add(req.command());
        if (req.args() != null) cmd.addAll(req.args());

        Process process = new ProcessBuilder(cmd)
            .redirectErrorStream(true)
            .start();

        terminals.put(terminalId, process);
        return new CreateTerminalResponse(terminalId);
    })
    .waitForTerminalExitHandler(req -> {
        Process process = terminals.get(req.terminalId()).process();
        int exitCode = process.waitFor();
        return new WaitForTerminalExitResponse(exitCode, null);
    })
    .terminalOutputHandler(req -> {
        String output = capturedOutput.get(req.terminalId());
        return new TerminalOutputResponse(output, false, null);
    })
    .releaseTerminalHandler(req -> {
        Process process = terminals.remove(req.terminalId()).process();
        process.destroyForcibly();
        return new ReleaseTerminalResponse();
    })
    .build();

client.initialize(new InitializeRequest(1, clientCaps));

Agent: Use terminal API

.promptHandler((req, context) -> {
    // Check capability first
    if (!context.getClientCapabilities().supportsTerminal()) {
        context.sendMessage("Terminal not supported");
        return PromptResponse.endTurn();
    }

    String terminalId = null;
    try {
        // Step 1: Create terminal
        var createResp = context.createTerminal(
            new CreateTerminalRequest(
                context.getSessionId(),
                "sh", List.of("-c", command),
                null, null, null));
        terminalId = createResp.terminalId();

        // Step 2: Wait for exit
        var exitResp = context.waitForTerminalExit(
            new WaitForTerminalExitRequest(context.getSessionId(), terminalId));

        // Step 3: Get output
        var outputResp = context.getTerminalOutput(
            new TerminalOutputRequest(context.getSessionId(), terminalId));

        context.sendMessage("Exit: " + exitResp.exitCode() +
            "\nOutput:\n" + outputResp.output());
    } finally {
        // Step 4: Always release
        if (terminalId != null) {
            context.releaseTerminal(
                new ReleaseTerminalRequest(context.getSessionId(), terminalId));
        }
    }
    return PromptResponse.endTurn();
})

Terminal Lifecycle

Step	Agent calls	Client handles	Purpose
1	`createTerminal()`	`createTerminalHandler`	Spawn process
2	`waitForTerminalExit()`	`waitForTerminalExitHandler`	Block until done
3	`getTerminalOutput()`	`terminalOutputHandler`	Read stdout/stderr
4	`releaseTerminal()`	`releaseTerminalHandler`	Clean up resources

The agent requests command execution, but the client controls what actually runs. This keeps command execution under the user’s control — the client decides whether to allow, sandbox, or deny terminal requests.

The SDK also provides context.execute() as a convenience method that combines all four steps.

Source Code

View on GitHub

Running the Example

./mvnw package -pl module-18-terminal-operations -q
./mvnw exec:java -pl module-18-terminal-operations

Next Module

Module 19: MCP Servers — pass MCP server configurations to agents.

​Module 18: Terminal Operations

​What You’ll Learn

​The Code

​Client: Implement terminal handlers

​Agent: Use terminal API

​Terminal Lifecycle

​Source Code

​Running the Example

​Next Module

Module 18: Terminal Operations

What You’ll Learn

The Code

Client: Implement terminal handlers

Agent: Use terminal API

Terminal Lifecycle

Source Code

Running the Example

Next Module