vtcode_acp_client/
lib.rs

1//! ACP (Agent Communication Protocol) client for inter-agent communication
2//!
3//! This module provides:
4//! - **V2 (Recommended)**: Full ACP protocol compliance with JSON-RPC 2.0
5//!   - Session lifecycle (initialize, session/new, session/prompt)
6//!   - Capability negotiation
7//!   - SSE streaming for real-time updates
8//! - **V1 (Legacy)**: HTTP-based communication with remote agents
9//!   - Agent discovery (online and offline)
10//!   - Request/response message handling
11//!
12//! # Quick Start (V2)
13//!
14//! ```rust,ignore
15//! use vtcode_acp_client::{AcpClientV2, ClientCapabilities};
16//!
17//! let client = AcpClientV2::new("http://agent.example.com")?;
18//!
19//! // Initialize connection and negotiate capabilities
20//! let init_result = client.initialize().await?;
21//!
22//! // Create a session
23//! let session = client.session_new(Default::default()).await?;
24//!
25//! // Send a prompt
26//! let response = client.session_prompt(SessionPromptParams {
27//!     session_id: session.session_id,
28//!     content: vec![PromptContent::text("Hello!")],
29//!     ..Default::default()
30//! }).await?;
31//! ```
32//!
33//! # Migration from V1
34//!
35//! The V1 `AcpClient` is deprecated and will be removed in a future version.
36//! Migrate to `AcpClientV2` for full ACP protocol compliance.
37
38// V2 modules (ACP compliant)
39pub mod capabilities;
40pub mod client_v2;
41pub mod jsonrpc;
42pub mod session;
43
44// V1 modules (legacy, deprecated)
45pub mod client;
46pub mod discovery;
47pub mod error;
48pub mod messages;
49
50// V2 exports (recommended)
51pub use capabilities::{
52    AgentCapabilities, AgentFeatures, AgentInfo as AgentInfoV2, AuthCredentials,
53    AuthenticateParams, AuthenticateResult, ClientCapabilities, ClientInfo, FilesystemCapabilities,
54    InitializeParams, InitializeResult, PROTOCOL_VERSION, SUPPORTED_VERSIONS, TerminalCapabilities,
55    ToolCapability, UiCapabilities,
56};
57pub use client_v2::{AcpClientV2, AcpClientV2Builder};
58pub use jsonrpc::{JSONRPC_VERSION, JsonRpcError, JsonRpcId, JsonRpcRequest, JsonRpcResponse};
59pub use session::{
60    AcpSession, ConversationTurn, PermissionOption, PromptContent, RequestPermissionParams,
61    RequestPermissionResult, SessionCancelParams, SessionLoadParams, SessionLoadResult,
62    SessionNewParams, SessionNewResult, SessionPromptParams, SessionPromptResult, SessionState,
63    SessionUpdate, SessionUpdateNotification, ToolCallRecord, TurnStatus,
64};
65
66// V1 exports (deprecated)
67#[deprecated(since = "0.60.0", note = "Use AcpClientV2 for ACP protocol compliance")]
68pub use client::{AcpClient, AcpClientBuilder};
69pub use discovery::{AgentInfo, AgentRegistry};
70pub use error::{AcpError, AcpResult};
71#[deprecated(since = "0.60.0", note = "Use jsonrpc module types instead")]
72pub use messages::{AcpMessage, AcpRequest, AcpResponse};
73
74use agent_client_protocol::AgentSideConnection;
75use std::sync::{Arc, OnceLock};
76
77static ACP_CONNECTION: OnceLock<Arc<AgentSideConnection>> = OnceLock::new();
78
79/// Register the global ACP connection from the host protocol.
80///
81/// Returns `Err` with the provided connection if one has already been
82/// registered. Callers may drop the returned connection or reuse it as needed.
83pub fn register_acp_connection(
84    connection: Arc<AgentSideConnection>,
85) -> Result<(), Arc<AgentSideConnection>> {
86    ACP_CONNECTION.set(connection)
87}
88
89/// Retrieve the registered ACP connection, if available.
90pub fn acp_connection() -> Option<Arc<AgentSideConnection>> {
91    ACP_CONNECTION.get().cloned()
92}
vtcode_acp_client/lib.rs

vtcode_acp_client/
lib.rs
