SyncPromptContext

public interface SyncPromptContext

Synchronous context provided to prompt handlers for accessing agent capabilities.

This is the synchronous equivalent of PromptContext, providing blocking methods for use with AcpAgent.SyncPromptHandler.

Example usage:


 AcpAgent.sync(transport)
     .promptHandler((request, context) -> {
         // Send an update (blocks until sent)
         context.sendUpdate(sessionId, update);

         // Read a file (blocks until complete)
         var content = context.readTextFile(new ReadTextFileRequest(...));

         // Request permission (blocks until user responds)
         var permission = context.requestPermission(new RequestPermissionRequest(...));

         return new PromptResponse(StopReason.END_TURN);
     })
     .build();

从以下版本开始:: 0.9.1
另请参阅:: PromptContext, AcpAgent.SyncPromptHandler

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`java.lang.String`	`askChoice(java.lang.String question, java.lang.String... options)` Asks the client to choose from multiple options.
`boolean`	`askPermission(java.lang.String action)` Asks the client for permission to perform an action.
`AcpSchema.CreateTerminalResponse`	`createTerminal(AcpSchema.CreateTerminalRequest request)` Requests the client to create a terminal.
`CommandResult`	`execute(Command command)` Executes a command with options and waits for completion.
`CommandResult`	`execute(java.lang.String... commandAndArgs)` Executes a command in a terminal and waits for completion.
`NegotiatedCapabilities`	`getClientCapabilities()` Returns the capabilities negotiated with the client during initialization.
`java.lang.String`	`getSessionId()` Returns the session ID for this prompt invocation.
`AcpSchema.TerminalOutputResponse`	`getTerminalOutput(AcpSchema.TerminalOutputRequest request)` Requests terminal output from the client.
`AcpSchema.KillTerminalCommandResponse`	`killTerminal(AcpSchema.KillTerminalCommandRequest request)` Requests the client to kill a terminal.
`java.lang.String`	`readFile(java.lang.String path)` Reads a text file from the client's file system.
`java.lang.String`	`readFile(java.lang.String path, java.lang.Integer startLine, java.lang.Integer lineCount)` Reads a portion of a text file from the client's file system.
`AcpSchema.ReadTextFileResponse`	`readTextFile(AcpSchema.ReadTextFileRequest request)` Requests the client to read a text file.
`AcpSchema.ReleaseTerminalResponse`	`releaseTerminal(AcpSchema.ReleaseTerminalRequest request)` Requests the client to release a terminal.
`AcpSchema.RequestPermissionResponse`	`requestPermission(AcpSchema.RequestPermissionRequest request)` Requests permission from the client for a sensitive operation.
`void`	`sendMessage(java.lang.String text)` Sends a message to the client as an agent message chunk.
`void`	`sendThought(java.lang.String text)` Sends a thought to the client as an agent thought chunk.
`void`	`sendUpdate(java.lang.String sessionId, AcpSchema.SessionUpdate update)` Sends a session update notification to the client.
`java.util.Optional<java.lang.String>`	`tryReadFile(java.lang.String path)` Attempts to read a text file, returning empty if the file cannot be read or the client doesn't support file reading.
`AcpSchema.WaitForTerminalExitResponse`	`waitForTerminalExit(AcpSchema.WaitForTerminalExitRequest request)` Waits for a terminal to exit.
`void`	`writeFile(java.lang.String path, java.lang.String content)` Writes content to a text file on the client's file system.
`AcpSchema.WriteTextFileResponse`	`writeTextFile(AcpSchema.WriteTextFileRequest request)` Requests the client to write a text file.

- 方法详细资料
  - sendUpdate
```
void sendUpdate(java.lang.String sessionId,
                AcpSchema.SessionUpdate update)
```
    Sends a session update notification to the client. Blocks until the notification is sent.
    
    参数:
    
    sessionId - The session ID
    
    update - The session update to send
  - readTextFile
```
AcpSchema.ReadTextFileResponse readTextFile(AcpSchema.ReadTextFileRequest request)
```
    Requests the client to read a text file. Blocks until the response is received.
    
    参数:
    
    request - The read file request
    
    返回:
    
    The file content
    
    抛出:
    
    AcpCapabilityException - if client doesn't support file reading
  - writeTextFile
```
AcpSchema.WriteTextFileResponse writeTextFile(AcpSchema.WriteTextFileRequest request)
```
    Requests the client to write a text file. Blocks until the write is complete.
    
    参数:
    
    request - The write file request
    
    返回:
    
    The write response
    
    抛出:
    
    AcpCapabilityException - if client doesn't support file writing
  - requestPermission
```
AcpSchema.RequestPermissionResponse requestPermission(AcpSchema.RequestPermissionRequest request)
```
    Requests permission from the client for a sensitive operation. Blocks until the user responds.
    
    参数:
    
    request - The permission request
    
    返回:
    
    The permission response
  - createTerminal
```
AcpSchema.CreateTerminalResponse createTerminal(AcpSchema.CreateTerminalRequest request)
```
    Requests the client to create a terminal. Blocks until the terminal is created.
    
    参数:
    
    request - The create terminal request
    
    返回:
    
    The terminal ID response
    
    抛出:
    
    AcpCapabilityException - if client doesn't support terminals
  - getTerminalOutput
```
AcpSchema.TerminalOutputResponse getTerminalOutput(AcpSchema.TerminalOutputRequest request)
```
    Requests terminal output from the client. Blocks until the output is received.
    
    参数:
    
    request - The terminal output request
    
    返回:
    
    The terminal output
  - releaseTerminal
```
AcpSchema.ReleaseTerminalResponse releaseTerminal(AcpSchema.ReleaseTerminalRequest request)
```
    Requests the client to release a terminal. Blocks until the terminal is released.
    
    参数:
    
    request - The release terminal request
    
    返回:
    
    The release response
  - waitForTerminalExit
```
AcpSchema.WaitForTerminalExitResponse waitForTerminalExit(AcpSchema.WaitForTerminalExitRequest request)
```
    Waits for a terminal to exit. Blocks until the terminal exits.
    
    参数:
    
    request - The wait for exit request
    
    返回:
    
    The exit status
  - killTerminal
```
AcpSchema.KillTerminalCommandResponse killTerminal(AcpSchema.KillTerminalCommandRequest request)
```
    Requests the client to kill a terminal. Blocks until the terminal is killed.
    
    参数:
    
    request - The kill terminal request
    
    返回:
    
    The kill response
  - getClientCapabilities
```
NegotiatedCapabilities getClientCapabilities()
```
    Returns the capabilities negotiated with the client during initialization.
    Use this to check what features the client supports before calling methods like readTextFile(com.agentclientprotocol.sdk.spec.AcpSchema.ReadTextFileRequest) or createTerminal(com.agentclientprotocol.sdk.spec.AcpSchema.CreateTerminalRequest).
    
    返回:
    
    the negotiated client capabilities, or null if not yet initialized
  - getSessionId
```
java.lang.String getSessionId()
```
    Returns the session ID for this prompt invocation.
    
    返回:
    
    the session ID
  - sendMessage
```
void sendMessage(java.lang.String text)
```
    Sends a message to the client as an agent message chunk. This is a convenience method that wraps the text in the appropriate session update structure.
    
    参数:
    
    text - The message text to send
  - sendThought
```
void sendThought(java.lang.String text)
```
    Sends a thought to the client as an agent thought chunk. Thoughts are typically displayed differently than messages, showing the agent's reasoning process.
    
    参数:
    
    text - The thought text to send
  - readFile
```
java.lang.String readFile(java.lang.String path)
```
    Reads a text file from the client's file system.
    
    参数:
    
    path - The path to the file
    
    返回:
    
    The file content
    
    抛出:
    
    AcpCapabilityException - if client doesn't support file reading
  - readFile
```
java.lang.String readFile(java.lang.String path,
                          java.lang.Integer startLine,
                          java.lang.Integer lineCount)
```
    Reads a portion of a text file from the client's file system.
    
    参数:
    
    path - The path to the file
    
    startLine - The line number to start reading from (0-indexed, null for beginning)
    
    lineCount - The number of lines to read (null for all remaining)
    
    返回:
    
    The file content
    
    抛出:
    
    AcpCapabilityException - if client doesn't support file reading
  - tryReadFile
```
java.util.Optional<java.lang.String> tryReadFile(java.lang.String path)
```
    Attempts to read a text file, returning empty if the file cannot be read or the client doesn't support file reading.
    
    参数:
    
    path - The path to the file
    
    返回:
    
    Optional containing the file content, or empty if unavailable
  - writeFile
```
void writeFile(java.lang.String path,
               java.lang.String content)
```
    Writes content to a text file on the client's file system.
    
    参数:
    
    path - The path to the file
    
    content - The content to write
    
    抛出:
    
    AcpCapabilityException - if client doesn't support file writing
  - askPermission
```
boolean askPermission(java.lang.String action)
```
    Asks the client for permission to perform an action. Presents a simple Allow/Deny choice.
    
    参数:
    
    action - A description of the action to request permission for
    
    返回:
    
    true if the user allowed the action, false otherwise
  - askChoice
```
java.lang.String askChoice(java.lang.String question,
                           java.lang.String... options)
```
    Asks the client to choose from multiple options.
    
    参数:
    
    question - The question to ask
    
    options - The available options (at least 2)
    
    返回:
    
    The selected option text, or null if cancelled
  - execute
```
CommandResult execute(java.lang.String... commandAndArgs)
```
    Executes a command in a terminal and waits for completion. The terminal is automatically released after execution.
    
    参数:
    
    commandAndArgs - The command and arguments to execute
    
    返回:
    
    The command result containing output and exit code
    
    抛出:
    
    AcpCapabilityException - if client doesn't support terminals
  - execute
```
CommandResult execute(Command command)
```
    Executes a command with options and waits for completion. The terminal is automatically released after execution.
    
    参数:
    
    command - The command configuration
    
    返回:
    
    The command result containing output and exit code
    
    抛出:
    
    AcpCapabilityException - if client doesn't support terminals

接口 SyncPromptContext

方法概要

方法详细资料

sendUpdate

readTextFile

writeTextFile

requestPermission

createTerminal

getTerminalOutput

releaseTerminal

waitForTerminalExit

killTerminal

getClientCapabilities

getSessionId

sendMessage

sendThought

readFile

readFile

tryReadFile

writeFile

askPermission

askChoice

execute

execute