Skip to content

Commit 31be355

Browse files
authored
Merge pull request #403 from mulesoft/W-21984387-omni-draft-review-LDS
W-21984387-omni-draft-review
2 parents 22ee394 + f330203 commit 31be355

1 file changed

Lines changed: 66 additions & 81 deletions

File tree

modules/ROOT/pages/mulesoft-omni.adoc

Lines changed: 66 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -2,103 +2,88 @@
22
:page-aliases:
33
:page-article-style: learning-map
44

5-
MuleSoft Omni pairs an AI-powered assistant with a single, unified experience for your portfolio. The assistant helps you manage, connect, and optimize integrations across your digital ecosystem. Use it to understand how agents, APIs, and infrastructure fit together, apply governance, and act on performance and cost recommendations. Omni guides you through complex setup so you can keep integrations compliant and observable without juggling every tool manually.
5+
MuleSoft Omni pairs an AI-powered assistant with one place to manage your portfolio. The assistant helps you connect and tune integrations across your ecosystem. It shows how agents, APIs, gateways, MCP servers, and LLMs fit together, where to apply governance, and how to act on performance and cost signals. Omni walks you through setup so you keep integrations compliant and visible without switching tools.
66

7-
The experience is organized around the jobs you perform on your portfolio. For agents, APIs, gateways, MCP servers, and LLMs, you move through overview, instances, governance, and observability in one connected path for each asset. Integration and environment-wide controls are grouped under Platform so that work stays in one place instead of scattered across separate areas of the product.
7+
Omni centers the UI on the jobs you do. Under *Portfolio* in the left navigation, you get a catalog for each asset type you manage: agents, MCP servers, LLMs, APIs, and gateways. For each asset, you move through overview, instances, governance, and observability on one path. Cross-cutting governance and monitoring sit under *Governance* and *Observability*. Environment-wide controls sit under *Platform*.
88

9-
Omni brings together Agents, Governance, Observability, and Platformfour areas where you work with your portfolio.
9+
Portfolio, Governance, Observability, and Platform are the four areas where you work with your portfolio.
1010

11-
From sign-in through your home overview and catalogs, you open each asset to work with policies, instances, monitoring, and governance reports in one place, aligned with how you manage work across Omni.
11+
From sign-in through *Home* and your catalogs, you open each asset and use its detail tabs in one place.
1212

1313
== End-to-End Journey: Working in MuleSoft Omni
1414

15-
. *Signing in* -- You sign in to Omni with your credentials and arrive at the Home Dashboard.
16-
. *Reviewing the Home Dashboard* -- The home overview highlights what matters most: totals for agents and APIs, average latency, compliance status, and trends you can scan at a glance.
17-
. *Opening catalogs* -- From the main menu, you browse catalogs for Agents, APIs, MCP Servers, and LLMs. For example, you open *Agents* to see every agent in your environment.
18-
. *Reviewing an agent* -- In the Agents catalog, agents are listed in a clear layout. You select an agent—for example, the MuleSoft Documentation Agent—and review its status, cost per day, latency, and skills in full.
19-
. *Managing policies* -- Under *Policies*, you see which governance policies apply so compliance and performance expectations stay clear.
20-
. *Reviewing instances* -- Under *Instances*, you see where the agent is deployed, review configuration, and inspect behavior for each deployment.
21-
. *Checking performance* -- Under *Monitoring*, you review live analytics such as latency, invocation counts, and error rates.
22-
. *Reading governance reports* -- Under *Governance Report*, you review rule-level compliance, violations, and warnings across services.
23-
. *Getting help or sharing feedback* -- You can send feedback to the support team and open Help & Support for documentation or contact options when you need assistance.
24-
25-
This walkthrough shows how to move through Omni in a straightforward way so you can manage and improve a multi-agent environment with confidence.
26-
27-
The table summarizes what you can do in each area of Omni and points to the sections in this topic where each area is described in full.
28-
29-
[.lm-table, cols="1a,1a,1a", grid="none"]
30-
|===
31-
| image::reuse::lm_start.png[]
32-
[.lm-bold]##Agents##
33-
34-
- Discover and manage agents and see how they connect to APIs, gateways, MCP servers, and LLMs
35-
- Review performance and cost, and tune how agents run
36-
37-
| image::reuse::lm_explore_1.png[]
38-
[.lm-bold]##Governance##
39-
40-
- Apply and track policies across APIs, agents, and related assets
41-
- Automate policy rollout and stay audit-ready with reports and rule analysis
42-
43-
| image::reuse::lm_analyze_1.png[]
44-
[.lm-bold]##Observability##
45-
46-
- Monitor latency, throughput, and errors with dashboards and analytics
47-
- Investigate issues and align operational insight with governance reporting
48-
49-
| image::reuse::lm_test_1.png[]
50-
[.lm-bold]##Platform##
51-
52-
- Manage connections and environment-wide settings for agents, APIs, and integrations
53-
- Adapt Omni to how your organization works
54-
55-
| image::reuse::lm_build_1.png[]
56-
[.lm-bold]##Areas in this topic##
57-
58-
- <<agents>>
59-
- <<governance>>
60-
- <<observability>>
61-
- <<platform>>
62-
63-
| image::reuse::lm_audience_end_1.png[]
64-
[.lm-bold]##More help##
65-
66-
- Use Help & Support in Omni when you need documentation or to contact support
67-
|===
68-
69-
[[agents]]
70-
== Agents
71-
72-
Agents are integral to the MuleSoft Omni platform, serving as specialized software entities that perform specific tasks or processes. Within the Agents section, you can:
73-
74-
* *Explore a diverse array of agents* -- Discover and manage all active and inactive agents, each designed for unique functions such as data processing, customer support, or compliance checks. See how agents relate to APIs, gateways, MCP servers, and LLMs so you understand roles and dependencies at a glance.
75-
* *Optimize agent operations* -- Access performance metrics and cost details for each agent to optimize their operations and ensure efficient resource usage.
76-
* *Enable seamless interactions* -- Connect agents with APIs, LLMs, and MCP servers to enhance capabilities and extend functionality across your digital ecosystem.
15+
This walkthrough follows the path you take in Omni so you can grow and tune your AI portfolio across agents, APIs, gateways, MCP servers, and LLMs.
16+
17+
. *Signing in*
18+
+
19+
Sign in to Omni with your credentials. You land on *Home*.
20+
. *Opening catalogs*
21+
+
22+
Under *Portfolio* in the main navigation, open the catalog you need: *Agents*, *MCP Servers*, *LLMs*, *APIs*, or *Gateways*.
23+
. *Opening an asset and using Overview*
24+
+
25+
The catalog lists assets in a clear layout. Select one to open its detail page. Start on *Overview* for a summary and portfolio context. Graphs and fields differ by asset type.
26+
. *Reviewing instances and deployments*
27+
+
28+
On *Agents*, *MCP Servers*, *LLMs*, and *APIs*, open the *Instances* tab to review deployments, environment, version, status, gateway protection, and configuration or endpoint detail for that type. Gateways don't include an *Instances* tab.
29+
. *Checking performance*
30+
+
31+
On *Monitoring*, review live metrics such as latency, invocation counts, and error rates when Omni shows runtime data. What you see depends on how gateways expose the asset.
32+
. *Managing policies and governance*
33+
+
34+
On the *Policies* tab, review which governance policies apply and adjust runtime policy where Omni lets you. For gateways, use *Governance* instead.
35+
. *Reading conformance*
36+
+
37+
On *Agents*, *APIs*, and *MCP Servers*, open *Conformance Report* for rule-level compliance, violations, warnings, and conformance status. For gateways, use *Governance*.
38+
. *Reviewing versions*
39+
+
40+
Open *Versions* when you need change history for the asset.
41+
. *Getting help or sharing feedback*
42+
+
43+
Send feedback to the support team or open *Help & Support* for documentation and contact options.
44+
45+
== What You Can Do in Each Area
46+
47+
The left navigation groups work into *Portfolio*, *Governance*, *Observability*, and *Platform*.
48+
49+
[#portfolio#agents]
50+
=== Portfolio
51+
52+
image::reuse::lm_start.png[]
53+
54+
*Portfolio* lists your AI portfolio in five catalogs: *Agents*, *MCP Servers*, *LLMs*, *APIs*, and *Gateways*. Browse each list, compare performance and cost, inspect configuration, and trace how assets connect. In any catalog, select *Add* to register or connect another asset of that type. Omni guides you through the flow so the new entry appears with the rest of your portfolio and you can govern and observe it the same way.
55+
56+
Each catalog targets one asset type:
57+
58+
* *Agents*: task-focused runtimes. Inspect status, cost, latency, skills, and related detail.
59+
* *MCP Servers*: Model Context Protocol (MCP) endpoints that agents and tools call for context and capabilities.
60+
* *LLMs*: model connections your flows depend on.
61+
* *APIs*: APIs you integrate across agents and services.
62+
* *Gateways*: gateways that front traffic where Omni applies routing, policies, and focused monitoring.
7763

7864
[[governance]]
79-
== Governance
65+
=== Governance
8066

81-
Governance within the MuleSoft Omni platform ensures that all components operate within predefined compliance, security, and regulatory standards. In this section, you can:
67+
image::reuse::lm_explore_1.png[]
8268

83-
* *Enforce governance policies* -- Apply and manage policies across APIs, agents, and other entities so they meet security and compliance requirements and you protect data across the ecosystem.
84-
* *Monitor compliance* -- Track governance compliance through detailed reports and rule analysis, identify areas that need improvement, and review operational performance alongside compliance status.
85-
* *Automate policy management* -- Use automation features to streamline policy application and keep governance consistent across all instances.
69+
Use *Governance* for compliance, security, and spend discipline. Open *Cost Management* and *Governance Strategies* to steer budgets and policy posture. Apply and manage policies across APIs, agents, and related portfolio assets so you meet requirements and protect data. Track compliance with reports and rule analysis, close gaps, and stay audit-ready. Where Omni supports automation, use it to keep policy rollout consistent across instances.
8670

8771
[[observability]]
88-
== Observability
72+
=== Observability
8973

90-
The Observability section provides real-time insights into the performance and health of your integrated systems, including focused monitoring where it applies to select gateways. Key functionalities include:
74+
image::reuse::lm_analyze_1.png[]
9175

92-
* *Monitor system performance* -- Use dashboards for an overview of latency, request rates, error metrics, and throughput to keep systems performing well.
93-
* *Detect and resolve issues* -- Quickly identify and troubleshoot anomalies or performance degradation with comprehensive monitoring tools.
94-
* *Gain operational insights* -- Use detailed analytics to understand system behavior, support data-driven optimization decisions, and complement governance-focused reporting when you assess how services run in production.
76+
Use *Observability* for runtime health and day-to-day operations. Open *Dashboards*, *Reports*, and *Notifications* to watch latency, throughput, errors, and related signals, including gateway-focused views when Omni provides them. Investigate incidents, troubleshoot slowdowns, and compare what you see in operations with governance reporting as you assess production behavior.
9577

9678
[[platform]]
97-
== Platform
79+
=== Platform
80+
81+
image::reuse::lm_test_1.png[]
82+
83+
*Platform* includes environment-wide tools and settings, including *Providers*. Configure how Omni connects to external systems and supporting services for agents, APIs, MCP servers, and LLMs. Adjust options so Omni matches how your organization integrates and operates.
9884

99-
The Platform section encompasses the foundational tools and features that drive the MuleSoft Omni ecosystem. It offers:
85+
=== More help
10086

101-
* *Integrate with ease* -- Use robust platform tools to manage connections between agents, APIs, MCP servers, and LLMs.
102-
* *Explore platform capabilities* -- Access a wide range of functionalities that support efficient data integration and digital transformation.
103-
* *Configure and customize* -- Tailor platform settings to align with your organization's unique requirements for a flexible, adaptable ecosystem.
87+
image::reuse::lm_audience_end_1.png[]
10488

89+
Open *Help & Support* in Omni when you need documentation or want to contact support.

0 commit comments

Comments
 (0)