acp-sdk 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367678f3b99c82b2f768879be0308249d9b32ce8ce94c3d4e6de6c12c4a1c043
-  data.tar.gz: 071e457b8e00fa19be760fff65cfd69998102e54b4b3d47f9b3cc0d80c359fc3
+  metadata.gz: 978b245a94b3cd60d3858ee42c3deaf9b687c8a6a1701ce54c684a5e434b2bce
+  data.tar.gz: b83adfe811bc7873455f9f81993061e7b2ea66d0a75b78645807fc44e08cd58b
 SHA512:
-  metadata.gz: 706206bd29062ef6ecf1856b9e9671113e02bb6eb6ac837c2815bfcdbbff4bc07ac8d2c6394ec6f7b33c37a3832a9e0c4bb5c4e5c4699c1cdc129e875f693605
-  data.tar.gz: 5a73a945d099dedcf5837aa1c897b1dca0313a49d131337756b26c28731ddedb14b96c21722c7d6ecff3a21e6bed811e036551724c12bebcdf53f88a56121f8e
+  metadata.gz: 2907a71594882b7afd3ed8fe89b2e9520f139dc1c235a4e43bf836a2f127ae6264ce948d86885577daa6cd320078c6da831f4b8df89225201287276e17710c4e
+  data.tar.gz: 9191c0362932d37aaeb55666fb0b892505e448949f13e4173d0d9a0196ccebd16e56324f42db33f6c0d47fbec658bce6aac6e1bec4e4e9d4bdd4d6a1237ffc11

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.7.0](https://github.com/bottrall/acp-sdk/compare/v0.6.0...v0.7.0) (2026-10-05)
+
+
+### Features
+
+* terminal handlers on ACP::ClientConnection ([#77](https://github.com/bottrall/acp-sdk/issues/77)) ([8a42829](https://github.com/bottrall/acp-sdk/commit/8a428295d5cd7c92b56ec1b3ed1c900b485bbf01)), closes [#40](https://github.com/bottrall/acp-sdk/issues/40)
+
+
+### Bug Fixes
+
+* attach data to method-not-found and invalid-request replies ([#75](https://github.com/bottrall/acp-sdk/issues/75)) ([9bc201c](https://github.com/bottrall/acp-sdk/commit/9bc201c53d86f506bedb5b49183b865cf9b8f4fe)), closes [#29](https://github.com/bottrall/acp-sdk/issues/29)
+* don't send handler exception messages to the peer ([#74](https://github.com/bottrall/acp-sdk/issues/74)) ([af66b48](https://github.com/bottrall/acp-sdk/commit/af66b48cbab4a99244c28a9c6f6a12c9ea23efc7)), closes [#28](https://github.com/bottrall/acp-sdk/issues/28)
+
 ## [0.6.0](https://github.com/bottrall/acp-sdk/compare/v0.5.0...v0.6.0) (2026-10-04)
 
 

data/README.md

@@ -50,6 +50,7 @@ The agent's contract:
 
 - It defines `new_session`, `prompt` and `cancel`. `load_session`, `list_sessions`, `resume_session`, `close_session` and `delete_session` are required only when `capabilities` advertises `load_session` or `session_capabilities.list`, `.resume`, `.close` or `.delete`, and `authenticate` only when `auth_methods` is non-empty, and `logout` only when `capabilities` advertises `auth.logout`; `start` raises `ArgumentError` when one is advertised but missing, and a method that is not advertised is answered with `-32601`. `change_session_mode` and `change_session_config_option` are optional, since modes and config options are offered per session rather than in `initialize`; `session/set_mode` and `session/set_config_option` are answered with `-32601` when the agent does not define them. `session_created`, if defined, runs right after the `session/new` reply is sent.
 - Each request method returns its response type or an `ACP::RequestError`, which is sent as the error reply. Params that do not match the schema are answered with `-32602` before the agent sees them.
+- A handler that raises is answered with `-32603` and the message `Internal error`. Nothing from the exception reaches the peer — its class and message are logged to the transport's logger instead, since messages can interpolate paths, queries or credentials. Return an `ACP::RequestError` from the handler when the peer should see a real error message.
 - `cancel` runs on the transport's reader thread, so it must return quickly: set a flag and let the prompt notice it.
 - After a cancel, the agent must itself end the turn with `stopReason: cancelled`. `ACP::AgentConnection` does not enforce it.
 - `client.capabilities` is `nil` until the client sends `initialize`.
@@ -63,7 +64,7 @@ Extensions are `_`-prefixed methods outside the spec. `AgentConnection` takes `e
 
 ## Driving an agent
 
-`ACP::ClientConnection` is the other side of the same transport. Each method takes the request's generated `ACP::Types` object and returns its response type or the agent's `ACP::RequestError`. `connect` sends `initialize`, since Ruby reserves that name for the constructor, and `authenticate` and `logout` send their namesake methods. `session_set_mode` sends `session/set_mode`, and `session_set_config_option` sends `session/set_config_option` and returns the session's complete option list, which replaces any state held from an earlier reply.
+`ACP::ClientConnection` is the other side of the same transport. Each method takes the request's generated `ACP::Types` object and returns its response type or the agent's `ACP::RequestError`. `connect` sends `initialize`, since Ruby reserves that name for the constructor, and `authenticate` and `logout` send their namesake methods. `session_set_mode` sends `session/set_mode`, and `session_set_config_option` sends `session/set_config_option` and returns the session's complete option list, which replaces any state held from an earlier reply. A handler that raises is answered with `-32603` and the message `Internal error`, and the exception is only logged to the transport's logger.
 
 `ACP::AgentProcess.spawn` starts a command with args, env and cwd, wires its stdio to a new `ACP::ClientConnection` and starts it. The block receives the connection and the process handle (`pid`, plus `stderr` when captured), and the child is terminated — after its stdin is closed, with TERM and then KILL if it will not exit — when the block exits, so a raised block cannot leak the process. Without a block, `spawn` returns the process and calling `terminate` is yours. `stderr` is `:inherit` by default, so the child writes to your stderr; pass `:capture` to collect it on the process instead.
 
@@ -105,6 +106,7 @@ connection = ACP::ClientConnection.new(
 - `session_prompt` and `session_load` yield the session's updates on the calling thread as they arrive and return once the agent replies. Updates outside those calls, such as the available commands after `session/new`, go to `updates`, which runs on the reader thread and must return quickly. `session_resume` does not take a block: the agent must not replay history on resume, so unlike `session_load` there is nothing to stream. `session_close` and `session_delete` end the session, discarding it on the agent, and return once the agent replies.
 - `permission` answers `session/request_permission` with an `ACP::Types::RequestPermissionResponse` or an `ACP::RequestError`. It runs on its own thread, so it may block while the user decides, and `session_cancel` can be sent meanwhile.
 - `read_text_file` and `write_text_file` answer the agent's `fs/read_text_file` and `fs/write_text_file` with an `ACP::Types::ReadTextFileResponse`, an `ACP::Types::WriteTextFileResponse` or an `ACP::RequestError`. They are routed by the `fs` capabilities `connect` sends: a method the client does not advertise is answered with `-32601` without reaching the handler, and `connect` raises `ArgumentError` — before sending `initialize` — when the request advertises a capability that has no handler.
+- `create_terminal`, `terminal_output`, `wait_for_terminal_exit`, `kill_terminal` and `release_terminal` answer the agent's `terminal/create`, `terminal/output`, `terminal/wait_for_exit`, `terminal/kill` and `terminal/release` with the matching `ACP::Types` response or an `ACP::RequestError`. They are routed by the `terminal` capability `connect` sends, the same way as `fs`: a method the client does not advertise is answered with `-32601` without reaching the handler, and `connect` raises `ArgumentError` — before sending `initialize` — when the request advertises `terminal` with any of the five missing. The transport serves each request on its own thread, so `wait_for_terminal_exit` may block without holding up the others.
 
 Extensions work the same way in both directions: `extension_requests` and `extension_notifications` are hashes keyed by the raw `_`-prefixed wire name, `ext_request` sends one to the agent and returns its result as-is, and `ext_notify` sends an extension notification. A handler name without the `_` prefix raises `ArgumentError`, and an extension request nothing answers gets `-32601`.
 

data/lib/acp/client_connection.rb

@@ -5,8 +5,15 @@ class ACP::ClientConnection
   # @rbs @permission: ACP::ClientConnection::_PermissionHandler
   # @rbs @read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?
   # @rbs @write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?
+  # @rbs @create_terminal: (^(ACP::Types::CreateTerminalRequest) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError))?
+  # @rbs @terminal_output: (^(ACP::Types::TerminalOutputRequest) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError))?
+  # @rbs @wait_for_terminal_exit: (^(ACP::Types::WaitForTerminalExitRequest) ->
+  #   (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError))?
+  # @rbs @kill_terminal: (^(ACP::Types::KillTerminalRequest) -> (ACP::Types::KillTerminalResponse | ACP::RequestError))?
+  # @rbs @release_terminal: (^(ACP::Types::ReleaseTerminalRequest) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError))?
   # @rbs @updates: ACP::ClientConnection::_UpdateHandler
   # @rbs @fs_capabilities: ACP::Types::FileSystemCapabilities?
+  # @rbs @terminal: bool?
   # @rbs @extension_requests: Hash[String, ^(untyped) -> untyped]
   # @rbs @extension_notifications: Hash[String, ^(untyped) -> void]
   # @rbs @lock: Thread::Mutex
@@ -26,6 +33,12 @@ class ACP::ClientConnection
   # @rbs permission: ACP::ClientConnection::_PermissionHandler
   # @rbs read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?
   # @rbs write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?
+  # @rbs create_terminal: (^(ACP::Types::CreateTerminalRequest) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError))?
+  # @rbs terminal_output: (^(ACP::Types::TerminalOutputRequest) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError))?
+  # @rbs wait_for_terminal_exit: (^(ACP::Types::WaitForTerminalExitRequest) ->
+  #   (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError))?
+  # @rbs kill_terminal: (^(ACP::Types::KillTerminalRequest) -> (ACP::Types::KillTerminalResponse | ACP::RequestError))?
+  # @rbs release_terminal: (^(ACP::Types::ReleaseTerminalRequest) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError))?
   # @rbs updates: ACP::ClientConnection::_UpdateHandler
   # @rbs extension_requests: Hash[String, ^(untyped) -> untyped]
   # @rbs extension_notifications: Hash[String, ^(untyped) -> void]
@@ -36,6 +49,11 @@ class ACP::ClientConnection
     permission:,
     read_text_file: nil,
     write_text_file: nil,
+    create_terminal: nil,
+    terminal_output: nil,
+    wait_for_terminal_exit: nil,
+    kill_terminal: nil,
+    release_terminal: nil,
     updates: IGNORE,
     extension_requests: {},
     extension_notifications: {},
@@ -45,8 +63,14 @@ class ACP::ClientConnection
     @permission = permission
     @read_text_file = read_text_file
     @write_text_file = write_text_file
+    @create_terminal = create_terminal
+    @terminal_output = terminal_output
+    @wait_for_terminal_exit = wait_for_terminal_exit
+    @kill_terminal = kill_terminal
+    @release_terminal = release_terminal
     @updates = updates
     @fs_capabilities = nil
+    @terminal = nil
     @extension_requests = extension_requests
     @extension_notifications = extension_notifications
     extension_requests.each_key { |name| ACP::Extensions.validate_name(name) }
@@ -63,7 +87,12 @@ class ACP::ClientConnection
       requests: {
         'session/request_permission' => method(:request_permission),
         'fs/read_text_file' => method(:read_text_file),
-        'fs/write_text_file' => method(:write_text_file)
+        'fs/write_text_file' => method(:write_text_file),
+        'terminal/create' => method(:create_terminal),
+        'terminal/output' => method(:terminal_output),
+        'terminal/wait_for_exit' => method(:wait_for_terminal_exit),
+        'terminal/kill' => method(:kill_terminal),
+        'terminal/release' => method(:release_terminal)
       }.merge(@extension_requests),
       notifications: { 'session/update' => method(:dispatch) }.merge(@extension_notifications)
     )
@@ -81,7 +110,14 @@ class ACP::ClientConnection
       raise ArgumentError, "initialize advertises fs methods no handler serves: #{unserved.join(', ')}"
     end
 
+    terminal = request.client_capabilities&.terminal
+    unserved = unserved_terminal_methods(terminal)
+    unless unserved.empty?
+      raise ArgumentError, "initialize advertises terminal methods no handler serves: #{unserved.join(', ')}"
+    end
+
     @fs_capabilities = capabilities
+    @terminal = terminal
     parse(ACP::Types::InitializeResponse, @transport.request('initialize', request.to_h)).then do |response|
       next response if response.is_a?(ACP::RequestError)
 
@@ -349,6 +385,82 @@ class ACP::ClientConnection
     handler.call(request)
   end
 
+  # The terminal routes are registered at start, before connect records the
+  # advertised capability, so each one answers -32601 until then.
+  #
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::CreateTerminalResponse | ACP::RequestError)
+  def create_terminal(params)
+    return ACP::RequestError.unadvertised('terminal') unless @terminal
+
+    request = ACP::Types::CreateTerminalRequest.from_h(params)
+  rescue KeyError, TypeError, NoMethodError
+    ACP::RequestError.invalid_params
+  else
+    # Safe: connect refuses an advertised capability no handler serves.
+    handler = @create_terminal #: ^(ACP::Types::CreateTerminalRequest) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError)
+    handler.call(request)
+  end
+
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::TerminalOutputResponse | ACP::RequestError)
+  def terminal_output(params)
+    return ACP::RequestError.unadvertised('terminal') unless @terminal
+
+    request = ACP::Types::TerminalOutputRequest.from_h(params)
+  rescue KeyError, TypeError, NoMethodError
+    ACP::RequestError.invalid_params
+  else
+    # Safe: connect refuses an advertised capability no handler serves.
+    handler = @terminal_output #: ^(ACP::Types::TerminalOutputRequest) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError)
+    handler.call(request)
+  end
+
+  # The handler may block for as long as the command runs, so the transport
+  # must serve each request on its own thread for this not to hold up others.
+  #
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError)
+  def wait_for_terminal_exit(params)
+    return ACP::RequestError.unadvertised('terminal') unless @terminal
+
+    request = ACP::Types::WaitForTerminalExitRequest.from_h(params)
+  rescue KeyError, TypeError, NoMethodError
+    ACP::RequestError.invalid_params
+  else
+    # Safe: connect refuses an advertised capability no handler serves.
+    handler = @wait_for_terminal_exit #: ^(ACP::Types::WaitForTerminalExitRequest) -> (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError)
+    handler.call(request)
+  end
+
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::KillTerminalResponse | ACP::RequestError)
+  def kill_terminal(params)
+    return ACP::RequestError.unadvertised('terminal') unless @terminal
+
+    request = ACP::Types::KillTerminalRequest.from_h(params)
+  rescue KeyError, TypeError, NoMethodError
+    ACP::RequestError.invalid_params
+  else
+    # Safe: connect refuses an advertised capability no handler serves.
+    handler = @kill_terminal #: ^(ACP::Types::KillTerminalRequest) -> (ACP::Types::KillTerminalResponse | ACP::RequestError)
+    handler.call(request)
+  end
+
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::ReleaseTerminalResponse | ACP::RequestError)
+  def release_terminal(params)
+    return ACP::RequestError.unadvertised('terminal') unless @terminal
+
+    request = ACP::Types::ReleaseTerminalRequest.from_h(params)
+  rescue KeyError, TypeError, NoMethodError
+    ACP::RequestError.invalid_params
+  else
+    # Safe: connect refuses an advertised capability no handler serves.
+    handler = @release_terminal #: ^(ACP::Types::ReleaseTerminalRequest) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError)
+    handler.call(request)
+  end
+
   # The fs capabilities initialize advertises that no injected handler serves.
   #
   # @rbs capabilities: ACP::Types::FileSystemCapabilities?
@@ -359,4 +471,19 @@ class ACP::ClientConnection
       'fs.writeTextFile' => capabilities&.write_text_file && !@write_text_file
     }.select { |_, unserved| unserved }.keys
   end
+
+  # The terminal capabilities initialize advertises that no injected handler
+  # serves.
+  #
+  # @rbs capabilities: bool?
+  # @rbs return: Array[String]
+  def unserved_terminal_methods(capabilities)
+    {
+      'terminal.create' => capabilities && !@create_terminal,
+      'terminal.output' => capabilities && !@terminal_output,
+      'terminal.wait_for_exit' => capabilities && !@wait_for_terminal_exit,
+      'terminal.kill' => capabilities && !@kill_terminal,
+      'terminal.release' => capabilities && !@release_terminal
+    }.select { |_, unserved| unserved }.keys
+  end
 end

data/lib/acp/request_error.rb

@@ -48,9 +48,10 @@ class ACP::RequestError
     new(code: INVALID_REQUEST, message: 'Invalid request')
   end
 
+  # @rbs method: String?
   # @rbs return: ACP::RequestError
-  def self.method_not_found
-    new(code: METHOD_NOT_FOUND, message: 'Method not found')
+  def self.method_not_found(method = nil)
+    new(code: METHOD_NOT_FOUND, message: 'Method not found', data: method && { method: method })
   end
 
   # @rbs return: ACP::RequestError

data/lib/acp/transport/stdio.rb

@@ -92,7 +92,7 @@ class ACP::Transport::Stdio
     method = message['method']
     error = message['error']
     if method.is_a?(String) && message.key?('id')
-      serve(requests[method], message['id'], message['params'])
+      serve(requests[method], message['id'], message['params'], method)
     elsif method.is_a?(String)
       # Run on the reader thread so notifications (session/update) keep their
       # order; a JSON-RPC notification has no reply to carry a handler error.
@@ -104,10 +104,21 @@ class ACP::Transport::Stdio
       code, text, data = error.values_at('code', 'message', 'data')
       settle(message['id'], ACP::RequestError.new(code:, message: text, data:))
     else
-      reply(nil, ACP::RequestError.invalid_request)
+      reply(detectable_id(message), ACP::RequestError.invalid_request)
     end
   end
 
+  # JSON-RPC 2.0 says an error reply echoes the request id whenever it can be
+  # detected; ids outside the spec's String/Number/Null types are not, so
+  # those replies keep id null.
+  #
+  # @rbs message: Hash[String, untyped]
+  # @rbs return: untyped
+  def detectable_id(message)
+    id = message['id']
+    id.is_a?(String) || id.is_a?(Numeric) ? id : nil
+  end
+
   # @rbs line: String
   # @rbs return: Hash[String, untyped] | ACP::RequestError
   def parse(line)
@@ -122,10 +133,11 @@ class ACP::Transport::Stdio
   # @rbs handler: _Handler?
   # @rbs id: untyped
   # @rbs params: untyped
+  # @rbs method: String
   # @rbs return: void
-  def serve(handler, id, params)
+  def serve(handler, id, params, method)
     Thread.new do
-      outcome = handler ? invoke(handler, params) : ACP::RequestError.method_not_found
+      outcome = handler ? invoke(handler, params) : ACP::RequestError.method_not_found(method)
       case outcome
       when ACP::Transport::Reply
         reply(id, outcome.result)
@@ -149,7 +161,9 @@ class ACP::Transport::Stdio
   end
 
   # Handlers are application code at the protocol boundary: an exception
-  # becomes an error response instead of killing the thread serving it.
+  # becomes an error response instead of killing the thread serving it. The
+  # exception is only logged, not sent: its message can carry paths, SQL or
+  # anything else the handler interpolated, which must not reach the peer.
   #
   # @rbs handler: _Handler
   # @rbs params: untyped
@@ -157,7 +171,8 @@ class ACP::Transport::Stdio
   def invoke(handler, params)
     handler.call(params)
   rescue StandardError => e
-    ACP::RequestError.new(code: ACP::RequestError::INTERNAL_ERROR, message: e.message)
+    @logger.error("request handler raised #{e.class}: #{e.message}")
+    ACP::RequestError.internal_error
   end
 
   # The success arm is whatever the handler returned, which the transport only

data/lib/acp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ACP
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/sig/generated/acp/client_connection.rbs

@@ -1,29 +1,41 @@
 # Generated from lib/acp/client_connection.rb with RBS::Inline
 
 class ACP::ClientConnection
-  @logger: ACP::Transport::_Logger
+  @transport: ACP::AgentConnection::_Transport
 
-  @pending_permissions: Hash[String, Array[Thread::Queue]]
+  @permission: ACP::ClientConnection::_PermissionHandler
 
-  @streams: Hash[String, Thread::Queue]
+  @read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?
 
-  @lock: Thread::Mutex
+  @write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?
 
-  @extension_notifications: Hash[String, ^(untyped) -> void]
+  @create_terminal: (^(ACP::Types::CreateTerminalRequest) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError))?
 
-  @extension_requests: Hash[String, ^(untyped) -> untyped]
+  @terminal_output: (^(ACP::Types::TerminalOutputRequest) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError))?
 
-  @fs_capabilities: ACP::Types::FileSystemCapabilities?
+  @wait_for_terminal_exit: (^(ACP::Types::WaitForTerminalExitRequest) -> (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError))?
+
+  @kill_terminal: (^(ACP::Types::KillTerminalRequest) -> (ACP::Types::KillTerminalResponse | ACP::RequestError))?
+
+  @release_terminal: (^(ACP::Types::ReleaseTerminalRequest) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError))?
 
   @updates: ACP::ClientConnection::_UpdateHandler
 
-  @write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?
+  @fs_capabilities: ACP::Types::FileSystemCapabilities?
 
-  @read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?
+  @terminal: bool?
 
-  @permission: ACP::ClientConnection::_PermissionHandler
+  @extension_requests: Hash[String, ^(untyped) -> untyped]
 
-  @transport: ACP::AgentConnection::_Transport
+  @extension_notifications: Hash[String, ^(untyped) -> void]
+
+  @lock: Thread::Mutex
+
+  @streams: Hash[String, Thread::Queue]
+
+  @pending_permissions: Hash[String, Array[Thread::Queue]]
+
+  @logger: ACP::Transport::_Logger
 
   PROTOCOL_VERSION: Integer
 
@@ -35,12 +47,18 @@ class ACP::ClientConnection
   # @rbs permission: ACP::ClientConnection::_PermissionHandler
   # @rbs read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?
   # @rbs write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?
+  # @rbs create_terminal: (^(ACP::Types::CreateTerminalRequest) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError))?
+  # @rbs terminal_output: (^(ACP::Types::TerminalOutputRequest) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError))?
+  # @rbs wait_for_terminal_exit: (^(ACP::Types::WaitForTerminalExitRequest) ->
+  #   (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError))?
+  # @rbs kill_terminal: (^(ACP::Types::KillTerminalRequest) -> (ACP::Types::KillTerminalResponse | ACP::RequestError))?
+  # @rbs release_terminal: (^(ACP::Types::ReleaseTerminalRequest) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError))?
   # @rbs updates: ACP::ClientConnection::_UpdateHandler
   # @rbs extension_requests: Hash[String, ^(untyped) -> untyped]
   # @rbs extension_notifications: Hash[String, ^(untyped) -> void]
   # @rbs logger: ACP::Transport::_Logger
   # @rbs return: void
-  def initialize: (transport: ACP::AgentConnection::_Transport, permission: ACP::ClientConnection::_PermissionHandler, ?read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?, ?write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?, ?updates: ACP::ClientConnection::_UpdateHandler, ?extension_requests: Hash[String, ^(untyped) -> untyped], ?extension_notifications: Hash[String, ^(untyped) -> void], ?logger: ACP::Transport::_Logger) -> void
+  def initialize: (transport: ACP::AgentConnection::_Transport, permission: ACP::ClientConnection::_PermissionHandler, ?read_text_file: (^(ACP::Types::ReadTextFileRequest) -> (ACP::Types::ReadTextFileResponse | ACP::RequestError))?, ?write_text_file: (^(ACP::Types::WriteTextFileRequest) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError))?, ?create_terminal: (^(ACP::Types::CreateTerminalRequest) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError))?, ?terminal_output: (^(ACP::Types::TerminalOutputRequest) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError))?, ?wait_for_terminal_exit: (^(ACP::Types::WaitForTerminalExitRequest) -> (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError))?, ?kill_terminal: (^(ACP::Types::KillTerminalRequest) -> (ACP::Types::KillTerminalResponse | ACP::RequestError))?, ?release_terminal: (^(ACP::Types::ReleaseTerminalRequest) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError))?, ?updates: ACP::ClientConnection::_UpdateHandler, ?extension_requests: Hash[String, ^(untyped) -> untyped], ?extension_notifications: Hash[String, ^(untyped) -> void], ?logger: ACP::Transport::_Logger) -> void
 
   # @rbs return: Thread
   def start: () -> Thread
@@ -182,9 +200,42 @@ class ACP::ClientConnection
   # @rbs return: (ACP::Types::WriteTextFileResponse | ACP::RequestError)
   def write_text_file: (untyped params) -> (ACP::Types::WriteTextFileResponse | ACP::RequestError)
 
+  # The terminal routes are registered at start, before connect records the
+  # advertised capability, so each one answers -32601 until then.
+  #
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::CreateTerminalResponse | ACP::RequestError)
+  def create_terminal: (untyped params) -> (ACP::Types::CreateTerminalResponse | ACP::RequestError)
+
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::TerminalOutputResponse | ACP::RequestError)
+  def terminal_output: (untyped params) -> (ACP::Types::TerminalOutputResponse | ACP::RequestError)
+
+  # The handler may block for as long as the command runs, so the transport
+  # must serve each request on its own thread for this not to hold up others.
+  #
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError)
+  def wait_for_terminal_exit: (untyped params) -> (ACP::Types::WaitForTerminalExitResponse | ACP::RequestError)
+
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::KillTerminalResponse | ACP::RequestError)
+  def kill_terminal: (untyped params) -> (ACP::Types::KillTerminalResponse | ACP::RequestError)
+
+  # @rbs params: untyped
+  # @rbs return: (ACP::Types::ReleaseTerminalResponse | ACP::RequestError)
+  def release_terminal: (untyped params) -> (ACP::Types::ReleaseTerminalResponse | ACP::RequestError)
+
   # The fs capabilities initialize advertises that no injected handler serves.
   #
   # @rbs capabilities: ACP::Types::FileSystemCapabilities?
   # @rbs return: Array[String]
   def unserved_fs_methods: (ACP::Types::FileSystemCapabilities? capabilities) -> Array[String]
+
+  # The terminal capabilities initialize advertises that no injected handler
+  # serves.
+  #
+  # @rbs capabilities: bool?
+  # @rbs return: Array[String]
+  def unserved_terminal_methods: (bool? capabilities) -> Array[String]
 end

data/sig/generated/acp/request_error.rbs

@@ -44,8 +44,9 @@ class ACP::RequestError
   # @rbs return: ACP::RequestError
   def self.invalid_request: () -> ACP::RequestError
 
+  # @rbs method: String?
   # @rbs return: ACP::RequestError
-  def self.method_not_found: () -> ACP::RequestError
+  def self.method_not_found: (?String? method) -> ACP::RequestError
 
   # @rbs return: ACP::RequestError
   def self.invalid_params: () -> ACP::RequestError

data/sig/generated/acp/transport/stdio.rbs

@@ -62,6 +62,14 @@ class ACP::Transport::Stdio
   # @rbs return: void
   def route: (Hash[String, untyped] message, Hash[String, _Handler] requests, Hash[String, _NotificationHandler] notifications) -> void
 
+  # JSON-RPC 2.0 says an error reply echoes the request id whenever it can be
+  # detected; ids outside the spec's String/Number/Null types are not, so
+  # those replies keep id null.
+  #
+  # @rbs message: Hash[String, untyped]
+  # @rbs return: untyped
+  def detectable_id: (Hash[String, untyped] message) -> untyped
+
   # @rbs line: String
   # @rbs return: Hash[String, untyped] | ACP::RequestError
   def parse: (String line) -> (Hash[String, untyped] | ACP::RequestError)
@@ -69,8 +77,9 @@ class ACP::Transport::Stdio
   # @rbs handler: _Handler?
   # @rbs id: untyped
   # @rbs params: untyped
+  # @rbs method: String
   # @rbs return: void
-  def serve: (_Handler? handler, untyped id, untyped params) -> void
+  def serve: (_Handler? handler, untyped id, untyped params, String method) -> void
 
   # For code with no reply to carry an error: a notification handler, or a
   # Reply's after once the reply is on the wire. An exception must not kill
@@ -82,7 +91,9 @@ class ACP::Transport::Stdio
   def quietly: (String label) { () -> void } -> void
 
   # Handlers are application code at the protocol boundary: an exception
-  # becomes an error response instead of killing the thread serving it.
+  # becomes an error response instead of killing the thread serving it. The
+  # exception is only logged, not sent: its message can carry paths, SQL or
+  # anything else the handler interpolated, which must not reach the peer.
   #
   # @rbs handler: _Handler
   # @rbs params: untyped

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acp-sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jake Bottrall