Skip to content

ACP Remote API

This page documents the public surface re-exported by acpremote.

Core Functions

connect_acp(url, *, bearer_token=None, headers=None, options=None)

Source code in packages/transports/acpremote/src/acpremote/proxy_agent.py 
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
def connect_acp(
    url: str,
    *,
    bearer_token: str | None = None,
    headers: _HeaderPairs | None = None,
    options: TransportOptions | None = None,
) -> Agent:
    return cast(
        "Agent",
        RemoteProxyAgent(
            url=url,
            bearer_token=bearer_token,
            headers=headers,
            options=options or TransportOptions(),
        ),
    )

connect_remote_agent(client, url, *, options=None, headers=None, bearer_token=None) async

Source code in packages/transports/acpremote/src/acpremote/client.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
async def connect_remote_agent(
    client: Client,
    url: str,
    *,
    options: TransportOptions | None = None,
    headers: _HeaderPairs | None = None,
    bearer_token: str | None = None,
) -> RemoteClientConnection:
    resolved_options = options or TransportOptions()
    resolved_headers = _merge_headers(headers, bearer_headers(bearer_token))
    websocket = await connect(
        url,
        additional_headers=resolved_headers,
        compression=resolved_options.compression,
        open_timeout=resolved_options.open_timeout,
        ping_interval=resolved_options.ping_interval,
        ping_timeout=resolved_options.ping_timeout,
        close_timeout=resolved_options.close_timeout,
        max_size=resolved_options.max_size,
        max_queue=resolved_options.max_queue,
    )
    streams: WebSocketStreamBridge | None = None
    connection: ClientSideConnection | None = None
    try:
        streams = await open_websocket_stream_bridge(
            websocket,
            reader_limit=resolved_options.reader_limit,
        )
        connection = connect_to_agent(client, streams.writer, streams.reader)
        metadata = await fetch_server_metadata(
            url,
            headers=resolved_headers,
            timeout=resolved_options.open_timeout,
        )
    except BaseException:
        if connection is not None:
            with contextlib.suppress(BaseException):
                await connection.close()
        if streams is not None:
            with contextlib.suppress(BaseException):
                await streams.close()
        else:
            with contextlib.suppress(BaseException):
                await websocket.close()
            with contextlib.suppress(BaseException):
                await websocket.wait_closed()
        raise
    return RemoteClientConnection(
        connection=connection,
        websocket=websocket,
        streams=streams,
        metadata=metadata,
    )

serve_acp(agent, *, host='127.0.0.1', port=0, mount_path='/acp', bearer_token=None, options=None, supported_agent_families=(), remote_cwd=None) async

Source code in packages/transports/acpremote/src/acpremote/server.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
async def serve_acp(
    agent: Agent,
    *,
    host: str = "127.0.0.1",
    port: int = 0,
    mount_path: str = "/acp",
    bearer_token: str | None = None,
    options: TransportOptions | None = None,
    supported_agent_families: tuple[str, ...] = (),
    remote_cwd: str | None = None,
) -> Server:
    return await serve_remote_agent(
        agent,
        host=host,
        port=port,
        server_options=ServerOptions(
            mount_path=mount_path,
            bearer_token=bearer_token,
            supported_agent_families=supported_agent_families,
            remote_cwd=remote_cwd,
            transport=options or TransportOptions(),
        ),
    )

serve_command(command, *, host='127.0.0.1', port=0, mount_path='/acp', bearer_token=None, options=None, supported_agent_families=(), cwd=None, env=None, stderr_mode='inherit') async

Source code in packages/transports/acpremote/src/acpremote/server.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
async def serve_command(
    command: tuple[str, ...] | list[str],
    *,
    host: str = "127.0.0.1",
    port: int = 0,
    mount_path: str = "/acp",
    bearer_token: str | None = None,
    options: TransportOptions | None = None,
    supported_agent_families: tuple[str, ...] = (),
    cwd: str | None = None,
    env: dict[str, str] | None = None,
    stderr_mode: Literal["inherit", "discard"] = "inherit",
) -> Server:
    command_options = CommandOptions(
        command=tuple(command),
        cwd=cwd,
        env=env,
        stderr_mode=stderr_mode,
    )
    return await serve_stdio_command(
        command_options,
        host=host,
        port=port,
        mount_path=mount_path,
        bearer_token=bearer_token,
        options=options,
        supported_agent_families=supported_agent_families,
    )

serve_stdio_command(command_options, *, host='127.0.0.1', port=0, mount_path='/acp', bearer_token=None, options=None, supported_agent_families=()) async

Source code in packages/transports/acpremote/src/acpremote/server.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
async def serve_stdio_command(
    command_options: CommandOptions,
    *,
    host: str = "127.0.0.1",
    port: int = 0,
    mount_path: str = "/acp",
    bearer_token: str | None = None,
    options: TransportOptions | None = None,
    supported_agent_families: tuple[str, ...] = (),
) -> Server:
    server_options = ServerOptions(
        mount_path=mount_path,
        bearer_token=bearer_token,
        supported_agent_families=supported_agent_families,
        remote_cwd=command_options.cwd or os.getcwd(),
        transport=options or TransportOptions(),
    )
    metadata = build_server_metadata(server_options)
    resolved_transport = server_options.transport

    return await serve(
        lambda websocket: run_remote_command_connection(
            websocket,
            command_options=command_options,
            transport_options=resolved_transport,
        ),
        host,
        port,
        process_request=lambda connection, request: _process_request(
            connection,
            request,
            server_options=server_options,
            metadata=metadata,
        ),
        compression=resolved_transport.compression,
        open_timeout=resolved_transport.open_timeout,
        ping_interval=resolved_transport.ping_interval,
        ping_timeout=resolved_transport.ping_timeout,
        close_timeout=resolved_transport.close_timeout,
        max_size=resolved_transport.max_size,
        max_queue=resolved_transport.max_queue,
    )

serve_remote_agent(agent, *, host='127.0.0.1', port=0, options=None, server_options=None) async

Source code in packages/transports/acpremote/src/acpremote/server.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
async def serve_remote_agent(
    agent: Agent,
    *,
    host: str = "127.0.0.1",
    port: int = 0,
    options: TransportOptions | None = None,
    server_options: ServerOptions | None = None,
) -> Server:
    if options is not None and server_options is not None:
        raise ValueError("pass either options or server_options, not both")
    resolved_server_options = server_options or ServerOptions(
        transport=options or TransportOptions(),
    )
    resolved_transport = resolved_server_options.transport
    metadata = build_server_metadata(resolved_server_options)

    return await serve(
        lambda websocket: run_remote_agent_connection(
            agent,
            websocket,
            options=resolved_transport,
        ),
        host,
        port,
        process_request=lambda connection, request: _process_request(
            connection,
            request,
            server_options=resolved_server_options,
            metadata=metadata,
        ),
        compression=resolved_transport.compression,
        open_timeout=resolved_transport.open_timeout,
        ping_interval=resolved_transport.ping_interval,
        ping_timeout=resolved_transport.ping_timeout,
        close_timeout=resolved_transport.close_timeout,
        max_size=resolved_transport.max_size,
        max_queue=resolved_transport.max_queue,
    )

Transport Configuration

TransportOptions(*, max_size=DEFAULT_MAX_MESSAGE_SIZE, reader_limit=DEFAULT_MAX_MESSAGE_SIZE, max_queue=DEFAULT_MAX_QUEUE, open_timeout=DEFAULT_OPEN_TIMEOUT, ping_interval=DEFAULT_PING_INTERVAL, ping_timeout=DEFAULT_PING_TIMEOUT, close_timeout=DEFAULT_CLOSE_TIMEOUT, compression=None, host_ownership='remote', emit_latency_meta=False, emit_latency_projection=False) dataclass

ServerOptions(*, mount_path='/acp', bearer_token=None, supported_agent_families=(), remote_cwd=None, transport=TransportOptions()) dataclass

ServerPaths(*, metadata_path, websocket_path, health_path=DEFAULT_HEALTH_PATH) dataclass

CommandOptions(*, command, cwd=None, env=None, stderr_mode='inherit', terminate_timeout=5.0) dataclass

TransportMetadata(*, transport_kind='websocket', transport_version=1, package_version=__version__) dataclass

ServerMetadata(*, transport_kind, transport_version, package_version, auth_required, supported_auth_modes, max_size, max_queue, compression, health_path, metadata_path, websocket_path, supported_agent_families=(), remote_cwd=None) dataclass

Runtime Classes

RemoteProxyAgent(*, url, headers=None, bearer_token=None, options=TransportOptions()) dataclass

set_session_model(model_id, session_id) async

Compatibility helper that maps model selection to ACP 0.11 config options.

Source code in packages/transports/acpremote/src/acpremote/proxy_agent.py 
272
273
274
275
276
277
278
async def set_session_model(
    self,
    model_id: str,
    session_id: str,
) -> SetSessionConfigOptionResponse | None:
    """Compatibility helper that maps model selection to ACP 0.11 config options."""
    return await self.set_config_option("model", session_id, model_id)

RemoteClientConnection(connection, websocket, streams, metadata=None) dataclass

WebSocketStreamBridge(reader, writer, _transport, _reader_task) dataclass

Helper Functions

build_server_paths(mount_path)

Source code in packages/transports/acpremote/src/acpremote/config.py 
72
73
74
75
76
77
78
79
80
def build_server_paths(mount_path: str) -> ServerPaths:
    normalized_mount = normalize_mount_path(mount_path)
    if normalized_mount == DEFAULT_HEALTH_PATH:
        raise ValueError(f"mount_path must not overlap the health endpoint `{DEFAULT_HEALTH_PATH}`")
    websocket_path = f"{normalized_mount}/ws" if normalized_mount != "/" else "/ws"
    return ServerPaths(
        metadata_path=normalized_mount,
        websocket_path=websocket_path,
    )

build_server_metadata(options)

Source code in packages/transports/acpremote/src/acpremote/metadata.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def build_server_metadata(options: ServerOptions) -> ServerMetadata:
    transport_metadata = TransportMetadata()
    auth_required = options.bearer_token is not None and bool(options.bearer_token.strip())
    return ServerMetadata(
        transport_kind=transport_metadata.transport_kind,
        transport_version=transport_metadata.transport_version,
        package_version=transport_metadata.package_version,
        auth_required=auth_required,
        supported_auth_modes=("bearer",) if auth_required else (),
        max_size=options.transport.max_size,
        max_queue=options.transport.max_queue,
        compression=options.transport.compression,
        health_path=options.paths.health_path,
        metadata_path=options.paths.metadata_path,
        websocket_path=options.paths.websocket_path,
        supported_agent_families=options.supported_agent_families,
        remote_cwd=options.remote_cwd,
    )

normalize_mount_path(mount_path)

Source code in packages/transports/acpremote/src/acpremote/config.py 
62
63
64
65
66
67
68
69
def normalize_mount_path(mount_path: str) -> str:
    stripped = mount_path.strip()
    if not stripped:
        raise ValueError("mount_path must not be empty")
    if not stripped.startswith("/"):
        stripped = f"/{stripped}"
    normalized = stripped.rstrip("/")
    return normalized or "/"