Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
255b4cd
W-21862451-omni-first-draft-dm
dmerlob Apr 7, 2026
22ee394
Update mulesoft-omni.adoc
dmerlob Apr 7, 2026
f330203
W-21984387-omni-draft-review
luanamulesoft Apr 10, 2026
31be355
Merge pull request #403 from mulesoft/W-21984387-omni-draft-review-LDS
dmerlob Apr 10, 2026
3b54f08
Omni docs: overview rename, comparison topic, nav updates
luanamulesoft Apr 14, 2026
f92abd5
review comparison
luanamulesoft Apr 14, 2026
d7ae81c
improve table
luanamulesoft Apr 14, 2026
1308792
improving table2
luanamulesoft Apr 14, 2026
dcaa80c
added get started
luanamulesoft Apr 15, 2026
43aba7a
format and tuning
luanamulesoft Apr 16, 2026
02e364a
more format
luanamulesoft Apr 16, 2026
c7cbe7b
W-22108619-editing overview page
dmerlob Apr 22, 2026
2a1b634
Merge pull request #404 from mulesoft/W-22031899-omni-luana-LDS
dmerlob Apr 22, 2026
bad5568
Update modules/ROOT/nav.adoc
dmerlob Apr 22, 2026
efdc36c
Update modules/ROOT/pages/omni-overview.adoc
dmerlob Apr 22, 2026
f599a70
Merge branch 'latest' into W-21862451-omni-first-draft-dm
dmerlob Apr 22, 2026
a72210c
Some rejiggering to match guidelines
hannanelson Apr 29, 2026
c895120
Update permissions table from not a PRD and apply permissions guideli…
hannanelson Apr 29, 2026
9ee247f
permissions sharing
hannanelson Apr 29, 2026
f1fdeb5
little fixes
hannanelson Apr 29, 2026
cc6f172
more little changes
hannanelson Apr 29, 2026
310aca7
remove hard coded link text
hannanelson Apr 29, 2026
2f4c50b
added Omni topics for Portfolio and Providers
JennyHajee Apr 30, 2026
24b47bc
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee Apr 30, 2026
2773a82
edits
JennyHajee Apr 30, 2026
74d6166
edits
JennyHajee Apr 30, 2026
e5c9abc
fixed heading level
JennyHajee Apr 30, 2026
31ed0db
edits to provide only high-level info with the actual steps
JennyHajee May 1, 2026
df24fa4
Fleshed out nav topics with placeholder topics
JennyHajee May 1, 2026
6f8a16b
edits to nav
JennyHajee May 1, 2026
53e2910
more edits to portfolio and provider topics
JennyHajee May 1, 2026
63815f9
edits
JennyHajee May 1, 2026
b7f9bca
edit
JennyHajee May 1, 2026
9849a97
Omni->enhanced MuleSoft experience
hannanelson May 1, 2026
0f20de1
Nav and populating filenames
hannanelson May 1, 2026
af1d9fc
added creating mcp topic
JennyHajee May 1, 2026
fa5ad14
little fixes
hannanelson May 1, 2026
6556eaa
added creating mcp server topic and added to nav
JennyHajee May 1, 2026
9abeb24
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee May 1, 2026
9764600
create mcp server edit
JennyHajee May 1, 2026
7eba734
edits to add scanners to providers
JennyHajee May 1, 2026
f8fb870
improved create mcp short description
JennyHajee May 1, 2026
906beb4
added see also links for create mcp
JennyHajee May 1, 2026
2c0cd12
added Add Semantic Services topic
JennyHajee May 1, 2026
5465785
added add semantic services to nav - added it after Create MCP Server…
JennyHajee May 1, 2026
189f94b
added how to access semanitic services under LLM proxies
JennyHajee May 1, 2026
40a2d4c
edits extra space
JennyHajee May 1, 2026
52ec087
Superagent with Claude suggestions
hannanelson May 1, 2026
40d0888
edits
JennyHajee May 1, 2026
7330197
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee May 1, 2026
b85f0ac
edits
JennyHajee May 3, 2026
c6bb6dc
added links for register and transcode sections
JennyHajee May 3, 2026
98a60a0
added links to Monitor, Secure, and transcode on learning map
JennyHajee May 3, 2026
5983885
added governance strategies to Secure on Learning map
JennyHajee May 3, 2026
adb4678
added links to Learn about on learning map
JennyHajee May 3, 2026
e93b95c
edits
JennyHajee May 3, 2026
0928ed2
add marketplace gateway discovery to Add Services to your portfolio
JennyHajee May 3, 2026
2592682
fixed link in learning map
JennyHajee May 3, 2026
f881afa
edits
JennyHajee May 3, 2026
661ffcb
W-22341778-omni-apim-fa
failup May 4, 2026
77e44d6
Merge pull request #412 from mulesoft/W-22341778-omni-apim-fa
failup May 4, 2026
8a60538
Update omni-create-manage-apis.adoc
failup May 4, 2026
c06063c
edit
JennyHajee May 4, 2026
73bb7ef
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee May 4, 2026
4cdcadd
deleted omni-add-gateway.adoc
JennyHajee May 4, 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
Binary file added modules/ROOT/images/omni-pillars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
.xref:index.adoc[Anypoint Platform]
* xref:index.adoc[Documentation]
* xref:learning-map-omni.adoc[Enhanced MuleSoft Experience]
** xref:omni-overview.adoc[Overview]
*** xref:omni-compare.adoc[Enhanced Experience and Anypoint Platform Comparison]
** xref:omni-start-home.adoc[]
** xref:omni-view-portfolio-overview.adoc[]
** xref:omni-add-services-to-portfolio.adoc[]
*** xref:omni-connect-providers-to-add-services.adoc[]
*** xref:omni-register-services-manually.adoc[]
*** xref:omni-create-mcp-server.adoc[]
*** xref:omni-add-semantic-services.adoc[]
*** xref:omni-view-service-details.adoc[]
** xref:omni-add-scanners-from-providers.adoc[]
*** xref:omni-manage-scanners.adoc[]
** xref:omni-add-instances.adoc[]
** xref:omni-create-governance-strategies.adoc[]
** xref:omni-view-token-usage-response-performance.adoc[]
** xref:omni-monitor-your-services.adoc[]
** xref:omni-view-detailed-metrics-for-services.adoc[]
** xref:omni-configure-notifications-for-alerts.adoc[]
** xref:omni-access-experience-from-slack.adoc[]
** xref:omni-connect-experience-to-claude-desktop.adoc[]
* xref:learning-map-mulesoft-ai.adoc[]
* xref:learning-map-agent-fabric.adoc[Agent Fabric]
** xref:agent-fabric-release-notes.adoc[]
Expand Down
82 changes: 82 additions & 0 deletions modules/ROOT/pages/learning-map-omni.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
= Enhanced MuleSoft Experience
:page-article-style: learning-map

The enhanced MuleSoft experience helps you manage, optimize, and govern a multi-agent ecosystem from one place. Work with agents, APIs, MCP servers, LLMs, and gateways as a single portfolio. View asset relationships, apply governance and cost discipline, and act on observability signals instead of working in separate silos. The experience pairs this portfolio view with an in-product assistant to connect integrations, tune configurations, and get answers in context.

* Register agents, MCP servers, and LLM proxies from any provider or registry.
* Monitor latency, cost, invocations, and failures in real time.
* Secure instances with compatible policies across your entire registry.
* Transcode existing REST APIs into MCP servers instantly.

image::omni-pillars.png[]

The end-to-end journey for the experience consists of these tasks, each with links to relevant content to assist you in completing them.

[.lm-table, cols="1a,1a,1a", grid="none"]
|===
| image::lm_start.png[]
[.lm-bold]##Learn About Enhanced MuleSoft Experience##

The experience helps you manage, optimize, and govern a multi-agent ecosystem from one place.

//- ToDo [Video]
//- ToDo [Trailhead]
- xref:omni-overview.adoc[]
- xref:omni-compare.adoc[]
- xref:omni-start-home.adoc[]
- xref:omni-access-experience-from-slack.adoc[]
- xref:omni-connect-experience-to-claude-desktop.adoc[]


| image::lm_explore_1.png[]
[.lm-bold]##Register##

Register agents, APIs, and MCP servers from any provider or registry, and add LLM proxies and gateways.

- xref:omni-add-services-to-portfolio.adoc[]
- xref:omni-connect-providers-to-add-services.adoc[]
- xref:omni-register-services-manually.adoc[]
- xref:omni-create-mcp-server.adoc[]
- xref:omni-add-semantic-services.adoc[]
- xref:omni-view-service-details.adoc[]
- xref:omni-add-scanners-from-providers.adoc[]



| image::lm_build_1.png[]
[.lm-bold]##Monitor##

Monitor latency, cost, invocations, and failures in real time.

- xref:omni-monitor-your-services.adoc[]
- xref:omni-view-token-usage-response-performance.adoc[]
- xref:omni-view-detailed-metrics-for-services.adoc[]
- xref:omni-configure-notifications-for-alerts.adoc[]

|===

[.lm-table, cols="1a,1a", width="66%", grid="none"]
|===
| image::lm_build_1.png[]
[.lm-bold]##Secure##

Secure instances with compatible policies across your entire registry.

- xref:omni-add-instances.adoc[]
- xref:omni-create-governance-strategies.adoc[]

| image::lm_analyze_1.png[]
[.lm-bold]##Transcode##

Transcode existing REST APIs into MCP servers instantly.

- xref:omni-create-mcp-server.adoc[]


|===


== See Also

* xref:omni-start-home.adoc[]
* xref:omni-compare.adoc[]
24 changes: 24 additions & 0 deletions modules/ROOT/pages/omni-access-experience-from-slack.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
= Access the Enhanced Experience from Slack

When your administrator installs and configures the Slack integration, you can receive notifications, run shortcuts, and open deep links that land in the enhanced MuleSoft experience with your existing identity. Slack becomes a companion surface for alerts and collaboration while *Portfolio* and *Governance* remain the source of truth for configuration.

Available commands, message templates, and workspaces depend entirely on how your organization wired the Slack app. Internal runbooks should list the slash commands or shortcuts approved for your workspace.

== Sign In and Open the Experience

. Open Slack in the workspace your company uses for MuleSoft or platform notifications.
. Use the app your administrator added (the display name is set during installation).
. Follow a notification action, a pinned link, or a slash command your internal documentation describes to authenticate and open the enhanced experience in the browser or embedded client your organization chose.

If authentication fails, confirm you are in the correct Slack workspace and that your Anypoint user is linked according to your IT team's instructions.

== Common Tasks from Slack

* **Respond to alerts** — Open a thread from an alert message and follow the link into the service or dashboard referenced in the payload.
* **Share context** — Post links back into Slack after you verify state in *Portfolio* so incident channels stay aligned with what you saw in the product.

== See Also

* xref:omni-start-home.adoc[]
* xref:omni-overview.adoc[]
* xref:omni-connect-experience-to-claude-desktop.adoc[]
31 changes: 31 additions & 0 deletions modules/ROOT/pages/omni-add-instances.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
= Creating and Managing Instances

Instances represent how a service runs in a specific environment—for example production or sandbox—and how traffic reaches it through gateways or runtimes your organization manages. Creating the right instance type helps you balance governance, monitoring, and operational overhead.

Managed paths through MuleSoft Flex Gateway typically expose richer policy and monitoring integration when your tenant supports them. Unmanaged or external paths remain valid when that matches your operating model. *Gateways* in *Portfolio* do not use an *Instances* tab the way APIs and agents do; use gateway-specific flows your UI exposes.

== Open the Instances Experience

. In *Portfolio*, open the catalog for the service (*APIs*, *Agents*, *MCP Servers*, or *LLM Proxies*).
. Open the service to reach its detail page.
. Select the *Instances* tab.
. Use the add or edit controls your organization enabled to create a new instance or change an existing one.

Field names, required metadata, and gateway choices depend on service type and what your administrator configured.

== After You Create or Change an Instance

* Apply or verify policies on the service or instance so access and traffic rules match your governance goals. Use the *Policies* tab described in xref:omni-view-service-details.adoc[].
* Review xref:omni-monitor-your-services.adoc[monitoring] on the service or instance when metrics are available for the path you selected.
* Coordinate with platform owners if DNS, certificates, or upstream routing must change outside the product.

== Permissions (high level)

Creating instances uses Anypoint Platform permissions such as *API Creator* for API-related flows. Viewing or editing instance configuration requires the matching view or edit permissions for API configuration. Your internal access guide lists the exact roles your organization mapped.

== See Also

* xref:omni-overview.adoc[]
* xref:omni-view-service-details.adoc[]
* xref:omni-add-services-to-portfolio.adoc[]
* xref:omni-monitor-your-services.adoc[]
37 changes: 37 additions & 0 deletions modules/ROOT/pages/omni-add-scanners-from-providers.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
= Add Scanners from Providers

Add scanners from providers to enable automated discovery for your organization. A scanner is the configured link between the system and a supported cloud provider so discovery jobs can find services (such as APIs, agents, and MCP servers) and register them in the right *Portfolio* catalogs. Adding a scanner is how you turn on—or extend—that automated discovery for your organization.

For how provider connection and catalogs fit together, see xref:omni-connect-providers-to-add-services.adoc[] and xref:omni-add-services-to-portfolio.adoc[].

== Why Add Provider Scanners

* **Keep catalogs current** — New and changed services in the provider surface in the system without someone re-entering each registration by hand.
* **Centralize visibility** — Discovered services land in *Portfolio* where teams can govern, monitor, and deploy from one place.
* **Stay aligned with the provider** — Scheduled or on-demand scans pick up releases and configuration drift according to the options your administrator allows.

== Where You Open the Scanner Flow
The system exposes the same underlying connect-and-configure wizard from more than one place; the label depends on context:

* *Home* — Start from the general *Add Services* area and choose the path that connects a provider and defines a scanner (*Connect to Provider*).
* *Providers* — Use the area dedicated to provider and scanner management when your navigation includes it; you add or refine scanners alongside other provider work.
* *Portfolio* — Open the catalog that matches the service type you care about (*Agents*, *APIs*, *MCP Servers*, and others your tenant supports). Use that catalog’s add control—the label usually reflects the type (for example *Add API*)—then choose provider connection when you intend to discover into that catalog.

Exact strings can vary by release; follow the UI your organization ships.

== What You Are Configuring

Regardless of entry point, adding a scanner is about establishing trust and scope: which provider platform to reach, how the system authenticates, how you validate connectivity, and how the scanner is named and scheduled (or otherwise triggered) so discovery runs on a basis your team expects. Saving the configuration activates the scanner for the catalogs and entitlements your administrator enabled.

== After the Scanner Runs

When the scanner is active, discovery results are applied according to its settings and your organization’s rules. You review outcomes on the *Providers* page and on scanner detail pages, and you manage discovered services from the relevant *Portfolio* catalogs.

For ongoing operations (pause, edit, or delete), see xref:omni-manage-scanners.adoc[].

== See Also

* xref:omni-connect-providers-to-add-services.adoc[]
* xref:omni-manage-scanners.adoc[]
* xref:omni-add-services-to-portfolio.adoc[]
* xref:omni-view-service-details.adoc[]
35 changes: 35 additions & 0 deletions modules/ROOT/pages/omni-add-semantic-services.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
= Add Semantic Services

Add semantic services to improve how LLM-driven requests are interpreted and routed across your portfolio. Semantic services help teams apply context-aware behavior so requests are handled by the most relevant tools, services, or pathways your organization configured.

Use this capability when your workflows need more than static routing. With semantic context in place, the system can support better request matching, more consistent response behavior, and stronger control as usage grows across agents, APIs, MCP servers, and related integrations.

At a high level, adding semantic services means:

* Defining the semantic service your organization uses for contextual matching.
* Associating that semantic capability with the relevant Omni experience (for example LLM-related routing paths where supported).
* Operating the service as part of your broader governance and monitoring model so behavior remains reliable as traffic and use cases evolve.

== Create a Semantic Service
In the navigation, under *Portfolio*, expand *LLM Proxies*, and select *Semantic Services*.

Create a semantic service by selecting the scale model that matches your traffic profile and operational needs.

* *Basic scale* — Best for smaller topic sets (up to 6 topics and 10 utterances per topic). Uses managed internal LLM proxy configuration.
* *Advanced scale* — Best for larger utterance sets per topic. Uses external semantic infrastructure, including an embedding API connection and a vector database connection.

At a high level, semantic service setup defines the embedding connection used for contextual matching:

* *Embedding service provider*
* *Service label*
* *Endpoint URL*
* *Model*
* *Authentication key*

Choose *Basic scale* for faster managed setup. Choose *Advanced scale* when you need greater scale and external infrastructure control.

== See Also

* xref:omni-add-services-to-portfolio.adoc[]
* xref:omni-view-service-details.adoc[]
* xref:omni-monitor-your-services.adoc[]
58 changes: 58 additions & 0 deletions modules/ROOT/pages/omni-add-services-to-portfolio.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
= Add Services to Your Portfolio

Add services to your portfolio to manage lifecycle and policy for that integration. Your *Portfolio* is organized into catalogs—*Agents*, *APIs*, *MCP Servers*, *LLM Proxies*, and *Gateways*. Each catalog holds the services (or gateway entries) your organization registered or imported so you can govern, monitor, and deploy them from one place.

This topic summarizes how APIs, agents, MCP servers, and LLM proxies get into those catalogs. For step-by-step procedures, use the topics linked in the sections.

== Two Ways to Add Services

[cols="1,2",options="header"]
|===
|Approach |What Happens

|xref:omni-connect-providers-to-add-services.adoc[]
|You add a provider scanner from *Home* or from a catalog in *Portfolio*. Scans discover services on supported cloud platforms and register them in the matching catalog.

|xref:omni-register-services-manually.adoc[]
|You start an *Add …* workflow from *Home* or from the catalog for that service type. You supply metadata, specifications, endpoints, or cards to register the service without a provider scanner.
|===

Gateways follow the same entry points; gateway-specific behavior is covered in the same linked topics where it applies.

== Where You Start the Workflow

* *Home* — Use *Add Services* to open provider connection or manual registration, then pick the service type.
* *Portfolio* — Open the *Agents*, *APIs*, *MCP Servers*, or *LLM Proxies* catalog. Use the add control for that type (labels such as *Add API* or *Add Agent*), then choose *Connect to Provider* or *Register Manually*.

Labels can vary by catalog; match what you see in the UI.

== How Each Service Type is Added

*APIs*::
Register with an API specification and instance details, or connect an API provider so scans import APIs into the *APIs* catalog.

*Agents*::
Register by connecting to an A2A endpoint, uploading an agent card, or registering without a card—or connect an agent provider for discovery.

*MCP servers*::
Register with an MCP URL or a schema file, or connect an MCP server provider.

*LLM proxies*::
Register manually by configuring a gateway and routing strategy, or use provider flows your tenant exposes for LLM proxies.

*Gateways*::

For gateways, add a new gateway or add an existing gateway runtime using provider discovery to add them to the *Gateways* catalog.

Create a new gateway runtime by configuring a gateway and routing strategy. This flow establishes gateway identity, connection context, and metadata so teams can govern and monitor gateway traffic in the system.

Browse the marketplace catalog of pre-configured gateway options to import them into the *Gateways* catalog.

For more information about registering any of these types, see xref:omni-register-services-manually.adoc[] and xref:omni-connect-providers-to-add-services.adoc[].

== See Also

* xref:omni-connect-providers-to-add-services.adoc[]
* xref:omni-register-services-manually.adoc[]
* xref:omni-add-scanners-from-providers.adoc[]
* xref:omni-view-service-details.adoc[]
Loading