Adding `ahp` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add ahp

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

ahp = "0.7.0"

The ahp library will be automatically available globally. Read the ahp library documentation.

Back to the crate overview.

Readme

ahp

Async Rust client for the Agent Host Protocol (AHP).

Transport-agnostic SDK that builds on ahp-types. Bring your own transport — WebSocket, stdio, TCP, or an in-memory channel pair for tests.

Features

Client — async JSON-RPC client with action subscription, write-ahead dispatch, and background I/O task
reducers — pure state reducers; apply StateActions to RootState / SessionState / terminal state
Transport — pluggable trait for any framed message stream

Usage

[dependencies]
ahp = "0.1"
ahp-ws = "0.1"   # or bring your own transport
tokio = { version = "1", features = ["full"] }

use ahp::{Client, ClientConfig, SubscriptionEvent};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let transport = ahp_ws::WebSocketTransport::connect("ws://localhost:12345").await?;
    let client = Client::connect(transport, ClientConfig::default()).await?;

    client.initialize("my-client".into(), vec![ahp_types::PROTOCOL_VERSION.to_string()], vec![ahp_types::ROOT_RESOURCE_URI.to_string()]).await?;

    let mut sub = client.attach_subscription(ahp_types::ROOT_RESOURCE_URI).await;
    while let Some(SubscriptionEvent::Action(a)) = sub.recv().await {
        println!("seq={} action={:?}", a.server_seq, a.action);
    }

    client.shutdown().await;
    Ok(())
}

Custom transport

Implement ahp::Transport for any framed byte stream:

use ahp::{Transport, TransportError, TransportMessage};
use std::future::Future;

struct MyTransport { /* ... */ }

impl Transport for MyTransport {
    fn send(&mut self, msg: TransportMessage)
        -> impl Future<Output = Result<(), TransportError>> + Send
    { async { todo!() } }

    fn recv(&mut self)
        -> impl Future<Output = Result<Option<TransportMessage>, TransportError>> + Send
    { async { todo!() } }
}

See tests/client_roundtrip.rs for a complete in-memory example.

Adding ahp library as a dependency

Adding `ahp` library as a dependency