-
Notifications
You must be signed in to change notification settings - Fork 57
W-21862451: omni first draft dm #402
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dmerlob
wants to merge
65
commits into
latest
Choose a base branch
from
W-21862451-omni-first-draft-dm
base: latest
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
65 commits
Select commit
Hold shift + click to select a range
255b4cd
W-21862451-omni-first-draft-dm
dmerlob 22ee394
Update mulesoft-omni.adoc
dmerlob f330203
W-21984387-omni-draft-review
luanamulesoft 31be355
Merge pull request #403 from mulesoft/W-21984387-omni-draft-review-LDS
dmerlob 3b54f08
Omni docs: overview rename, comparison topic, nav updates
luanamulesoft f92abd5
review comparison
luanamulesoft d7ae81c
improve table
luanamulesoft 1308792
improving table2
luanamulesoft dcaa80c
added get started
luanamulesoft 43aba7a
format and tuning
luanamulesoft 02e364a
more format
luanamulesoft c7cbe7b
W-22108619-editing overview page
dmerlob 2a1b634
Merge pull request #404 from mulesoft/W-22031899-omni-luana-LDS
dmerlob bad5568
Update modules/ROOT/nav.adoc
dmerlob efdc36c
Update modules/ROOT/pages/omni-overview.adoc
dmerlob f599a70
Merge branch 'latest' into W-21862451-omni-first-draft-dm
dmerlob a72210c
Some rejiggering to match guidelines
hannanelson c895120
Update permissions table from not a PRD and apply permissions guideli…
hannanelson 9ee247f
permissions sharing
hannanelson f1fdeb5
little fixes
hannanelson cc6f172
more little changes
hannanelson 310aca7
remove hard coded link text
hannanelson 2f4c50b
added Omni topics for Portfolio and Providers
JennyHajee 24b47bc
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee 2773a82
edits
JennyHajee 74d6166
edits
JennyHajee e5c9abc
fixed heading level
JennyHajee 31ed0db
edits to provide only high-level info with the actual steps
JennyHajee df24fa4
Fleshed out nav topics with placeholder topics
JennyHajee 6f8a16b
edits to nav
JennyHajee 53e2910
more edits to portfolio and provider topics
JennyHajee 63815f9
edits
JennyHajee b7f9bca
edit
JennyHajee 9849a97
Omni->enhanced MuleSoft experience
hannanelson 0f20de1
Nav and populating filenames
hannanelson af1d9fc
added creating mcp topic
JennyHajee fa5ad14
little fixes
hannanelson 6556eaa
added creating mcp server topic and added to nav
JennyHajee 9abeb24
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee 9764600
create mcp server edit
JennyHajee 7eba734
edits to add scanners to providers
JennyHajee f8fb870
improved create mcp short description
JennyHajee 906beb4
added see also links for create mcp
JennyHajee 2c0cd12
added Add Semantic Services topic
JennyHajee 5465785
added add semantic services to nav - added it after Create MCP Server…
JennyHajee 189f94b
added how to access semanitic services under LLM proxies
JennyHajee 40a2d4c
edits extra space
JennyHajee 52ec087
Superagent with Claude suggestions
hannanelson 40d0888
edits
JennyHajee 7330197
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee b85f0ac
edits
JennyHajee c6bb6dc
added links for register and transcode sections
JennyHajee 98a60a0
added links to Monitor, Secure, and transcode on learning map
JennyHajee 5983885
added governance strategies to Secure on Learning map
JennyHajee adb4678
added links to Learn about on learning map
JennyHajee e93b95c
edits
JennyHajee 0928ed2
add marketplace gateway discovery to Add Services to your portfolio
JennyHajee 2592682
fixed link in learning map
JennyHajee f881afa
edits
JennyHajee 661ffcb
W-22341778-omni-apim-fa
failup 77e44d6
Merge pull request #412 from mulesoft/W-22341778-omni-apim-fa
failup 8a60538
Update omni-create-manage-apis.adoc
failup c06063c
edit
JennyHajee 73bb7ef
Merge branch 'W-21862451-omni-first-draft-dm' of github.com:mulesoft/…
JennyHajee 4cdcadd
deleted omni-add-gateway.adoc
JennyHajee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| = Get Started with MuleSoft Omni | ||
| :page-aliases: | ||
| :page-article-style: learning-map | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| Omni brings together Agents, Governance, Observability, and Platform—four areas where you work with your portfolio. | ||
|
|
||
| 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. | ||
|
|
||
| == End-to-End Journey: Working in MuleSoft Omni | ||
|
|
||
| . *Signing in* -- You sign in to Omni with your credentials and arrive at the Home Dashboard. | ||
| . *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. | ||
| . *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. | ||
| . *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. | ||
| . *Managing policies* -- Under *Policies*, you see which governance policies apply so compliance and performance expectations stay clear. | ||
| . *Reviewing instances* -- Under *Instances*, you see where the agent is deployed, review configuration, and inspect behavior for each deployment. | ||
| . *Checking performance* -- Under *Monitoring*, you review live analytics such as latency, invocation counts, and error rates. | ||
| . *Reading governance reports* -- Under *Governance Report*, you review rule-level compliance, violations, and warnings across services. | ||
| . *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. | ||
|
|
||
| This walkthrough shows how to move through Omni in a straightforward way so you can manage and improve a multi-agent environment with confidence. | ||
|
|
||
| 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. | ||
|
|
||
| [.lm-table, cols="1a,1a,1a", grid="none"] | ||
| |=== | ||
| | image::reuse::lm_start.png[] | ||
| [.lm-bold]##Agents## | ||
|
|
||
| - Discover and manage agents and see how they connect to APIs, gateways, MCP servers, and LLMs | ||
| - Review performance and cost, and tune how agents run | ||
|
|
||
| | image::reuse::lm_explore_1.png[] | ||
| [.lm-bold]##Governance## | ||
|
|
||
| - Apply and track policies across APIs, agents, and related assets | ||
| - Automate policy rollout and stay audit-ready with reports and rule analysis | ||
|
|
||
| | image::reuse::lm_analyze_1.png[] | ||
| [.lm-bold]##Observability## | ||
|
|
||
| - Monitor latency, throughput, and errors with dashboards and analytics | ||
| - Investigate issues and align operational insight with governance reporting | ||
|
|
||
| | image::reuse::lm_test_1.png[] | ||
| [.lm-bold]##Platform## | ||
|
|
||
| - Manage connections and environment-wide settings for agents, APIs, and integrations | ||
| - Adapt Omni to how your organization works | ||
|
|
||
| | image::reuse::lm_build_1.png[] | ||
| [.lm-bold]##Areas in this topic## | ||
|
|
||
| - <<agents>> | ||
| - <<governance>> | ||
| - <<observability>> | ||
| - <<platform>> | ||
|
|
||
| | image::reuse::lm_audience_end_1.png[] | ||
| [.lm-bold]##More help## | ||
|
|
||
| - Use Help & Support in Omni when you need documentation or to contact support | ||
| |=== | ||
|
|
||
| [[agents]] | ||
| == Agents | ||
|
|
||
| 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: | ||
|
|
||
| * *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. | ||
| * *Optimize agent operations* -- Access performance metrics and cost details for each agent to optimize their operations and ensure efficient resource usage. | ||
| * *Enable seamless interactions* -- Connect agents with APIs, LLMs, and MCP servers to enhance capabilities and extend functionality across your digital ecosystem. | ||
|
|
||
| [[governance]] | ||
| == Governance | ||
|
|
||
| Governance within the MuleSoft Omni platform ensures that all components operate within predefined compliance, security, and regulatory standards. In this section, you can: | ||
|
|
||
| * *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. | ||
| * *Monitor compliance* -- Track governance compliance through detailed reports and rule analysis, identify areas that need improvement, and review operational performance alongside compliance status. | ||
| * *Automate policy management* -- Use automation features to streamline policy application and keep governance consistent across all instances. | ||
|
|
||
| [[observability]] | ||
| == Observability | ||
|
|
||
| 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: | ||
|
|
||
| * *Monitor system performance* -- Use dashboards for an overview of latency, request rates, error metrics, and throughput to keep systems performing well. | ||
| * *Detect and resolve issues* -- Quickly identify and troubleshoot anomalies or performance degradation with comprehensive monitoring tools. | ||
| * *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. | ||
|
|
||
| [[platform]] | ||
| == Platform | ||
|
|
||
| The Platform section encompasses the foundational tools and features that drive the MuleSoft Omni ecosystem. It offers: | ||
|
|
||
| * *Integrate with ease* -- Use robust platform tools to manage connections between agents, APIs, MCP servers, and LLMs. | ||
| * *Explore platform capabilities* -- Access a wide range of functionalities that support efficient data integration and digital transformation. | ||
| * *Configure and customize* -- Tailor platform settings to align with your organization's unique requirements for a flexible, adaptable ecosystem. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.