Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
4beb792
W-21433033 Move agent network docs into versioned agent-network compo…
IsaacEldridge May 20, 2026
ed234e4
W-21433033 Rename agent-network nav title to Building Agent Networks
IsaacEldridge May 21, 2026
70f7efe
Enhance agent network documentation by adding YAML and Agent Script r…
IsaacEldridge May 21, 2026
81c8c13
Add IT Investigation Broker example documentation and related images
IsaacEldridge May 21, 2026
334aa18
Refactor IT Investigation Broker documentation structure and enhance …
IsaacEldridge May 21, 2026
7fdec4b
Add agent network documentation for versions 1.0 and 2.0
IsaacEldridge May 22, 2026
915403f
Update agent network documentation to include configuration options a…
IsaacEldridge May 22, 2026
f59808a
Update af-agent-script-reference.adoc to clarify the behavior of the …
IsaacEldridge May 22, 2026
bd549a4
Update af-publish-agent-network-assets.adoc to clarify versioning gui…
IsaacEldridge May 27, 2026
77546a5
Clarify the behavior of the `on_exit` property in the af-agent-script…
IsaacEldridge May 27, 2026
a88c7f3
Update af-project-files.adoc to generalize file references for broker…
IsaacEldridge May 27, 2026
9cb0d61
Update af-publish-agent-network-assets.adoc to refine versioning inst…
IsaacEldridge May 27, 2026
755946b
change note to regular heading and prose
IsaacEldridge May 27, 2026
b6a1c20
Enhance agent network documentation by refining project creation and …
IsaacEldridge May 27, 2026
58e183d
Add support status attribute to Antora configuration for agent networ…
IsaacEldridge May 27, 2026
9b72088
Enhance agent network documentation by adding descriptions for skills…
IsaacEldridge May 27, 2026
aab071a
Update agent network documentation to reflect changes in directory st…
IsaacEldridge May 27, 2026
67efdad
Clarify documentation on setting action headers in af-agent-script-re…
IsaacEldridge May 28, 2026
658f193
Update agent network documentation to correct the format of the agent…
IsaacEldridge May 28, 2026
25ea733
Update af-troubleshoot-agent-networks.adoc to remove outdated logging…
IsaacEldridge May 28, 2026
0f342a2
Fix orphan ==== delimiter in af-define-your-agent-network-specificati…
IsaacEldridge May 28, 2026
969dbed
typo
IsaacEldridge May 29, 2026
ec74d26
Update af-agent-networks.adoc to clarify the handling of policies, tr…
IsaacEldridge Jun 2, 2026
f9f05ee
Add new agent fabric architecture diagram and image; remove outdated …
IsaacEldridge Jun 3, 2026
e965e52
Enhance documentation for adding Exchange assets in agent network pro…
IsaacEldridge Jun 8, 2026
3fc2bd3
Merge pull request #656 from mulesoft/W-22730742--example-for-adding-…
IsaacEldridge Jun 8, 2026
5dc3e98
Enhance troubleshooting documentation for agent networks by adding in…
IsaacEldridge Jun 9, 2026
d7a798a
Fix typo in 1.0 page notice banner URL (lastest -> latest)
IsaacEldridge Jun 9, 2026
a80ce72
Fix 1.0 page notice banner URL to use correct Antora component path
IsaacEldridge Jun 9, 2026
2fb6ab7
Enhance troubleshooting documentation for agent networks by adding ne…
IsaacEldridge Jun 9, 2026
18cbf20
remove issue
IsaacEldridge Jun 9, 2026
fae8e63
checking docs with super agent
IsaacEldridge Jun 10, 2026
d650596
Carry forward xref fix from latest: scope flex-gateway-llm-proxy with…
IsaacEldridge Jun 12, 2026
13d80b1
Merge remote-tracking branch 'origin/latest' into W-21433121-agent-ne…
IsaacEldridge Jun 12, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions agent-network/1.0/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: agent-network
title: Building Agent Networks
version: '1.0'
display_version: '1.0'
start_page: af-agent-networks.adoc
nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
page-notice-banner-message: You're viewing version 1.0 documentation. You can edit and redeploy existing 1.0 projects, but you must create new projects with version 2.0. Switch to <a href="https://docs.mulesoft.com/agent-network/latest/af-get-started" target="_blank" rel="noopener">version 2.0</a>.
10 changes: 10 additions & 0 deletions agent-network/1.0/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.xref:af-agent-networks.adoc[Building Agent Networks]
* xref:af-agent-networks.adoc[Overview]
* xref:af-get-started.adoc[]
* xref:af-create-agent-network.adoc[]
* xref:af-define-your-agent-network-specification.adoc[]
* xref:af-publish-agent-network-assets.adoc[]
* xref:af-deploy-agent-network-targets.adoc[]
* xref:af-troubleshoot-agent-networks.adoc[]
* xref:af-build-agent-networks-in-a-ci-cd-environment.adoc[]
* xref:af-project-files.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ An autonomous software component that uses goals, context, and available tools,
Agents can be defined either locally in the agent network or externally in a different agent network or elsewhere in your company.
Your agent network can use both locally defined and externally defined agents to complete tasks.
+
include::anypoint-code-builder::partial$af-shared.adoc[tags="agent-support"]
include::partial$af-shared.adoc[tags="agent-support"]

MCP server::
A service that implements the Model Context Protocol (MCP) to expose tools and data to AI clients, enabling LLMs to invoke external capabilities through a standard interface.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ To get started, try one of these suggested messages.
* In Create, select *Create an Agent Network*.
* From the Command Palette, run this command: *MuleSoft: Create an Agent Network Project*.
. Enter a name for the project and select the location to create the project.
. Select the business group associated with the target space you created in xref:anypoint-code-builder::af-get-started.adoc[Get Started with Agent Networks]. The business group you select must be the same business group you selected when you created the target space.
. Select the business group associated with the target space you created in xref:af-get-started.adoc[Get Started with Agent Networks]. The business group you select must be the same business group you selected when you created the target space.
. Select *Create Project*.

Anypoint Code Builder creates these files as part of your agent network project. These files define your agent network specification to meet your business requirements. For more information, see xref:anypoint-code-builder::af-project-files.adoc[Agent Network Project File Reference].
Anypoint Code Builder creates these files as part of your agent network project. These files define your agent network specification to meet your business requirements. For more information, see xref:af-project-files.adoc[Agent Network Project File Reference].

* `agent-network.yaml`
+
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
[[define-spec]]
= Define Your Agent Network Specification

After you create your agent network project, configure `agent-network.yaml` and `exchange.json` to reflect the structure of your network.

[[before-you-begin]]
== Before You Begin

Make sure you review the xref:af-get-started.adoc#before-you-begin[prerequisites].

[TIP]
To help you identify agents that are also brokers on the Anypoint Code Builder canvas, consider appending "Broker" to the end of the name, for example `employee-onboarding-broker`.

[[define-dev-agent]]
== Define a Network Using MuleSoft Vibes

MuleSoft Vibes can help you configure your agent network specification. For more information, see xref:anypoint-code-builder::api-ai-create-spec.adoc[].

. In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18].
. Give the agent information about your agent network, including the brokers, agents, MCP servers, and LLMs you want to connect.

To get started, try one of these suggested messages.

* Help me build an agent network configuration for my Employee Onboarding project.
* Revise my Employee Onboarding agent network project. Use OpenAI for the LLM.
* Add a new broker for employee offboarding to my HR agent network.
* Add a new skill to Offboarding broker.

[[define-acb-ide]]
== Define a Network Using Anypoint Code Builder or IDE

If you don't want to use MuleSoft Vibes, use Anypoint Code Builder or your IDE to edit the `agent-network.yaml` and `exchange.json` files and define your agent network and authentication.

To understand sections of the project files and expected values, see xref:af-project-files.adoc[Agent Network Project File Reference]. The `agent-network.yaml` file can contain definitions for one or more brokers.

If your agent network references Anypoint Exchange assets, you need to use the asset IDs in `exchange.json` to add references in the `agent-network.yaml` file. For more information, see <<add-exchange-assets>>.

Use auto-completion menus in Anypoint Code Builder to speed your development. For more information, see xref:anypoint-code-builder::start-discover-ui.adoc#use-autocomplete[Use Auto-Completion Menus].

[[add-exchange-assets]]
== Add Exchange Assets to Your Agent Network Project

If you have existing Exchange assets to use in your agent network, add them to the `dependencies` attribute in `exchange.json` in your project. After you add assets, edit the `agent-network.yaml` file to indicate which brokers use those assets. This applies to both assets your own business group owns and public assets from a different business group.

For a complete example, see <<exchange-assets-example,Example: Reference an Exchange Asset from Your Agent Network>>.

=== Add Assets Using MuleSoft Vibes

. In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18].
. Tell the agent that you want to add Exchange assets to your project. MuleSoft Vibes does the rest.

To get started, try one of these suggested messages.

* Add tools for background check processing in my Employee Onboarding project.
* Add a Talent Pool MCP server to my Employee Onboarding agent network project.

[[add-assets-acb]]
=== Add Assets Using Anypoint Code Builder

To reference existing Exchange assets in your agent network project, follow these steps. This procedure applies whether the asset belongs to your own business group or to a different business group (for example, a public Exchange asset).

. If you're not logged in already, log in to your Anypoint Platform account.
. In your Anypoint Code Builder project, choose one of the following:
* In Explorer, right-click a project file and select *Add Exchange Assets to Agent Network Project*.
* In the Command Palette, run this command: *MuleSoft: Add Agent Network Assets to Agent Network Project*.
. In Add Exchange Assets to Project, enter information about the assets to add.
. Select *Add to Project*.
+
Assets are added to the `dependencies` attribute in the `exchange.json` file in your project.
. Edit the `agent-network.yaml` file to indicate which brokers use those assets:
+
.. Add a connection entry for each asset in the `context.connections` section. Set `kind` to match the asset type (`a2a`, `mcp`, or `llm`), and set `ref.name` to the asset's `assetId` from `exchange.json`.
.. Reference the connection from one or more brokers (for example, from a broker's `llm`, `links`, or `tools` section).
.. If the asset belongs to a different business group than your agent network, specify the `namespace` property at the same level as `name`. Provide the `groupId` (business group ID) for the business group that the dependency belongs to. The `groupId` value is the same as the `groupId` value of the corresponding dependency in `exchange.json`. If you don't provide a `namespace` value, the same `groupId` as the agent network project is used.

After you add dependencies, they're available as values in auto-completion menus in Anypoint Code Builder. For example, after you add `test-agent` to `exchange.json`, the value `test-agent` is available in auto-completion menus in the code editor in `agent-network.yaml` when you reference an agent.

[[exchange-assets-example]]
=== Example: Reference an Exchange Asset from Your Agent Network

This example shows a complete `exchange.json` and `agent-network.yaml` for a project that consumes an A2A agent (`helpCenterAgentTestV3`) from Anypoint Exchange. The same pattern applies to MCP servers and LLMs: change the connection `kind` to `mcp` or `llm`, and adjust the `dependencies` classifier in `exchange.json` accordingly.

In `exchange.json`, the asset is listed in the `dependencies` array. The `groupId` value identifies the business group that owns the asset. If the asset belongs to a different business group than your project, use that asset's `groupId` in the connection's `namespace` value in `agent-network.yaml`.

[source,json]
----
{
"main": "agent-network.yaml",
"name": "brokerV2-template",
"classifier": "agentic-network",
"organizationId": "b4c12f0a-c376-4561-878c-f4f0540c5407",
"descriptorVersion": "1.0.0",
"tags": [],
"metadata": {
"variables": {
"myAgent": {
"url": {
"description": "My External Agent URL",
"default": "",
"secret": false
}
}
}
},
"dependencies": [
{
"classifier": "agent-metadata",
"packaging": "zip",
"groupId": "b4c12f0a-c376-4561-878c-f4f0540c5407",
"assetId": "helpCenterAgentTestV3",
"version": "1.0.2"
}
],
"groupId": "b4c12f0a-c376-4561-878c-f4f0540c5407",
"assetId": "brokerv2-template",
"version": "1.0.0"
}
----

In `agent-network.yaml`, the asset is declared as a connection in `context.connections`. The connection `kind` matches the asset type (`a2a` for an agent, `mcp` for an MCP server, or `llm` for an LLM), and `ref.name` matches the `assetId` from `exchange.json`. The `ref.namespace` value matches the asset's `groupId`. URL and credential values are typically supplied through variables defined in `exchange.json`. After defining the connection, brokers reference it by name from their `llm`, `links`, or `tools` sections.

[source,yaml]
----
agentNetwork: 2.0.0
info:
label: brokerV2-template
version: v1
registry: {}
context:
connections:
helpCenterAgentTestV3:
kind: a2a
ref:
name: helpCenterAgentTestV3
namespace: b4c12f0a-c376-4561-878c-f4f0540c5407
url: ${myAgent.url}
brokers:
broker1:
kind: AgentScript
implementation: ./brokers/broker1.agent
interfaces:
a2a:
card:
name: Broker 1
description: Describe what your broker does.
url: http://localhost:8081/broker1
version: 1.0.0
protocolVersion: 0.3.0
capabilities:
streaming: true
pushNotifications: false
defaultInputModes:
- text/plain
defaultOutputModes:
- text/plain
skills:
- id: my-skill
name: My Skill
description: Describe what this skill does.
tags:
- general
----

Because the connection in this example uses an explicit `namespace`, this same configuration works whether the asset belongs to the project's business group or to a different one (such as a public Exchange asset). To consume a public asset, copy the asset's `groupId` from Anypoint Exchange into both the `dependencies` entry in `exchange.json` and the connection's `namespace` value in `agent-network.yaml`.

Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To get started, try one of these suggested messages.
. In Anypoint Code Builder, choose one of the following:
. In Explorer, right-click a project file and select *Deploy Agent Network*.
. From the Command Palette, run this command: *MuleSoft: Deploy Agent Network*.
. In Deploy Agent Network, specify the environment, target space, gateways, and other deployment information. If you don't see any deployment targets to select, then you need to set up your target deployment space and set up gateways. For instructions, see xref:anypoint-code-builder::af-get-started.adoc[Get Started with Agent Networks].
. In Deploy Agent Network, specify the environment, target space, gateways, and other deployment information. If you don't see any deployment targets to select, then you need to set up your target deployment space and set up gateways. For instructions, see xref:af-get-started.adoc[Get Started with Agent Networks].
. Select *Deploy*.
. Your instances are deployed and ready to be tested. An instance is deployed for each connection defined in your agent network. If your agent network contains brokers, one instance is deployed per broker.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[get-started]]
= Get Started with Agent Networks

include::anypoint-code-builder::partial$af-shared.adoc[tags=get-started]
include::partial$af-shared.adoc[tags=get-started]

[[setup-space]]
== Set Up the Private Space or Deployment Target for Your Environment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ If you installed Anypoint Code Builder successfully, but you don’t see agent n

=== Issue: No Agent Network Deployment Targets

If you attempt to deploy an agent network, but you don’t see any deployment targets in Anypoint Code Builder or Anypoint CLI, then you need to set up your target deployment space and set up gateways. For instructions, see xref:anypoint-code-builder::af-get-started.adoc[Get Started with Agent Networks].
If you attempt to deploy an agent network, but you don’t see any deployment targets in Anypoint Code Builder or Anypoint CLI, then you need to set up your target deployment space and set up gateways. For instructions, see xref:af-get-started.adoc[Get Started with Agent Networks].

=== Error: "Cannot complete task due to issue accessing reasoning engine"

Expand Down
130 changes: 130 additions & 0 deletions agent-network/1.0/modules/ROOT/partials/af-shared.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
//
// tag::agent-support[]
Agent assets must be A2A-compliant.
// end::agent-support[]
//

//
// tag::get-started[]
Creating agent networks is a multi-step process. Review these prerequisites and task overviews to make sure you can create agent networks efficiently.

[[before-you-begin]]
== Before You Begin

Before you get started, review these prerequisites.

[[platform-requirements]]
=== Anypoint Platform Requirements and Permissions

[cols="1,1"]
|===
|Anypoint Platform Component |Required Permissions

|Runtime Manager
a|

* Manage Servers
* Create Applications
* Read Servers

|Anypoint Code Builder
a|

* Anypoint Code Builder
* Mule Developer Generative AI User

|Anypoint Design Center
|Design Center Developer

|API Manager
a|

* Deploy API Proxies
* Manage Policies

|Exchange
|Exchange Contributor

|Usage
|Usage Viewer

|CloudHub 2.0 or Runtime Fabric
|xref:runtime-fabric::limitations-self.adoc[Runtime Fabric permissions] xref:cloudhub-2::ps-assign-permissions.adoc[CloudHub 2.0 permissions]
|===

See xref:access-management::permissions-by-product.adoc[] for a list of all Anypoint Platform permissions.

[[additional-reqs]]
=== Additional Requirements

To complete these tasks, you also need:

* Your Anypoint Platform credentials
* xref:anypoint-code-builder::start-acb.adoc[Anypoint Code Builder desktop]
+
Allowlist Anypoint Code Builder URLs. For more information, see xref:anypoint-code-builder::urls-to-allow.adoc[Allow URLs for Anypoint Code Builder].
* xref:gateway::flex-gateway-managed-ingress-egress.adoc[Omni Gateway Ingress and Egress gateways]

=== MuleSoft Vibes Requirements (Optional)

If you plan to use MuleSoft Vibes to create agent network projects, make sure you meet xref:anypoint-code-builder::mulesoft-vibes.adoc#before-you-begin[the requirements].

[[cli-requirements]]
=== CLI Requirements (Optional)

If you're using the Anypoint CLI to create agent network projects, ensure you meet these requirements.

* Node 20 (v20.19.4) or later. See https://nodejs.org/en[Nodejs.org].
* Java 17 or later. Set the `JAVA_HOME` environment variable.
* xref:af-build-agent-networks-in-a-ci-cd-environment.adoc[Anypoint CLI Fabric Plugin]

[[overview]]
== Task Overview

[[step-1-setup]]
=== Step 1: Set Up Your Agent Network

. Use Anypoint Runtime Manager to set up a private space in CloudHub 2.0 or deployment target in Runtime Fabric.
+
See xref:af-get-started.adoc#setup-space[Set Up the Private Space or Deployment Target for Your Environment].
. Set up Ingress and egress Omni Gateways for the private space or deployment target.
+
* If using Anypoint Code Builder, see xref:af-get-started.adoc#setup-gateways[Set Up Agent Network Gateways for the Private Space or Deployment Target].
* If using the Anypoint CLI, see the xref:af-build-agent-networks-in-a-ci-cd-environment.adoc#agent-network-setup-gateways[setup gateways command reference].

[[step-2-create]]
=== Step 2: Create a Project

Now you're ready to create an agent network project. Choose one of these methods.

* xref:af-create-agent-network.adoc#create-dev-agent[Create a Network Using MuleSoft Vibes]
* xref:af-create-agent-network.adoc#create-acb[Create a Network Using Anypoint Code Builder]
* xref:af-create-agent-network.adoc#create-cli[Create a Network Using the Anypoint CLI]

[[step-3-define]]
=== Step 3: Define Your Agent Network Specification

After you create your agent network project, configure `agent-network.yaml` and `exchange.json` to reflect the structure of your network.

* xref:af-define-your-agent-network-specification.adoc#define-dev-agent[Define a Network Using MuleSoft Vibes]
* xref:af-define-your-agent-network-specification.adoc#define-acb-ide[Define a Network Using Anypoint Code Builder or IDE]

[[step-4-publish]]
=== Step 4: Publish Your Agent Network Assets

Build and publish your agent network project as Anypoint Exchange assets. When you publish the agent network, an asset is created in Exchange for each broker, agent, and MCP server that's in your agent network.

* xref:af-publish-agent-network-assets.adoc#publish-dev-agent[Publish Your Network Using MuleSoft Vibes]
* xref:af-publish-agent-network-assets.adoc#publish-acb[Publish Your Network Using Anypoint Code Builder]
* xref:af-build-agent-networks-in-a-ci-cd-environment.adoc#agent-network-project-publish[Publish Your Network Using the Anypoint CLI]

[[step-5-deploy]]
=== Step 5: Deploy Your Agent Network Instances

Deploy your agent network instance to a deployment target. You can deploy to a CloudHub 2.0 private space or to a Runtime Fabric.

* xref:af-deploy-agent-network-targets.adoc#deploy-dev-agent[Deploy Your Network Using MuleSoft Vibes]
* xref:af-deploy-agent-network-targets.adoc#deploy-acb[Deploy Your Network Using Anypoint Code Builder]
* xref:af-build-agent-networks-in-a-ci-cd-environment.adoc#agent-network-project-deploy[Deploy Your Network Using the Anypoint CLI]
// end::get-started[]
//
7 changes: 7 additions & 0 deletions agent-network/2.0/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: agent-network
title: Building Agent Networks
version: '2.0'
display_version: '2.0'
start_page: af-agent-networks.adoc
nav:
- modules/ROOT/nav.adoc
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions agent-network/2.0/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.xref:af-agent-networks.adoc[Building Agent Networks]
* xref:af-agent-networks.adoc[Overview]
* xref:af-get-started.adoc[]
* xref:af-create-agent-network.adoc[]
* xref:af-define-your-agent-network-specification.adoc[]
* xref:af-publish-agent-network-assets.adoc[]
* xref:af-deploy-agent-network-targets.adoc[]
* xref:af-troubleshoot-agent-networks.adoc[]
* xref:af-build-agent-networks-in-a-ci-cd-environment.adoc[]
* xref:af-project-files.adoc[]
** xref:af-agent-network-yaml-reference.adoc[]
** xref:af-agent-script-reference.adoc[]
* xref:af-example-it-investigation-broker.adoc[]
Loading