Skip to content

Commit e3f784b

Browse files
keraronaduminuc
andauthored
chore: docs review (#55)
* chore: docs review * docs: fix typo --------- Co-authored-by: Alessandro Duminuco <[email protected]>
1 parent 2373a4b commit e3f784b

10 files changed

+175
-174
lines changed

docs/pages/agws/workflow_server_manager.md

+18-20
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
1-
# Agent Workflow Server Manager
1+
# Workflow Server Manager
22

3-
The workflow server manager (`wfsm`) is a command line tool that streamlines the process of wrapping an agent into a container image, starting the container and exposing the agent functionality through the Agent Connect Protocol (ACP)
3+
The Workflow Server Manager (WFSM) is a command line tool that streamlines the process of wrapping an agent into a container image, starting the container, and exposing the agent functionality through the Agent Connect Protocol (ACP).
44

5-
The `wfsm` tool takes an [agent manifest](manifest.md) as input and based on it spins up a web server container exposing the agent through ACP through REST api
5+
The WFSM tool takes an [Agent Manifest](manifest.md) as input and based on it spins up a web server container exposing the agent through ACP through REST api.
66

7-
## Getting started
7+
## Getting Started
88

99
### Prerequisites
1010

11-
The utility requires docker engine, `docker` and `docker-compose` to be present on the host
12-
To make sure the docker setup is correct on the host execute the
11+
The utility requires Docker engine, `docker`, and `docker-compose` to be present on the host.
12+
13+
To make sure the docker setup is correct on the host, execute the following:
14+
1315
```bash
1416
wfsm check
1517
```
16-
command. In case the command signals error you can pass the `-v` flag to display verbose information about the failure.
18+
19+
In case the command signals error you can pass the `-v` flag to display verbose information about the failure.
1720

1821
## Installation
1922

20-
Download the release version corresponding to the host architecture from the available [release versions](https://github.com/agntcy/workflow-srv-mgr/tags), and unpack it to a folder at your convenience.
23+
Download the release version corresponding to the host architecture from the available [release versions](https://github.com/agntcy/workflow-srv-mgr/tags), and unpack it into a folder at your convenience.
2124

2225
## Run
2326

24-
Execute the unpacked binary - it'll output the usage string with the available flags and options.
27+
Execute the unpacked binary. This outputs the usage string with the available flags and options.
2528

2629
```bash
2730

@@ -52,17 +55,16 @@ Use "wfsm [command] --help" for more information about a command.
5255

5356
```
5457

58+
## Test the Results
5559

56-
## Test the results
57-
58-
The exposed rest endpoints can be accessed with regular tools (curl, postman)
60+
The exposed rest endpoints can be accessed with regular tools (for eaxample, Curl or Postman).
5961

6062
## Examples
6163

62-
Example manifests can be found in the [wfsm tool](https://github.com/agntcy/workflow-srv-mgr/examples) repository.
64+
Example manifests can be found in the [WFSM Tool](https://github.com/agntcy/workflow-srv-mgr/examples) repository.
6365

64-
> Warning!
65-
> paths to the manifests and the paths inside the manifest definitions in the example commands need to be correct on the environment they are executed in!
66+
> Note:
67+
> Paths to the manifests and the paths inside the manifest definitions in the example commands need to be correct on the environment they are executed in!
6668
6769

6870
### Expose the [Mail Composer](https://github.com/agntcy/acp-sdk/tree/main/examples/mailcomposer) LangGraph agent through ACP workflow server
@@ -82,8 +84,4 @@ wfsm deploy -m examples/llama_manifest.json -e examples/env_vars.yaml
8284

8385
```bash
8486
wfsm deploy -m examples/manifest_with_deps.json -e examples/env_vars_with_deps.yaml
85-
```
86-
87-
88-
89-
87+
```

docs/pages/dir.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Core Concepts
22

3-
ADS (Agent Directory Service) is a distributed directory service designed to
3+
The Agent Directory Service (ADS) is a distributed directory service designed to
44
store metadata for AI agent applications. This metadata, stored as directory
55
records, enables the discovery of agent applications with specific skills for
66
solving various problems.
@@ -38,41 +38,41 @@ as described in [OCI digest](https://github.com/opencontainers/image-spec/blob/m
3838
ADS implements capability-based record discovery through a hierarchical skill
3939
taxonomy. This architecture enables:
4040

41-
1. Capability Announcement
41+
1. Capability Announcement:
4242
1. Multi-agent systems can publish their capabilities by encoding them as
4343
skill taxonomies.
4444
2. Each record contains metadata describing the agent's functional abilities.
45-
3. Skills are structured in a hierarchical format for efficient matching
46-
2. Discovery Process: The system performs a two-phase discovery operation.
45+
3. Skills are structured in a hierarchical format for efficient matching.
46+
2. Discovery Process: The system performs a two-phase discovery operation:
4747
1. Matches queried capabilities against the skill taxonomy to determine
48-
records by their identifier;
49-
2. Identifies the server nodes storing relevant records;
50-
3. Distributed Resolution: Local nodes execute targeted retrievals based on
51-
1. Skill matching results: Evaluates capability requirements
52-
2. Server location information: Determines optimal data sources
48+
records by their identifier.
49+
2. Identifies the server nodes storing relevant records.
50+
3. Distributed Resolution: Local nodes execute targeted retrievals based on:
51+
1. Skill matching results: Evaluates capability requirements.
52+
2. Server location information: Determines optimal data sources.
5353

5454
ADS uses libp2p [Kad-DHT](https://docs.libp2p.io/concepts/discovery-routing/kaddht/)
5555
for server and content discovery.
5656

5757
## Distributed Object Storage
5858

59-
ADS (Agent Directory Service) differs from block storage systems like
60-
[IPFS](https://ipfs.tech/) in its approach to distributed object storage. Here's
61-
how:
59+
ADS differs from block storage systems like
60+
[IPFS](https://ipfs.tech/) in its approach to distributed object storage.
61+
The differences are described in the following sections.
6262

6363
### Simplified Content Retrieval
6464

65-
1. ADS directly stores complete records rather than splitting them into blocks
66-
2. No special optimizations needed for retrieving content from multiple sources
67-
3. Records are retrieved as complete units using standard OCI protocols
65+
1. ADS directly stores complete records rather than splitting them into blocks.
66+
2. No special optimizations needed for retrieving content from multiple sources.
67+
3. Records are retrieved as complete units using standard OCI protocols.
6868

6969
### OCI Integration
7070

7171
ADS leverages the OCI distribution specification for content storage and retrieval:
7272

73-
1. Records are stored and transferred using OCI artifacts
74-
2. Any OCI distribution-compliant server can participate in the network
75-
3. Servers retrieve records directly from each other using standard OCI protocols
73+
1. Records are stored and transferred using OCI artifacts.
74+
2. Any OCI distribution-compliant server can participate in the network.
75+
3. Servers retrieve records directly from each other using standard OCI protocols.
7676

7777
While ADS uses zot as its reference OCI server implementation, the system works
7878
with any server that implements the OCI distribution specification.

docs/pages/messaging_sdk/agp-core.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ established frameworks:
1010

1111
LLMs (Large Language Models) and agent frameworks serve as middleware that
1212
automates processes traditionally requiring human intervention. This integration
13-
layer connects diverse systems and enables new automation capabilities through:
13+
layer connects diverse systems and enables new automation capabilities through the following:
1414

1515
- Natural language processing
1616
- Contextual understanding
@@ -28,7 +28,7 @@ workflows while ensuring:
2828
## Main Components
2929

3030
Interconnecting these systems at scale requires meeting strict latency and
31-
response time requirements. AGP aims to provide a secure, scalable, and
31+
response time requirements. Agent Gateway Protocol (AGP) aims to provide a secure, scalable, and
3232
user-friendly communication framework that unifies state-of-the-art capabilities
3333
from all mentioned frameworks into a single implementation.
3434

docs/pages/messaging_sdk/agp-data-plane.md

+17-20
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Data Plane
22

3-
The AGP data plane implements an efficient message routing and delivery system between agents.
3+
The Agent Gateway Protocol (AGP) data plane implements an efficient message routing and delivery system between agents.
44

55
## Message Format
66

@@ -17,28 +17,25 @@ message AgpMessage {
1717

1818
## Connection Table
1919

20-
The connection table maintains agent connectivity information:
21-
22-
- Maps channel IDs to connected agents
23-
- Tracks connection state and capabilities
20+
The connection table maintains agent connectivity information by mapping channel IDs to connected agents and tracking connection state and capabilities.
2421

2522
## Forwarding Table
2623

27-
The forwarding table implements intelligent message routing:
24+
The forwarding table implements intelligent message routing by implementing the following:
2825

29-
- Maps message patterns to delivery strategies
30-
- Supports content-based routing
31-
- Maintains routing metrics and preferences
32-
- Handles multicast and anycast delivery
26+
- Maps message patterns to delivery strategies.
27+
- Supports content-based routing.
28+
- Maintains routing metrics and preferences.
29+
- Handles multicast and anycast delivery.
3330

3431
## Message Buffer
3532

36-
The message buffer provides temporary storage:
33+
The message buffer provides temporary storage by implementing the following:
3734

38-
- Caches messages for reliable delivery
39-
- Implements store-and-forward when needed
40-
- Supports message deduplication
41-
- Handles out-of-order delivery
35+
- Caches messages for reliable delivery.
36+
- Implements store-and-forward when needed.
37+
- Supports message deduplication.
38+
- Handles out-of-order delivery.
4239

4340
## Data Plane Flow
4441

@@ -58,8 +55,8 @@ graph LR
5855

5956
The diagram shows the message flow through the AGP data plane components:
6057

61-
1. Messages enter the system and are processed by the Message Buffer
62-
2. The Message Buffer handles deduplication and store-and-forward
63-
3. The Forwarding Table determines routing strategy
64-
4. The Connection Table manages delivery to connected agents
65-
5. Messages are delivered via direct, multicast, or anycast methods.
58+
1. Messages enter the system and are processed by the Message Buffer.
59+
2. The Message Buffer handles deduplication and store-and-forward.
60+
3. The Forwarding Table determines routing strategy.
61+
4. The Connection Table manages delivery to connected agents.
62+
5. Messages are delivered through direct, multicast, or anycast methods.

docs/pages/messaging_sdk/agp-howto.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# Getting Started
22

3-
43
## Prerequisites
54

6-
To build the project and work with the code, you will need the following
7-
installed in your system:
5+
To build the project and work with the code, you need the following
6+
installed components in your system:
87

9-
### [Taskfile](https://taskfile.dev/)
8+
### Taskfile
109

1110
Taskfile is required to run all the build operations. Follow the
12-
[installation](https://taskfile.dev/installation/) instructions in the Taskfile
11+
[installation instructions](https://taskfile.dev/installation/) in the Taskfile
1312
documentations to find the best installation method for your system.
1413

1514
<details>
@@ -27,44 +26,47 @@ documentations to find the best installation method for your system.
2726
```
2827
</details>
2928

29+
For more information, see [Taskfile](https://taskfile.dev/).
3030

31-
### [Rust](https://rustup.rs/)
31+
### Rust
3232

3333
The data-plane components are implemented in rust. Install with rustup:
3434

3535
```bash
3636
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
3737
```
3838

39-
### [Golang]
39+
For more information, see [Rust](https://rustup.rs/).
40+
41+
### Golang
4042

41-
The control-plane components are implemented in golang. Follow the installation
43+
The control-plane components are implemented in Golang. Follow the installation
4244
instructions in the golang website.
4345

4446
## Artifacts distribution
4547

46-
### [Crates]
48+
### Crates
4749

48-
See https://crates.io/users/artifacts-agntcy
50+
For more information, see (https://crates.io/users/artifacts-agntcy).
4951

5052
```bash
5153
cargo install agp-gw
5254
```
5355

54-
### [Container images]
56+
### Container Images
5557

5658
```bash
5759
docker pull ghcr.io/agntcy/agp/gw:latest
5860
```
5961

60-
### [Helm charts]
62+
### Helm Charts
6163

6264
```bash
6365
helm pull ghcr.io/agntcy/agp/helm/agp:latest
6466
```
6567

66-
### [Pypi packages]
68+
### Pypi Packages
6769

6870
```bash
6971
pip install agp-bindings
70-
```
72+
```

docs/pages/messaging_sdk/agp-session-layer.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Session Layer
22

3-
The AGP (Agent Gateway Protocol) Session Layer manages and maintains the communication state between agents and their respective gateways. It provides essential services for establishing, maintaining, and terminating sessions between communicating entities in the AGP ecosystem.
3+
The Agent Gateway Protocol (AGP) Session Layer manages and maintains the communication state between agents and their respective gateways. It provides essential services for establishing, maintaining, and terminating sessions between communicating entities in the AGP ecosystem.
44

55
## Flow Diagram
66

@@ -31,17 +31,17 @@ sequenceDiagram
3131

3232
## Key Features
3333

34-
- **Session Establishment**: Handles the initial handshake and connection setup
35-
- **State Management**: Maintains session context and state information
36-
- **Security**: Implements session-level security measures and token management
37-
- **Error Recovery**: Provides mechanisms for handling session interruptions and failures
38-
- **Session Termination**: Manages graceful session closure and cleanup
34+
- **Session Establishment**: Handles the initial handshake and connection setup.
35+
- **State Management**: Maintains session context and state information.
36+
- **Security**: Implements session-level security measures and token management.
37+
- **Error Recovery**: Provides mechanisms for handling session interruptions and failures.
38+
- **Session Termination**: Manages graceful session closure and cleanup.
3939

4040
## Architecture
4141

42-
The session layer operates between the transport and presentation layers, providing a reliable communication framework for higher-level protocol operations. It ensures:
42+
The session layer operates between the transport and presentation layers, providing a reliable communication framework for higher-level protocol operations. It ensures the following:
4343

44-
1. Secure session initialization
45-
2. Stateful communication
46-
3. Error handling and recovery
47-
4. Graceful session termination
44+
* Secure session initialization.
45+
* Stateful communication.
46+
* Error handling and recovery.
47+
* Graceful session termination.

0 commit comments

Comments
 (0)