ACP v1 TypeScript SDK — UNSTABLE - v2.0.1
    Preparing search index...

    Class AgentApp

    Agent-side app builder.

    Methods on this class register typed request or notification handlers and return this, so apps can be built with a fluent chain. Handler params are parsed with the generated ACP schemas before your handler runs, and thrown errors are converted to JSON-RPC errors by the connection layer.

    Index
    • Registers a handler that runs when this agent app opens a connection.

      Use this for connection-scoped work that needs to call client-side ACP methods outside an inbound request handler, or to set up per-connection state that the request handlers use.

      Handlers are called synchronously in registration order and are not awaited. A handler that throws or rejects closes the connection. When they are called depends on who opens the connection:

      • connect(...) and connectWith(...) call them before the connection handles its first inbound message, and so does the experimental AgentProtocolRouter's connect(...) when it routes to this app. Only the work a handler does before its first await is guaranteed to come first.
      • The experimental AcpServer calls them after the client has completed initialize, so messages they send cannot replace the initialize response. Request handlers, including initialize, can run before them.

      Parameters

      Returns this

    • Registers a request handler by ACP method name.

      Built-in method literals infer their params and response types from method. Pass a parser as the second argument to register custom extension methods. Use "*" without a parser for a raw fallback after normal dispatch.

      Parameters

      Returns this

    • Registers a request handler by ACP method name.

      Built-in method literals infer their params and response types from method. Pass a parser as the second argument to register custom extension methods. Use "*" without a parser for a raw fallback after normal dispatch.

      Type Parameters

      Parameters

      Returns this

    • Registers a request handler by ACP method name.

      Built-in method literals infer their params and response types from method. Pass a parser as the second argument to register custom extension methods. Use "*" without a parser for a raw fallback after normal dispatch.

      Type Parameters

      • Params
      • Response

      Parameters

      Returns this

    • Registers a notification handler by ACP method name.

      Built-in method literals infer their params type from method. Pass a parser as the second argument to register custom extension notifications. Use "*" without a parser for a raw fallback after normal dispatch.

      Parameters

      Returns this

    • Registers a notification handler by ACP method name.

      Built-in method literals infer their params type from method. Pass a parser as the second argument to register custom extension notifications. Use "*" without a parser for a raw fallback after normal dispatch.

      Type Parameters

      • Method extends "session/cancel"

      Parameters

      Returns this

    • Registers a notification handler by ACP method name.

      Built-in method literals infer their params type from method. Pass a parser as the second argument to register custom extension notifications. Use "*" without a parser for a raw fallback after normal dispatch.

      Type Parameters

      • Params

      Parameters

      Returns this