Skip to content

Commit cafbe9a

Browse files
Fix typos and formatting issues
1 parent 1b36df4 commit cafbe9a

File tree

3 files changed

+29
-30
lines changed

3 files changed

+29
-30
lines changed

docs/pages/connect.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Agent Connect Protocol
1+
# Agent Connect Protocol
22

33
## Introduction
44

55
Existing Multi-Agent Systems (MAS) provide convenient ways to build Multi-Agent Applications (MAAs) that combine various agents and enable them to communicate with each other. Such communication occurs within the MAS using internal mechanisms and APIs.
66

7-
Building the Internet of Agents (IoA) requires agents built by different parties, potentially for different MAS and potentially running in different locations to interact.
7+
Building the Internet of Agents (IoA) requires agents built by different parties, potentially for different MAS and potentially running in different locations to interact.
88

99
While interaction between co-located agents implemented through the same MAS is trivial, it is harder in case the agents are not natively compatible or in case they run in different locations.
1010

@@ -21,11 +21,11 @@ Agent Connect Protocol needs to formally specify the network interactions needed
2121
* **Authentication**: Define how caller authenticates with an agent and what its permissions are.
2222
* **Configuration**: Define how to configure a remote agent.
2323
* **Invocation**: Define how to invoke a remote agent providing input for its execution.
24-
* **Output retrieval and interrupt Handling**: Define how to retrieve the result of an agent invocation. Different interaction modes should be supported:
24+
* **Output retrieval and interrupt Handling**: Define how to retrieve the result of an agent invocation. Different interaction modes should be supported:
2525
* Synchronous
2626
* Asynchronous
2727
* Streaming
28-
28+
2929
This should include interrupt handling. That is, how agents notify the caller about execution suspension to ask for additional input.
3030
* **Capabilities and Schema definitions**: Retrieve details about the agent supported capabilities and the data structures definitions for configuration, input, and output.
3131
* **Error definitions**: Receive error notifications with meaningful error codes and explanations.
@@ -43,7 +43,7 @@ For the reason above, ACP must define an endpoint that does not require authenti
4343
<a id="configuration"></a>
4444
### Configuration
4545

46-
Agents may support configuration.
46+
Agents may support configuration.
4747

4848
Configuration is meant to provide parameters needed by the agent to function and to flavor their behavior.
4949

@@ -73,10 +73,10 @@ The invocation endpoint must accept the following parameters:
7373
* **Optional configuration**
7474

7575
When provided, this configuration is valid only for this invocation. Alternatively, the invocation endpoint must accept the identifier of a previously configured instance of an agent. For more information, see [Configuration](#configuration).
76-
76+
7777
* **Optional callback**
78-
79-
When provided, the output of the invocation is provided asynchronously through the provided callback. For more information. For more information, see [Output Retrieval and Interrupt Handling](#output).
78+
79+
When provided, the output of the invocation is provided asynchronously through the provided callback. For more information, see [Output Retrieval and Interrupt Handling](#output).
8080

8181
* **Optional execution identifier**
8282

@@ -113,23 +113,23 @@ The ACP must define an endpoint that provides schema definitions for configurati
113113

114114
Different agents may implement different parts of the protocol. For example: an agent may support streaming, while another may only support full responses. An agent may support threads while another may not.
115115

116-
The ACP must define and endpoint that provides details about the specific capabilities that the agent supports.
116+
The ACP must define an endpoint that provides details about the specific capabilities that the agent supports.
117117

118118
Schemas, agent capabilities, and other essential information that describe an agent are also needed in what we call the [Agent Manifest](manifest.md).
119119

120120
<a id="errors"></a>
121121
### Error Definitions
122122

123-
Each of the operations offered by the ACP can produce an error.
123+
Each of the operations offered by the ACP can produce an error.
124124

125125
Errors can be provided synchronously by each of the invoked endpoints or asynchronously when they occur during an execution that supports asynchronous output.
126126

127-
The ACP must define errors for the most common error conditions.
127+
The ACP must define errors for the most common error conditions.
128128

129129
Each definition must include the following details:
130130
* Error code.
131131
* Description of the error condition.
132132
* A flag that says if the error is transient or permanent.
133133
* An optional schema definition of additional information that the error can be associated with.
134134

135-
The ACP also allows agents to provide definitions of errors specific for that agent. For this purpose, the ACP must define an endpoint that provides schema definitions for all agent specific errors that are not included in the ACP specification.
135+
The ACP also allows agents to provide definitions of errors specific for that agent. For this purpose, the ACP must define an endpoint that provides schema definitions for all agent specific errors that are not included in the ACP specification.

docs/pages/introduction.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
## Introduction
22

3-
The AGNTCY is an open source collective building the infrastructure for The Internet of Agents: an open, interoperable internet for agent to agent collaboration.
3+
The AGNTCY is an open source collective building the infrastructure for The Internet of Agents: an open, interoperable internet for agent to agent collaboration.
44

55
### Vision
66

77
Agentic AI will accelerate all of human work. Enterprises must create agentic workflows and applications combining internal and 3rd party agents to fully leverage the power of AI, accelerate their business and unlock new step-change in productivity.
8-
We believe that an open, interoperable Internet of Agents is the key to enabling the best possible path forward to accelerate innovation and create the most value for all participants, from builders to operators, developers to consumers across all industries and businesses.
8+
We believe that an open, interoperable Internet of Agents is the key to enabling the best possible path forward to accelerate innovation and create the most value for all participants, from builders to operators, developers to consumers across all industries and businesses.
99

1010
### Mission
1111

12-
We are an open source collective that will build the Internet of Agents to be accessible for all: A diverse, collaborative space to innovate, develop, and maintain software components and services that solve key problems in the domain of agentic workflows and multi-agent applications.
12+
We are an open source collective that will build the Internet of Agents to be accessible for all: A diverse, collaborative space to innovate, develop, and maintain software components and services that solve key problems in the domain of agentic workflows and multi-agent applications.
1313

1414
### Capabilities
1515

16-
Based on advanced protocols, frameworks and components, the goal of IoA software infrastructure enables and simplify the creation of multi-agent applications through the following steps:
17-
1. DISCOVER: Find and evaluate the best agents for the job.
18-
1. COMPOSE: Connect agents into effective workflows across any framework or vendor.
19-
1. DEPLOY: Run multi-agent systems at scale, securely.
20-
1. EVALUATE: Monitor performance and improve efficiency and efficacy over time.
16+
Based on advanced protocols, frameworks and components, the goal of IoA software infrastructure is to enables and simplify the creation of multi-agent applications through the following steps:
17+
1. **DISCOVER**: Find and evaluate the best agents for the job.
18+
1. **COMPOSE**: Connect agents into effective workflows across any framework or vendor.
19+
1. **DEPLOY**: Run multi-agent systems at scale, securely.
20+
1. **EVALUATE**: Monitor performance and improve efficiency and efficacy over time.
2121

2222
### Technical Objectives
2323

@@ -28,7 +28,7 @@ Based on advanced protocols, frameworks and components, the goal of IoA software
2828

2929
### Core Components
3030

31-
The initial set of IoA components and architecture is described below. As a very first step, we are sharing 2 important specifications: OASF and ACP. In a few weeks the collective will release code and documentation for most of the components. This is a starting point - as new members join and bring their contributions, the collective will continue to evolve and expand the IoA architecture, components and interfaces.
31+
The initial set of IoA components and architecture is described below. As a very first step, we are sharing 2 important specifications: OASF and ACP. In a few weeks the collective will release code and documentation for most of the components. This is a starting point - as new members join and bring their contributions, the collective will continue to evolve and expand the IoA architecture, components and interfaces.
3232

3333
```{image} ../_static/ioa_stack.png
3434
:alt: Simplified Internet of Agent Stack
@@ -42,7 +42,7 @@ The initial set of IoA components and architecture is described below. As a very
4242
1. **Agent Connect Protocol (ACP)**: A protocol that defines a standard interface to invoke agents, configure them, provide input, and retrieve output. Current ACP spec can be found [here](https://spec.acp.agntcy.org/).
4343
1. **Multi-Agent Application Toolkit**: A set of agents and software libraries that support seamless creation of Multi-Agent workflows.
4444
1. **Agent Workflow Server**: A server that leverages ACP to manage and executes workflows involving multiple AI agents, ensuring coordinated and efficient task execution.
45-
1. **Agent Manifest**: A standard format to describes agents, their capabilities, their dependencies, and how to deploy or consume them. The manifest is designed to be used by ACP and the Workflow Server and stored in the Agent Directory with the corresponding OASF extensions.
45+
1. **Agent Manifest**: A standard format to describes agents, their capabilities, their dependencies, and how to deploy or consume them. The manifest is designed to be used by ACP and the Workflow Server and stored in the Agent Directory with the corresponding OASF extensions.
4646
1. **Agent Gateway Protocol (AGP)**: A protocol that defines the standards and guidelines for secure and efficient network-level communication between AI agents. AGP ensures interoperability and seamless data exchange by specifying message formats, transport mechanisms, and interaction patterns.
4747
1. **Agent Observability**: Tools and techniques for monitoring and analyzing the behavior and performance of AI agents, providing insights into their operations and interactions.
4848

@@ -61,4 +61,3 @@ The following diagram shows a simplified architecture of the core components des
6161
2. **Improved Efficiency**: Standardized protocols and frameworks reduce the complexity of integrating diverse AI agents, resulting in faster development and deployment of AI-driven applications.
6262
3. **Increased Security**: Robust security mechanisms ensure that interactions between agents are secure, protecting sensitive data and preventing unauthorized access.
6363
4. **Future-Proof Architecture**: The scalable and flexible design of IoA ensures that the ecosystem can grow and adapt to future advancements in AI technology.
64-

docs/pages/manifest.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ An Agent Manifest is a document that describes in detail the following:
88
* How the agent can be deployed if provided as a deployable artifact.
99
* What are the dependencies of the agent, that is, which other agents it relies on.
1010

11-
The manifest is designed to be used by [Agent Connect Protocol](connect.md) and the Workflow Server and stored in the Agent Directory with the corresponding OASF extensions.
11+
The manifest is designed to be used by [Agent Connect Protocol](connect.md) and the Workflow Server and stored in the Agent Directory with the corresponding OASF extensions.
1212

1313
This document describes the principles of the Agent Manifest definition.
1414

@@ -23,7 +23,7 @@ Agent Manifest includes the following sections:
2323
<a id="agent-identification-and-metadataidentification"></a>
2424
### Agent Identification and Metadata
2525

26-
Agent Manifest must uniquely identify an agent within the namespace it is part of. This is done through a unique name and a version.
26+
Agent Manifest must uniquely identify an agent within the namespace it is part of. This is done through a unique name and a version.
2727

2828
Agent Manifest must include a natural language description that describes what the agent is capable of doing. This allows user and potentially other agents to select the agent that best fits a given task.
2929

@@ -35,20 +35,20 @@ Agents willing to interoperate with other agents expose an interface that allow
3535

3636
Agent Connect Protocol specifies a standard for this interface. However, it specifies methods to configure and invoke agents, but it does not specify the format of the data structures that an agent expects and produces for such configurations and invocations.
3737

38-
The specification of these data structures is included in the what we call the Agent ACP descriptor, which can be provided by ACP itself, but it is also defined as part of the Agent Manifest.
38+
The specification of these data structures is included in what we call the Agent ACP descriptor, which can be provided by ACP itself, but it is also defined as part of the Agent Manifest.
3939

4040
Agent ACP descriptor must include an interface data structure specification section that provides schema definitions for the following data structures:
41-
* **Configuration**: The data structure used to provide agent configuration.
41+
* **Configuration**: The data structure used to provide agent configuration.
4242
* **Input**: The data structures used to provide agent input.
4343
* **Output**: The data structure used to retrieve agent output.
4444

45-
If an agent supports interrupts, meaning its execution can be interrupted to request additional input and then resumed, the Agent Manifest needs to define the types of interrupts that can possibly occur.
45+
If an agent supports interrupts, meaning its execution can be interrupted to request additional input and then resumed, the Agent Manifest needs to define the types of interrupts that can possibly occur.
4646

4747
For each of the interrupts it must define the following:
4848
* **Interrupt Output**: The format of the output provided by the specific interrupt.
4949
* **Resume Input**: The input expected by the agent to resume its execution when this specific interrupt occurs.
5050

51-
All schema definitions must include natural language description of the data structure, natural language description of each data structure element, and valid examples of correctly populated data structures.
51+
All schema definitions must include natural language description of the data structure, natural language description of each data structure element, and valid examples of correctly populated data structures.
5252

5353
<a id="agent-deployment-and-consumption"></a>
5454
### Agent Deployment and Consumption
@@ -67,7 +67,7 @@ The Agent Manifest must include a list of all the possible deployment modes supp
6767
<a id="agent-dependencies"></a>
6868
### Agent Dependencies
6969

70-
An agent may depend on other agents, which means that at some point of its execution it needs to invoke them to accomplish its tasks. We refer to these other agents as **sub-agents**. A user who wants to use the agent, needs to know this information and check that the dependencies are satisfied, that is, make sure that the sub-agents are available.
70+
An agent may depend on other agents, which means that at some point of its execution it needs to invoke them to accomplish its tasks. We refer to these other agents as **sub-agents**. A user who wants to use the agent, needs to know this information and check that the dependencies are satisfied, that is, make sure that the sub-agents are available.
7171
This may imply simply checking that sub-agents are reachable or deploying them, according to the deployment modes they support.
7272

7373
The Agent Manifest must include a list of all sub-agents in the form of a list of references to their manifests.

0 commit comments

Comments
 (0)