diff --git a/modules/ROOT/assets/images/api-tutorial-debug-panel-variables-acb.graffle b/modules/ROOT/assets/image-source-files/api-tutorial-debug-panel-variables-acb.graffle similarity index 100% rename from modules/ROOT/assets/images/api-tutorial-debug-panel-variables-acb.graffle rename to modules/ROOT/assets/image-source-files/api-tutorial-debug-panel-variables-acb.graffle diff --git a/modules/ROOT/assets/image-source-files/model-proxy.graffle b/modules/ROOT/assets/image-source-files/model-proxy.graffle deleted file mode 100644 index b0d766894..000000000 Binary files a/modules/ROOT/assets/image-source-files/model-proxy.graffle and /dev/null differ diff --git a/modules/ROOT/assets/images/lm_audience_1.png b/modules/ROOT/assets/images/lm_audience_1.png new file mode 100644 index 000000000..4b8df9d76 Binary files /dev/null and b/modules/ROOT/assets/images/lm_audience_1.png differ diff --git a/modules/ROOT/assets/images/lm_develop_end_1.png b/modules/ROOT/assets/images/lm_develop_end_1.png new file mode 100644 index 000000000..0fc54f0f9 Binary files /dev/null and b/modules/ROOT/assets/images/lm_develop_end_1.png differ diff --git a/modules/ROOT/assets/images/lm_optimize_1.png b/modules/ROOT/assets/images/lm_optimize_1.png new file mode 100644 index 000000000..e733266b5 Binary files /dev/null and b/modules/ROOT/assets/images/lm_optimize_1.png differ diff --git a/modules/ROOT/assets/images/model-proxy.png b/modules/ROOT/assets/images/model-proxy.png deleted file mode 100644 index 09df0320b..000000000 Binary files a/modules/ROOT/assets/images/model-proxy.png and /dev/null differ diff --git a/modules/ROOT/images/enhanced-experience-pillars.png b/modules/ROOT/images/enhanced-experience-pillars.png deleted file mode 100644 index 0e934f12b..000000000 Binary files a/modules/ROOT/images/enhanced-experience-pillars.png and /dev/null differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 39ec1cab6..e73d0b0e6 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,51 +1,5 @@ .xref:index.adoc[Anypoint Platform] * xref:index.adoc[Documentation] -* xref:learning-map-exp.adoc[] - ** xref:exp-overview.adoc[Overview] - *** xref:exp-compare.adoc[Comparison: Enhanced Experience and Anypoint Platform] - *** xref:exp-glossary.adoc[Glossary] - ** xref:exp-release-notes.adoc[Release Notes] - ** xref:exp-home-start.adoc[] - *** xref:exp-portfolio-overview.adoc[] - *** xref:exp-ai-assistant-use.adoc[] - ** xref:exp-services-add-to-portfolio.adoc[] - *** xref:exp-services-connect-providers-to-add.adoc[] - *** xref:exp-services-register-manually.adoc[] - *** xref:exp-services-create-mcp-server.adoc[] - *** xref:exp-instances-add.adoc[] - *** xref:exp-services-view-details.adoc[] - ** xref:exp-playground-overview.adoc[] - *** xref:exp-playground-api.adoc[] - *** xref:exp-playground-mcp.adoc[] - ** xref:model-proxy.adoc[] - *** xref:model-proxy-create-model-proxy.adoc[] - *** xref:model-proxy-policies.adoc[] - *** xref:model-proxy-request.adoc[] - *** xref:model-proxy-semantic-service.adoc[] - *** xref:model-proxy-try-out.adoc[] - ** xref:exp-scanners-add-from-providers.adoc[] - *** xref:exp-scanners-prerequisites-reference.adoc[] - *** xref:exp-scanners-view-details.adoc[] - *** xref:exp-scanners-manage.adoc[] - *** xref:exp-providers-manage.adoc[] - ** xref:exp-governance-view-cost-and-token-usage.adoc[] - *** xref:model-proxy-token-reports.adoc[] - ** xref:exp-akamai-risk-correlation.adoc[] - ** xref:exp-governance-work-with-strategies.adoc[] - *** xref:exp-governance-create-strategy.adoc[] - *** xref:exp-governance-manage-strategies.adoc[] - *** xref:exp-governance-govern-third-party-apis.adoc[] - *** xref:exp-governance-monitor-cross-gateway-conformance.adoc[] - ** xref:exp-services-monitoring.adoc[] - *** xref:exp-services-view-detailed-metrics.adoc[] - *** xref:exp-alerts-configure-notifications.adoc[] - ** xref:exp-connect-with-external-systems.adoc[] - *** xref:exp-slack-integrate.adoc[] - *** xref:exp-claude-desktop-connect.adoc[] - ** xref:exp-troubleshoot.adoc[] - *** xref:exp-ai-assistant-troubleshoot.adoc[] - -* xref:learning-map-mulesoft-ai.adoc[] * xref:agent-fabric-overview.adoc[Agent Fabric] ** xref:learning-map-agent-fabric.adoc[Get Started with Agent Fabric] ** xref:agent-fabric-release-notes.adoc[] diff --git a/modules/ROOT/pages/_partials/exp-navigation-labels.adoc b/modules/ROOT/pages/_partials/exp-navigation-labels.adoc deleted file mode 100644 index 4d52825d9..000000000 --- a/modules/ROOT/pages/_partials/exp-navigation-labels.adoc +++ /dev/null @@ -1,4 +0,0 @@ -// Partial reused across all pages in the Enhanced Experience were needed. -// tag::ExpNavigationLabels[] -Navigation labels can vary by catalog, enabled features, and release. -// end::ExpNavigationLabels[] diff --git a/modules/ROOT/pages/exp-ai-assistant-troubleshoot.adoc b/modules/ROOT/pages/exp-ai-assistant-troubleshoot.adoc deleted file mode 100644 index b80649188..000000000 --- a/modules/ROOT/pages/exp-ai-assistant-troubleshoot.adoc +++ /dev/null @@ -1,225 +0,0 @@ -= Troubleshoot the AI Assistant -:keywords: ai assistant troubleshooting, ai assistant errors, incorrect answers, search results, mulesoft ai assistant, anypoint platform - -If you experience issues using the MuleSoft Agent AI assistant, use this guide to identify and resolve common problems. - -== AI Assistant Doesn't Respond - -If the AI assistant doesn't respond to your messages: - -Check your connection: - -. Verify that you have an active internet connection. -. Refresh the browser page. -. Try sending a simple message like "Hello" to test if the assistant responds. - -Check session status: - -. Verify that you're still signed in to the enhanced experience. -. If your session expired, sign in again. -. Check for any error messages in the browser console (if you have developer tools access). - -Try a different browser or clear cache: - -. Clear your browser cache and cookies. -. Try using a different browser or incognito/private mode. -. Disable browser extensions that might interfere with the assistant. - -If the problem persists, contact your administrator or support team. - -== AI Assistant Gives Incorrect or Incomplete Answers - -If the assistant provides answers that don't match your expectations: - -Provide more context: - -. Include specific names, IDs, or identifiers in your questions. -. Mention the environment, business group, or scope if relevant. -. Add details about what you're trying to accomplish. - -Example: -[%header,cols="1,1"] -|=== -|Instead of |Try - -|"Show me APIs" -|"Show me production APIs in the Customer Services business group" - -|"Why isn't this working?" -|"Why is the rate limit policy on my Payment API instance not being enforced?" - -|"Check errors" -|"Show me error details for the User Authentication Agent over the last 24 hours" -|=== - -Rephrase your question: - -. Try asking the same question using different words. -. Break complex questions into smaller, focused questions. -. Use follow-up questions to narrow down the information you need. - -Verify the assistant has access to the data: - -. Check that the service is registered in your portfolio. -. Verify that monitoring or governance data has been collected for the service. -. Confirm that you have permissions to view the data you're asking about. - -== AI Assistant Suggests Actions I Can't Perform - -If the assistant suggests actions but you can't perform them: - -Check your permissions: - -. Verify your Access Management permissions in xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. -. Ask your administrator to review your role assignments. -. The assistant may suggest actions available in the product, but your specific permissions determine what you can do. - -Check your subscription tier: - -. Verify whether you have API Portfolio Access or Agent + API Portfolio Access. -. Some features (like agents, MCP servers, Model proxies) require Agent + API Portfolio Access. -. Contact your administrator or account team about upgrading your subscription if needed. - -Check service state: - -. The service may need to be in a specific state (active, registered, etc.) before certain actions are available. -. Verify that required prerequisites are met (for example, a gateway must be configured before creating instances). - -== Search Results Aren't Relevant - -If search results don't match what you're looking for: - -Use more specific terms: - -. Include the service type: "Find agents that handle payments" instead of "Find payment services." -. Specify attributes: "Show me REST APIs with OAuth policies" instead of "Show me APIs." - -Check the scope: - -. Verify you're searching in the right business group or environment. -. Ask the assistant to filter: "Show me only production services." - -Verify service metadata: - -. Search results depend on how services are described in their metadata. -. If a service doesn't appear, check whether its description includes the terms you're searching for. -. Update service descriptions to improve future search results. - -== AI Assistant Is Slow to Respond - -If the assistant takes a long time to respond: - -Check current load: - -. During peak usage times, responses may be slower. -. If using monitoring or cost queries, large datasets may take longer to process. - -Simplify your question: - -. Break complex questions into smaller parts. -. Ask for summaries first, then drill into details. - -Check your connection: - -. Slow network connections can delay streaming responses. -. Try refreshing the page or reconnecting to your network. - -== AI Assistant Conversation History Is Lost - -If your conversation history disappears: - -Session expiration: - -. Conversation history is tied to your session. If your session expires, history may be cleared. -. Sign in again and start a new conversation. - -Browser storage: - -. Clearing browser cache or cookies may remove conversation history. -. Conversation history is stored locally in your browser for the current session. - -Intentional behavior: - -. For privacy and security, conversation history may not persist across sessions. -. Sensitive information isn't stored long-term. - -== Actions Performed by AI Assistant Fail - -If the assistant confirms an action but the action fails: - -Review error messages: - -. The assistant should display any error messages from the system. -. Look for specific error details (validation errors, permission issues, etc.). - -Check prerequisites: - -. Verify that all required fields and configurations are complete. -. For instance creation, ensure the target gateway is available. -. For policy application, ensure the service instance is active. - -Verify data: - -. Double-check that URLs, names, and identifiers are correct. -. Ensure referenced services, gateways, or environments exist. - -Try manually: - -. Perform the action manually through the UI to see if the same error occurs. -. This helps determine whether the issue is with the AI assistant or the underlying system. - -== AI Assistant Can't Access Recent Changes - -If the assistant doesn't recognize recently registered services or configuration changes: - -Wait for indexing: - -. Newly registered services may take a few minutes to appear in search results. -. Refresh the page and try again after a few minutes. - -Verify registration completed: - -. Check that the service registration or configuration change was saved successfully. -. Look for confirmation messages or check the relevant catalog. - -Be specific: - -. Use exact service names or IDs rather than relying on search. -. For example: "Show me details for service ID 12345." - -== Get Additional Help - -If these troubleshooting steps don't resolve your issue: - -. Check with your administrator. -+ -Your administrator can verify your permissions, subscription tier, and feature availability. - -. Review documentation. -+ -See xref:exp-ai-assistant-use.adoc[] for complete AI assistant usage guidance. - -. Review system status. -+ -Ask your administrator to check whether there are any known issues or maintenance windows. - -. Collect diagnostic information. -+ -Before contacting support, collect: -* The exact question or request you sent to the assistant -* The assistant's response -* Any error messages displayed -* The page you were on when the issue occurred -* Your browser type and version - -. Contact support. -+ -Reach out to your internal IT support or MuleSoft support with the diagnostic information. - -== See Also - -* xref:exp-ai-assistant-use.adoc[] -* xref:exp-troubleshoot.adoc[] -* xref:exp-home-start.adoc[] -* xref:exp-overview.adoc[] -include::release-notes::partial$release-notes/rn-known-issues.adoc[tag=knownIssuesSeeAlsoLink] diff --git a/modules/ROOT/pages/exp-ai-assistant-use.adoc b/modules/ROOT/pages/exp-ai-assistant-use.adoc deleted file mode 100644 index b91b96faa..000000000 --- a/modules/ROOT/pages/exp-ai-assistant-use.adoc +++ /dev/null @@ -1,349 +0,0 @@ -= Using the MuleSoft Agent -:keywords: mulesoft agent, ai assistant, anypoint platform, integration automation, ask questions, ai-powered assistant - -The enhanced experience includes an AI assistant called MuleSoft Agent that helps you navigate, search, and manage your portfolio through natural language conversations. Access the assistant from any page to get guidance, perform tasks, and discover features without navigating through menus. - -[[before-you-begin]] -== Before You Begin - -[IMPORTANT] -==== -The MuleSoft Agent is available on request. To get access, contact your account executive or MuleSoft representative to request enablement. -==== - -Before getting started, make sure you have: - -* An Anypoint Platform account with access to the enhanced experience. -* Agentforce enabled in your Anypoint Platform and Salesforce organizations by your administrator. -* The *MuleSoft Omni Agent for Anypoint* permission assigned to each user who needs to send prompts to the agent. -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -To assign the *MuleSoft Omni Agent for Anypoint* permission across business groups: - -. Log in to Anypoint Platform and open *Access Management*. -. Select the business group where you want to assign the permission. -. Find the user and assign the *MuleSoft Omni Agent for Anypoint* permission. -. Repeat for each business group that requires access. - -== MuleSoft Agent Capabilities - -The AI assistant provides context-aware help based on where you are in the enhanced experience: - -Portfolio Management:: -+ -* Search for agents, APIs, MCP servers, Model proxies, and gateways. -* Get details about specific services. -* Find services by capability or description. -* Register new services with guided workflows. -* Create and manage instances. - -Governance:: -+ -* Create and manage governance strategies. -* Review conformance reports. -* Apply policies to services and instances. -* Check compliance status. -* Configure automated policies. - -Monitoring and Observability:: -+ -* Review performance metrics for services. -* Analyze error rates and latency trends. -* Check service health and availability. -* Set up alerts and notifications. -* View monitoring dashboards. - -Cost Management:: -+ -* Review token usage and spending. -* Identify cost optimization opportunities. -* Analyze usage patterns. -* Get recommendations for reducing costs. -* Apply cost control policies. - -Navigation and Discovery:: -+ -* Navigate to specific pages and catalogs. -* Find features and capabilities. -* Get step-by-step guidance for tasks. -* Learn about enhanced experience features. - -Platform Configuration:: -+ -* Connect and manage providers. -* Configure scanners for service discovery. -* Set up integrations (Slack, Claude Desktop). -* Manage business group settings. - -== Access the AI Assistant - -Once enabled as described in <>, open the assistant from the panel available on any page in the enhanced experience. - -The MuleSoft Agent uses your Access Management permissions and can only perform actions you're authorized to do. Tasks like creating governance strategies or managing services require specific permissions. For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Ask Questions - -Ask the AI assistant questions in natural language. The assistant understands context from the page you're on and provides relevant answers. - -=== Example Portfolio Questions - -[source,text] ----- -Show me all agents in production ----- - -[source,text] ----- -Which APIs have governance violations? ----- - -[source,text] ----- -Find MCP servers that expose payment tools ----- - -[source,text] ----- -What instances are deployed to the staging gateway? ----- - -=== Example Governance Questions - -[source,text] ----- -What governance strategies are active? ----- - -[source,text] ----- -How do I create a new governance strategy? ----- - -[source,text] ----- -Show me all services with security violations ----- - -[source,text] ----- -Which policies are applied to my API instance? ----- - -=== Example Monitoring Questions - -[source,text] ----- -What's the error rate for my agent today? ----- - -[source,text] ----- -Show me latency trends for the last week ----- - -[source,text] ----- -Which services have the highest token usage? ----- - -[source,text] ----- -Are there any service health alerts? ----- - -=== Example Cost Questions - -[source,text] ----- -What's my total token spend this month? ----- - -[source,text] ----- -Which agents are using the most tokens? ----- - -[source,text] ----- -How can I reduce costs for my Model proxies? ----- - -[source,text] ----- -Show me cost trends over time ----- - -=== Example Navigation Questions - -[source,text] ----- -How do I register a new API? ----- - -[source,text] ----- -Show me the governance strategies page ----- - -[source,text] ----- -Take me to monitoring for my agent ----- - -[source,text] ----- -Where do I configure scanners? ----- - -== Use Suggestions - -After the AI assistant responds, it might show suggestion chips with related follow-up actions you can take. If you don't see any suggestions, ask the assistant to suggest actions. - -. Review the suggestion chips below the assistant's response. -. Select a chip to ask that follow-up question or perform that action. -. The assistant executes the suggestion and shows the results. - -Suggestions are context-aware and change based on: - -* The page you're currently viewing -* The question you just asked -* The services and features available to you -* Common next steps for your current task - -[TIP] -Suggestions help you discover related capabilities and complete multistep workflows more efficiently. - -== Perform Actions with Confirmation - -The AI assistant can perform actions on your behalf with your confirmation. When the assistant proposes an action that modifies data or navigates to a new page, it shows a confirmation prompt. - -=== Navigation Actions - -When the assistant wants to navigate you to a different page: - -. The assistant shows a confirmation banner with the navigation target. -. Review where the assistant wants to take you. -. Confirm to proceed. - -=== Data Modification Actions - -When the assistant wants to create, update, or delete services or configurations: - -. The assistant shows a confirmation banner with details of the proposed action. -. Review what the assistant will do. -. Select *Confirm* to execute the action, or *Cancel* to reject it. -+ -If you confirm, the assistant performs the action and shows the results. - -Examples of actions that require confirmation: - -* Creating new services (agents, APIs, MCP servers) -* Applying or removing policies -* Creating or modifying governance strategies -* Running or deleting scanners -* Creating or deleting alerts -* Updating service configurations - -[IMPORTANT] -Always review confirmation prompts carefully before approving actions. This tool uses generative AI, which can produce inaccurate or harmful responses and actions. - -=== Form Assistance - -When you have a form open (such as creating an instance or configuring a policy), the assistant can help fill in fields: - -. Ask the assistant for help with the form (for example, "Fill in the instance details for my production API"). -. The assistant proposes changes to specific form fields. -+ -A confirmation banner shows which fields will be updated and with what values. -. Review the proposed changes. -. Select *Confirm* to apply the changes to the form, or *Cancel* to reject them. -+ -If you confirm, the form fields update, but the form itself isn't submitted—you still need to review and submit the form manually. - -== Get Guided Workflows - -Ask the AI assistant to guide you through complex tasks: - -[source,text] ----- -How do I create a governance strategy for my APIs? ----- - -[source,text] ----- -Walk me through registering a new agent ----- - -[source,text] ----- -Help me set up monitoring for my MCP server ----- - -[source,text] ----- -Guide me through connecting a provider ----- - -The assistant provides step-by-step instructions and can perform actions at each step with your confirmation. - -== Best Practices - -Follow these practices for effective interactions with the AI assistant: - -Be Specific:: -+ -Instead of "Show me APIs," try "Show me production APIs with governance violations." - -Provide Context:: -+ -If asking about a specific service, mention its name: "What's the error rate for Payment Processing API?" - -Use Follow-Up Questions:: -+ -Build on previous responses with follow-up questions like "Show me more details" or "Apply a rate limit policy to that instance." - -Review Confirmations:: -+ -Always review confirmation prompts carefully before approving actions. - -Use Suggestions:: -+ -Explore the suggestion chips to discover related capabilities and next steps. - -Ask for Help:: -+ -If you're unsure how to do something, ask: "How do I..." or "Show me how to..." - -Correct Mistakes:: -+ -If the assistant misunderstands, clarify: "No, I meant the staging environment, not production." - -== Limitations - -Be aware of these limitations when using the AI assistant: - -* The assistant can't perform actions outside the enhanced experience or access external systems directly. -* Some actions require specific permissions. If you don't have permission, the assistant informs you but can't grant permissions. -* The assistant works with data available in the enhanced experience. For services not yet registered in your portfolio, the assistant has limited information. -* Complex multistep workflows may require you to confirm each step individually. -* The assistant can't modify Access Management permissions or subscription tiers. - -== Privacy and Security - -The AI assistant operates within your organization's security and privacy controls: - -* All interactions respect your Access Management permissions. -* The assistant only accesses data you have permission to view. -* Conversations are associated with your user session and aren't shared with other users. -* The assistant doesn't store sensitive data like API keys or credentials in conversation history. -* All actions performed by the assistant are logged and auditable. - -== See Also - -* xref:exp-ai-assistant-troubleshoot.adoc[] -* xref:exp-home-start.adoc[] -* xref:exp-overview.adoc[] -* xref:exp-portfolio-overview.adoc[] -* xref:exp-services-monitoring.adoc[] -* xref:exp-governance-work-with-strategies.adoc[] diff --git a/modules/ROOT/pages/exp-akamai-risk-correlation.adoc b/modules/ROOT/pages/exp-akamai-risk-correlation.adoc deleted file mode 100644 index 9e1ea0b05..000000000 --- a/modules/ROOT/pages/exp-akamai-risk-correlation.adoc +++ /dev/null @@ -1,142 +0,0 @@ -= Correlating Risk Using Akamai API Security -:keywords: akamai api security scanner, akamai integration, security risk, vulnerability findings, incident correlation, portfolio catalogs - -Use Akamai for risk correlation to map external security findings to the right services in *Portfolio*. Teams get one view to triage risk, track incidents, and remediate faster. To enable this correlation, configure an Akamai API Security scanner that connects your Akamai account, runs scheduled scans, and surfaces mapped findings on related services in *Portfolio*. The scanner doesn't import or register third-party services. It correlates risk scores, findings, and incidents for APIs and MCP services in one governance workflow. - -The integration relies on a bidirectional sync between your MuleSoft and Akamai API Security tenants. You connect the two tenants with credentials in each direction: Akamai reads your API assets and instances from MuleSoft so it can match its security observations to the correct APIs, and the scanner pulls the resulting findings and incidents back into *Portfolio*. - -== Akamai Scanner vs. Import Scanners - -Most provider scanners discover metadata in external platforms and import services into *Portfolio* catalogs. The Akamai API Security scanner works differently: instead of creating new services, it enriches existing ones with Akamai security data. - -== Before You Begin - -Before setting up the Akamai scanner, make sure you have: - -* Exchange Administrator permission in the target business group. -* Akamai Security base URL, client ID, and client secret. -* Access to apply Akamai correlation policy in the environments you want to scan. -* Existing APIs and MCP services in *Portfolio* catalogs for correlation targets. - -For credential and role details, see xref:exp-scanners-prerequisites-reference.adoc[]. - -== Set Up Tenant Connectivity - -The integration uses a bidirectional sync between your MuleSoft tenant and your Akamai API Security tenant. You provision and configure both tenants. Each MuleSoft customer tenant (root organization) connects to one Akamai API Security tenant (for example, `.nonamesec.com`). - -Setup involves credentials in both directions: - -* A service account in Akamai, which you configure on the MuleSoft side so the scanner can read findings and incidents from Akamai. -* A connected app in MuleSoft, which you configure on the Akamai side so Akamai can pull API asset and instance information from MuleSoft. - -Complete these steps as an organization administrator: - -. Create a service account in Akamai API Security. -+ -In your Akamai API Security tenant, create a service account and note its client ID and client secret. -. Configure the scanner in MuleSoft. -+ -Add an Akamai scanner and enter the Akamai service account credentials (client ID and client secret) and the Akamai base URL, along with a scan frequency. See <>. -. Create a connected app in MuleSoft. -+ -In Anypoint Platform, go to *Access Management* > *Connected Apps* and create an app that acts on its own behalf (client credentials). Add the *Exchange Viewer* or *Asset Viewer* scope so Akamai can read API instance and asset information, then save. Copy the client ID and client secret. -. Configure the sync on the Akamai side. -+ -In your Akamai API Security tenant, enter the MuleSoft connected app client ID and client secret so Akamai can pull API asset and instance information from MuleSoft. - -[[set-up-the-akamai-scanner]] -== Set Up the Akamai Scanner - -Before you set up the scanner, review the prerequisites for Akamai scanners in xref:exp-scanners-prerequisites-reference.adoc[]. - -. From *Platform* > *Providers*, select *Akamai*. -. Click *Add Scanner* and enter the connection values. -. Test the connection. -. Enter scanner metadata, such as scanner name, description, frequency, and time. -. Apply the Akamai correlation policy to selected environments. -. Save the scanner and run a discovery scan. - -== How the Sync Works - -After both tenants are connected, data flows in two directions: - -MuleSoft to Akamai:: -Akamai periodically pulls API instance and asset information from MuleSoft (typically every few hours) and adds it to its API security inventory. Akamai correlates these API instances with the north-south traffic it observes, so it can attach MuleSoft context — such as organization ID, environment ID, and API instance ID — to the endpoints it monitors. The pull runs at the root organization level. - -Akamai to MuleSoft:: -The scanner pulls security findings and incidents from Akamai on the schedule you set, then correlates and stores them so they appear on the related services in *Portfolio*. - -For Akamai to observe and correlate traffic, the Akamai correlation policy must be applied to your API instances. This out-of-the-box policy (for Flex Gateway and Mule gateways) stamps correlation headers on API responses so Akamai can match observed traffic to the correct MuleSoft API. Akamai observes north-south traffic only for domains you own and control. - -== Review Scanner Detail Tabs - -After you select a configured Akamai scanner from the provider list, use scanner detail tabs to monitor scanner status, related services, and configuration values. - -For common tab behavior across scanners, see xref:exp-scanners-view-details.adoc[]. -For Akamai scanners, the *Overview* tab highlights correlation policy status and shows whether existing services are being updated with Akamai risk, findings, and incident data. -The *Services* tab lists services associated with the scanner and shows which existing services are receiving correlated Akamai security data. -The *Settings* tab shows scanner configuration values, including schedule and provider connection values, and provides options to edit or delete the scanner. - -== Apply Missing Correlation Policies - -If some environments show that correlation policy isn't applied, you can apply missing policies from the scanner detail page: - -. Open *Platform* > *Providers* and select the configured Akamai scanner. -. In *Overview*, check the *Akamai Correlation Policy* status. -. If the status shows missing environments, click *Check again* to apply policy only to those environments. -. Wait for the status to change to *Applied* and confirm all target environments are covered. - -If policy application fails, verify your Admin API write permissions and environment access, then retry. - -== Reviewing Akamai Security Results in the Enhanced Experience - -After a successful run, Akamai results appear on existing services: - -* API list views show values in the *Security Risk* column. -* API detail pages show Akamai security data in *Conformance*. -* Security sections display violation totals, findings, incidents, and endpoint context. -* Finding detail views show fields such as status, type, endpoint path, and mapped frameworks. - -== Interpret Risk Status Levels - -The *Security Risk* column shows the risk level assigned to correlated Akamai findings: - -Low:: -Lower urgency risk. Review and remediate in your normal security lifecycle. - -Medium:: -Moderate risk. Prioritize remediation after high-risk issues. - -High:: -Elevated risk. Investigate and remediate first. - -Critical:: -Highest urgency risk. Remediate immediately. - -== Remediate Risks from the API Conformance Tab - -Use the API *Conformance* tab in *Portfolio* to triage and remediate Akamai findings: - -. Open the API from the *APIs* catalog in *Portfolio*. -. Select *Conformance* and review the *Akamai* section, including findings and incidents. -. Select a finding to open details, such as endpoint, severity, and mapped standards. -. Apply recommended remediation policies directly from the finding detail view when available. -. Re-run the scanner after remediation to confirm updated findings and risk levels. - -If no direct remediation policy is available for a finding, use the finding details to update the API configuration in your gateway or upstream system, then scan again to verify the result. - -== Troubleshoot Missing Akamai Findings - -If a scan completes but results don't appear: - -* Verify the correlation policy is applied in the same environment as the service instance. -* Confirm the target service already exists in *Portfolio* catalogs. -* Confirm scanner scope and business group match the service location. -* Re-run the scanner after connection or policy changes. - -== See Also - -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-providers-manage.adoc[] -* xref:exp-scanners-view-details.adoc[] -* xref:exp-scanners-manage.adoc[] diff --git a/modules/ROOT/pages/exp-alerts-configure-notifications.adoc b/modules/ROOT/pages/exp-alerts-configure-notifications.adoc deleted file mode 100644 index 8321ab598..000000000 --- a/modules/ROOT/pages/exp-alerts-configure-notifications.adoc +++ /dev/null @@ -1,122 +0,0 @@ -= Configuring Notifications for Alerts -:keywords: alerts, notifications, configure alerts, alert target, manage alerts, anypoint platform, monitoring - -Send API Manager alerts from Anypoint Platform directly to Slack channels and email. Configure alerts in the enhanced experience so teams can see notifications where they work and jump directly into *Portfolio* or *Observability* to respond. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account -* Access to the enhanced experience at omni.mulesoft.com -* Any of these permissions to view alerts: -+ --- -** API Manager: View API Alerts --- -+ -* Any of these permissions to manage alerts: -+ --- -** API Manager: Manage API Alerts --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -* The MuleSoft Slack app installed in your workspace (see xref:exp-slack-integrate.adoc[] for installation steps) - -== View and Manage Alerts - -The enhanced experience provides a unified view of all your alerts: - -. Navigate to the *Notifications* tab in the enhanced experience. -. View all alerts for APIs, MCPs, Agents, and LLMs in one place. -. Filter alerts by: -** Alert type (request count, response time, response codes, and policy violation) -** Severity level (critical, warning, informational) -** Delivery channel (Slack, email, both) - -== Create an Alert - -To create an alert: - -. Navigate to the *Notifications* page in the enhanced experience at omni.mulesoft.com. -. Click *Create Alert*. - -=== Select Alert Target - -. Select your *Environment* from the dropdown. -. Choose a *Service Type*: -** *API* -** *LLM* -** *MCP* -** *Agent* -. In the *Target Service* field, search for and select the specific service to monitor. -. If available for your service type, select an *API instance* from the dropdown. - -=== Specify Alert Configuration - -. Select an *Alert Metric* from the dropdown (Request Count, Response Time, Response Code, or Policy Violation). -. Configure the alert condition: -** Choose a comparison operator (such as `>` for greater than). -** Enter the threshold value. -** Select the time window ( 5 min, 10 min, 15 min, 20 min). -+ -The alert triggers when the metric satisfies the comparison for the selected duration. - -=== Set Alert Delivery - -. Select a *Severity* level: -** *Critical* -** *Warning* -** *Info* -. Enter an *Alert Name* (minimum 4 characters). -+ -This name appears in the notification list and email subjects. -. Configure *Delivery Channels*: -** Toggle *Email* on or off to send alerts to email addresses. -** Toggle *Slack* on or off to send alerts to Slack if enabled. -. If *Slack* is enabled, select your delivery destination: -** Choose a Slack channel from your workspace. -** Or select a direct message recipient. -. Click *Create Alert* to save. - -== Edit an Existing Alert - -To modify an existing alert: - -. Navigate to the *Notifications* page in the enhanced experience. -. Locate the alert you want to modify. -. Click to edit the alert. -. Update any section as needed: -** *Select Alert Target*: Change the environment, service type, target service, or API instance. -** *Specify Alert Configuration*: Modify the metric, condition, threshold, or time window. -** *Set Alert Delivery*: Change severity, alert name, or delivery channels (Email, Slack). -. Save your changes. - -== Slack Alert Notifications - -When an alert triggers, your team receives a notification directly in the configured Slack channel or DM: - -* Alerts display key information about the condition that triggered them -* Teams can see and respond to alerts where they already collaborate -* Alerts include context to help with triage and decision-making -* No need to check email inboxes or switch to the platform console - -== Alert Severity and Routing - -Map alerts to appropriate channels based on severity to reduce noise: - -* *Critical alerts*: Route to high-priority channels monitored by on-call teams -* *Warning alerts*: Send to team channels for awareness and investigation -* *Informational alerts*: Deliver to lower-traffic channels or aggregated reporting channels - -This routing strategy ensures teams see the most important signals first without alert fatigue. - - -== See Also - -* xref:exp-services-monitoring.adoc[] -* xref:exp-services-view-detailed-metrics.adoc[] -* xref:exp-home-start.adoc[] -* xref:exp-overview.adoc[] diff --git a/modules/ROOT/pages/exp-claude-desktop-connect.adoc b/modules/ROOT/pages/exp-claude-desktop-connect.adoc deleted file mode 100644 index 758177314..000000000 --- a/modules/ROOT/pages/exp-claude-desktop-connect.adoc +++ /dev/null @@ -1,41 +0,0 @@ -= Connect the Enhanced Experience to Claude Desktop -:keywords: claude desktop, mulesoft mcp server, enhanced experience, administrator configuration, mcp integration, ai integration, mulesoft claude - -Some organizations connect Claude Desktop (or similar assistants) to the enhanced MuleSoft experience so developers can jump from conversational workflows into governed catalogs and policies without leaving their preferred environment. Your IT team controls whether this integration is available, which OAuth scopes apply, and which actions the assistant can initiate on your behalf. - - -== Before You Begin - -* A supported Claude Desktop release and any enterprise controls your company applies to assistant software. -* Network access from your workstation to both the assistant vendor endpoints and MuleSoft endpoints your security team approved. -* An Anypoint Platform account. -* Mule Developer Generative AI User permission to send prompts to agents. -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Administrator Configuration - -* Identity and consent -+ -Map your Anypoint Platform identity to the assistant context and document which business groups can use the integration. -* Allowed actions -+ -Decide whether the workflow is read-only (for example opening catalog links) or triggers guarded operations, then enforce that with roles and internal process. - -== Use the Integration - -Follow the internal instructions your platform team published, for example a starter prompt, a packaged connector, or a bookmark that opens the enhanced experience with the required query parameters. In the browser, complete any additional sign-in or verification your organization requires. - -If the connection stops working after a client or policy update, check certificates, proxy settings, and token expiry with your administrator before opening a support case. - -== Work with the Enhanced Experience via MuleSoft MCP Server - -Maintain velocity from your own work environment by executing end-to-end lifecycle tasks in the enhanced experience using MuleSoft Platform MCP Server. Manage assets, run scanners, configure gateways, handle governance, and more entirely in natural language from Claude Desktop, VS Code, ChatGPT, Windsurf, and Cursor. - -To get started, see xref:mulesoft-mcp-server::getting-started-platform.adoc[]. - -== See Also - -* xref:exp-home-start.adoc[] -* xref:exp-slack-integrate.adoc[] -* xref:exp-overview.adoc[] diff --git a/modules/ROOT/pages/exp-compare.adoc b/modules/ROOT/pages/exp-compare.adoc deleted file mode 100644 index 5f906a66f..000000000 --- a/modules/ROOT/pages/exp-compare.adoc +++ /dev/null @@ -1,74 +0,0 @@ -= Enhanced MuleSoft Experience and Anypoint Platform Comparison -:keywords: enhanced mulesoft experience, anypoint platform comparison, task management, platform benefits, mulesoft migration, platform differences - -Both the enhanced MuleSoft experience and Anypoint Platform include robust capabilities, but they emphasize different strengths, especially if you manage AI services such as agents, Model proxies, and MCP servers next to APIs and gateways. - -Adopting the new experience gives you a fuller way to manage and optimize AI services, with the flexibility and governance modern AI-driven environments need. You configure AI policies and map relationships among services faster and more seamlessly in the new experience because the UI targets that portfolio. The enhanced experience is especially useful when AI is central to your strategy. - -You still rely on Anypoint Platform for API and integration work, such as designing and evolving specifications, implementing and testing Mule apps in Anypoint Code Builder or Anypoint Studio, running CI/CD, deploying to runtimes such as CloudHub or Runtime Fabric, and using *Exchange* and *API Manager* for publishing, deep lifecycle policy, and runtime management. - -== Benefits of Adopting the Experience - -Unified Relationships Across Entity Types:: *Overview* and graph-style context show how agents, MCP servers, Model proxies, APIs, and gateways connect. You can reason about dependencies and impact more easily than when each silo lives only in its legacy console. -Governance Framed for AI as Well as APIs:: You apply and review governance across domains such as access and security, performance and cost, data privacy and integrity, and compliance and observability, aligned to the asset you're viewing. Policy and conformance work stays adjacent to the asset instead of only in a separate API-only mental model. -Cost and Usage Signals for AI Operations:: The experience includes cost management tooling aimed at portfolio spend, including visibility into token usage and optimization strategies for MCP servers and related AI paths. Use it when you need instance-level usage context tied to the same catalog as the rest of the portfolio. -Instance-Level Policy Control:: For instances backed by Omni Gateway where the product supports it, the experience elevates instance-level governance, including options to tune policy order and draw from a named policy catalog. Use the enhanced experience when you need fine-grained control in the portfolio UI, and use the deeper runtime-only workflows in Anypoint Platform when the experience links you there. -Provider Breadth for AI Connections:: *Platform* includes *Providers* and related configuration so the experience can connect AI and integration services across multiple vendors, such as AWS Bedrock and Google Vertex AI, in addition to your existing MuleSoft footprint. The interface supports multi-vendor AI stacks without forcing each vendor's console to be your only view. -Managed and Unmanaged Instances:: The experience supports creating managed instances on Omni Gateway when you want full support paths including authentication and monitoring, or unmanaged-style instances when you want a lighter footprint. Select the model per asset and gateway strategy. -Assistant Across the Portfolio:: The in-product MuleSoft Agent assistant targets setup, questions, and recommendations across the services the experience tracks. The classic Anypoint Platform control plane doesn't provide that same assistant-led experience. - -== Task Management by Platform - -The enhanced MuleSoft experience and Anypoint Platform each offer distinct capabilities that can guide where you perform different tasks. Understanding each platform's strengths helps you pick the right environment and still combine tools when a workflow spans both. - -[cols="1,1,2a,2a",options="header"] -|=== -| Task | Preferred Experience | Why | Example for Dual Use - -| API design and documentation -| Anypoint Platform -a| -Anypoint Platform offers powerful tools like Anypoint Code Builder for crafting APIs with RAML or OAS and publishing detailed documentation. -a| -To cross-reference API design with governance policies established in the enhanced experience, add your API to the enhanced experience portfolio, then open the asset to review its compliance details alongside the design. See xref:exp-services-add-to-portfolio.adoc[]. - -| Policy enforcement and governance -| Enhanced MuleSoft experience -a| -The new experience excels in applying and managing governance policies across agents, APIs, and other services with detailed compliance tracking and reporting features. -a| -Use Anypoint Platform for initial policy setup when launching a new API. Use the new experience for ongoing monitoring and adjustment to make sure policies remain effective and compliant. - -| Integration development -| Anypoint Platform -a| -Anypoint Code Builder is specifically designed for developing integrations and flows, offering seamless tools for connecting systems and designing workflows. -a| -If an integration involves workflows managed by multiple AI agents, start in Anypoint Platform and then use the new experience to make sure each agent complies with integration standards. - -| Multi-agent ecosystem management -| Enhanced MuleSoft experience -a| -The new experience monitors and optimizes interactions between AI agents to maintain cohesive operation across the ecosystem. -a| -Conduct initial API integration testing in Anypoint Platform to verify functionality, then switch to the new experience for monitoring agents that interact with those APIs. - -| Cost and performance optimization -| Enhanced MuleSoft experience -a| -The new experience provides cost management, token usage tracking, and performance metrics across agents, APIs, MCP servers, and related services in the portfolio. -a| -Use Anypoint Platform to initially monitor API performance under load during development, and use the new experience for ongoing cost optimization after APIs are in full production. - -| Runtime application management -| Anypoint Platform -a| -Use Anypoint Runtime Manager to deploy, manage, and monitor Mule applications during runtime operations. -a| -Deploy applications via Anypoint Platform to leverage its runtime monitoring, then switch to the new experience for broader operational oversight involving governance and policy application across running services. -|=== - -== See Also - -* xref:exp-overview.adoc[] -* xref:exp-home-start.adoc[] diff --git a/modules/ROOT/pages/exp-connect-with-external-systems.adoc b/modules/ROOT/pages/exp-connect-with-external-systems.adoc deleted file mode 100644 index 1acb7f1f2..000000000 --- a/modules/ROOT/pages/exp-connect-with-external-systems.adoc +++ /dev/null @@ -1,19 +0,0 @@ -= Connect the Enhanced Experience with External Systems -:keywords: external systems, slack integration, claude desktop, mcp, mulesoft enhanced experience, integrations - -Connect the enhanced experience to external tools so teams can act on governed services without leaving their preferred environment. You can integrate with collaboration tools like Slack or AI assistants like Claude Desktop. - -The enhanced experience integrates with these external tools: - -* xref:exp-slack-integrate.adoc[] -+ -Install the MuleSoft for Slack app to receive notifications, run shortcuts, and deep-link into the enhanced experience from your Slack workspace. - -* xref:exp-claude-desktop-connect.adoc[] -+ -Connect Claude Desktop to the enhanced experience so developers can move between conversational AI workflows and governed catalogs. - -== See Also - -* xref:exp-slack-integrate.adoc[] -* xref:exp-claude-desktop-connect.adoc[] diff --git a/modules/ROOT/pages/exp-glossary.adoc b/modules/ROOT/pages/exp-glossary.adoc deleted file mode 100644 index e6dd52476..000000000 --- a/modules/ROOT/pages/exp-glossary.adoc +++ /dev/null @@ -1,103 +0,0 @@ -= Enhanced MuleSoft Experience Glossary -:keywords: enhanced mulesoft experience, glossary, terminology, definitions, mulesoft platform, key terms - -The enhanced MuleSoft experience uses a consistent set of terms across governance, portfolio, instance management, and agentic experiences. Clear definitions help you apply the right concepts when registering assets, configuring strategies, and managing instances. - -A2A endpoint:: -An endpoint that exposes an agent's capabilities using the Agent-to-Agent (A2A) protocol. Point to an A2A endpoint during agent registration to fetch the agent card automatically. - -Agent:: -An AI-powered service registered in the Agents catalog. Agents connect via A2A endpoints or agent cards and support governance, policy application, and instance management in the enhanced experience. - -Agent card:: -A metadata file that describes an agent's capabilities, endpoint, and connection details. Upload an agent card during manual registration, or point to an A2A endpoint to fetch one automatically. - -Akamai security findings:: -Security issues detected by Akamai API Security through live traffic inspection and surfaced in the *Conformance* tab of a governance strategy alongside governance rule results. Critical and High findings map to violations, Medium to warnings, and Low and Info to informational findings. Select a finding to view remediation opportunities and apply a policy directly from the detail panel. - -API:: -A service defined by a formal specification and managed in the APIs catalog. Supports REST (OAS, RAML), gRPC (Proto), and AsyncAPI formats. Register APIs manually with a spec file or import them via provider scanners. - -MuleSoft Agent:: -The embedded agentic experience built into the enhanced MuleSoft experience UI. Use MuleSoft Agent for setup guidance, portfolio questions, and recommendations without leaving the product. - -Conformance Report:: -A view on the detail pages of agents, APIs, and MCP servers that shows compliance scores, rule violations, and warnings that applied governance strategies generate. - -Cross-gateway conformance:: -A unified view of compliance status across APIs hosted on Anypoint Platform gateways and connected third-party provider gateways. Access cross-gateway conformance from the *Governed Services* tab of an active governance strategy. Use the *Any provider* filter to compare conformance by platform or focus on a specific provider. - -Enhanced experience:: -The new MuleSoft UI for managing your AI portfolio, including governance, instance management, observability, and agentic experiences. - -Gateway:: -A runtime component that proxies traffic to backend services while enforcing policies. Supported types include Anypoint Omni Gateway (managed), external gateways, and unmanaged gateways. - -Governance > Cost Management:: -A section under Governance that surfaces token usage, daily spend signals, and cost optimization recommendations across your portfolio. Apply tool mapping, tool sanitization, and related strategies here where the experience supports them. - -Governance > Coverage:: -A view that shows which services and instances have active governance strategies and which governance domains they cover. Coverage identifies gaps where services operate without policy or compliance oversight. - -Governance > Governance Strategies:: -A section under Governance for configuring and managing strategies that monitor, report, enforce, and block noncompliant activity across your services. - -Governance > Security:: -The domain of policies and controls that protect who can access and call your services. - -Governance Strategy:: -A bundled set of design-time and runtime rules that enforce a governance posture across targeted services. Governance strategies connect policy intent to conformance reporting, cost management, and runtime behavior. - -Governance Strategy > Controls:: -Design-time rules that validate services against selected rule sets and generate conformance reports. Apply controls as part of a governance strategy to optionally block noncompliant actions. - -Governance Strategy > Automated Policies:: -Runtime rules that govern traffic passing through service instances. Policies control access, data handling, rate limits, and other runtime behaviors defined in a governance strategy. - -Instance:: -A deployed version of a service on a specific gateway or runtime. Instances receive traffic on the Instance URL and proxy requests to the Target URL. Supported service types include APIs, agents, MCP servers, and Model proxies. - -Model Proxy:: -A gateway-backed service that routes requests to a large language model. Model proxies register in the Model Proxies catalog and support instance management, policy application, and token usage monitoring. - -Managed instance:: -An instance backed by Anypoint Omni Gateway that enables full policy enforcement, authentication, and monitoring integration. Managed instances provide stronger governance and observability than unmanaged paths. - -MCP Server:: -A server that implements the Model Context Protocol, exposing tools and resources to MCP clients. Create MCP servers from existing APIs, register them manually with an MCP URL or schema file, or import them via provider scanners. - -MuleSoft Agent:: -The agentic experience for MuleSoft available in Slack. Use MuleSoft Agent to receive notifications, run shortcuts, and navigate back into the enhanced experience from your messaging workspace. - -Observability:: -A section that aggregates org-wide dashboards, reports, and notifications when your administrator enables and connects the observability backend for your business group. Use Observability to compare service-level monitoring signals with broader traffic patterns. - -Platform MCP Server:: -The MCP server that exposes enhanced MuleSoft experience capabilities to MCP clients such as Claude Desktop. Use Platform MCP Server to access portfolio and governance features from supported development environments. - -Portfolio:: -The set of services registered or discovered within your org, organized into catalogs for agents, APIs, MCP servers, Model proxies, and gateways. Each catalog provides governance, monitoring, and instance management for the services it contains. - -Providers:: -The external cloud platforms connected to the enhanced experience to enable automated service discovery and import. Configure providers under *Platform* > *Providers*. - -Scanner:: -A configured connection between the enhanced experience and a supported cloud provider. When a scanner runs, it discovers services and registers them in the matching Portfolio catalog. Scanners run on a schedule or on demand. - -Slackbot:: -The native Slack assistant that connects to the MuleSoft Platform MCP Server to answer questions about the MuleSoft platform from within Slack. After installing the MuleSoft for Slack app, open Slackbot and connect it through *Integrations*. Slackbot is separate from the MuleSoft Agent, which handles management tasks and notifications. - -Semantic Service:: -A service that applies context-aware matching to route LLM-driven requests to the most relevant tools and pathways. It's available at Basic scale (managed internal configuration) or Advanced scale (external embedding API and vector database). - -Target:: -The backend implementation that a gateway proxies traffic to after enforcing policies. Each instance defines a Target URL that points to the live service or runtime. - -Tool mapping:: -A governance control that defines which tools an LLM or agent can invoke. Apply tool mapping to reduce token spend and limit exposure to unintended operations. - -Tool sanitization:: -A governance control that filters or modifies tool inputs and outputs before they reach a model or service. Apply tool sanitization to reduce risk and cost for LLM-backed services. - -Unmanaged instance:: -A lighter-weight instance deployment that does not route traffic through Omni Gateway. Choose unmanaged instances when a full managed path does not match your operating model. diff --git a/modules/ROOT/pages/exp-governance-create-strategy.adoc b/modules/ROOT/pages/exp-governance-create-strategy.adoc deleted file mode 100644 index a23bed9d9..000000000 --- a/modules/ROOT/pages/exp-governance-create-strategy.adoc +++ /dev/null @@ -1,110 +0,0 @@ -= Create Governance Strategies -:keywords: governance strategies, create strategy, strategy workflow, governance scope, strategy type, api governance, mulesoft - -Governance strategies define which services the system evaluates or enforces policy against and under what conditions. A Control strategy monitors compliance and can block noncompliant activity. An Automated Policy strategy enforces requirements at the gateway or runtime layer. You can create strategies if your tenant includes *Governance* and you have the required administrator role. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* Any of these permissions: -+ --- -** API Governance: Governance Administrator -** API Manager: Manage Policies --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -Also decide whether you need validation-only monitoring or active runtime enforcement. This choice determines the strategy type and the rules or policies to apply. - -== Open the Strategy Workflow - -. Log in and go to *Governance* > *Governance Strategies*. -. Select *Create Governance Strategy* to start the setup flow. - -The setup flow guides you through type, scope, rules or policies, and activation. - -== Select Strategy Type - -Select from these types: - -* *Controls* validate targeted services against control rules. Use controls to monitor compliance and, when supported, block noncompliant activity. -* *Automated Policy* enforces runtime policy requirements across targeted services. - -Select the type that matches your governance objective, then proceed. - -== Define Governance Scope - -Configure scope criteria to identify the services that the strategy governs. All criteria are combined to narrow the scope. - -Set these filters: - -*Service Type*:: -Select one or more service types to govern. - -*Tags*:: -Select tags to include only services that match those tags. - -*Categories*:: -Select categories to further narrow the scope. - -*Instances*:: -Filter by instance status: -+ --- -* *All APIs*: Include all matching services regardless of instance status. -* *Include only APIs with instances*: Include only services that have at least one associated instance. -* *Only APIs without instances*: Include only services with no associated instances. --- - -Use *Preview Governed Scope* to see which services currently match your criteria before you move forward. - -== Configure Controls or Policies - -In the enhanced experience, your existing Anypoint profiles appear as controls. Controls offer expanded capabilities, such as governing new services and providing rules to control service and AI state behavior. - -Depending on the strategy type, select the controls or policies the strategy enforces: - -* For *Controls*, select controls from the catalog available in your tenant. -* For *Automated Policy*, define runtime details such as gateway runtime, endpoint type, and environment. - -Available options depend on your earlier selections and your organization's enabled products. - -== Name and Describe the Strategy - -Enter a clear *Strategy Name*, such as "PCI Compliance Rules". Add a *Description* that states what the strategy enforces and why. - -== Review and Activate - -Review your selections: strategy type, scope, rules or policies, and general information. - -Select *Create and Activate Strategy*. - -Strategies are active by default. To disable a strategy, go to *Governance Strategies*. - -== After Strategy Activation - -* The system evaluates services that match the scope against the rules or policies in the strategy. -* For *Controls*, compliance status appears in conformance reports. -* For *Automated Policy*, enforcement runs at the gateway or runtime layer. -* Edit the strategy from *Governance Strategies* when scope, rules, or naming change. - -Work with your governance lead if strategies affect production services or if rollout timing requires coordination. - -[#create-with-ide] -== Create Governance Strategies with Your IDE - -You can also author governance strategies from your IDE by using locally installable developer skills. With skills, you define governance rulesets as code, which is useful for version control, reuse, and collaboration. - -Some rule types are available only through IDE skills. For example, you can't configure control rules that track third-party provider policy subcategories in the UI. To create these rules, use a prompt such as `create a rule to track that each API has a JWT policy applied to it`. - -For step-by-step guidance on authoring rulesets from your IDE, see the https://dev-portal.mulesoft.com/skills/author-governance-ruleset.html[Author a Governance Ruleset] skill in the MuleSoft Developer Hub. - -== See Also - -* xref:exp-governance-work-with-strategies.adoc[] -* xref:exp-governance-manage-strategies.adoc[] -* xref:exp-governance-view-cost-and-token-usage.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-governance-govern-third-party-apis.adoc b/modules/ROOT/pages/exp-governance-govern-third-party-apis.adoc deleted file mode 100644 index 3244b7082..000000000 --- a/modules/ROOT/pages/exp-governance-govern-third-party-apis.adoc +++ /dev/null @@ -1,48 +0,0 @@ -= Govern Third-Party Provider APIs -:keywords: third-party apis, cross-gateway governance, provider governance, api compliance, policy enforcement - -After connecting to a third-party API gateway provider, you can govern discovered APIs through the same governance workflow used for Anypoint Platform APIs. This enables unified governance across multiple gateway platforms. - -Follow these steps to govern APIs from third-party providers: - -. Connect and create a scanner. When the scanner runs, it discovers and catalogs APIs and their read-only policies. See xref:exp-services-view-details.adoc[] - -. Go to *Portfolio* > *APIs* and verify that discovered APIs appear, each labeled with its provider (for example, *AWS*). APIs are automatically added to the portfolio as they are discovered. - -. Create control rules to track the policies that you want to enforce across providers. You create these rules using developer skills rather than the UI. For guidance on creating policy subcategory rules, review the https://dev-portal.mulesoft.com/skills/author-governance-ruleset.html[Author a Governance Ruleset] skill in the MuleSoft Developer Hub. For example, use a prompt such as `create a rule to track that each API has a JWT policy applied to it`. - -. Create a xref:exp-governance-create-strategy.adoc#create-with-ide[governance strategy] and select the control rules or automated policies to apply. The strategy evaluates conformance for all in-scope APIs, including those discovered from third-party providers. - -. Track conformance status for provider-hosted APIs through the governance strategy dashboard. Use the *Any provider* filter in the *Governed Services* tab of your governance strategy to focus on a subset of your cross-gateway environment. - -// FLAG: Aug 13 release (policy write scope). The "Apply Policies" workflow step applies policies directly to provider-hosted instances, which is Policy Write (GA Aug 13). The Jul 16 release governs third-party APIs in read/conformance mode only. Uncomment when the Aug 13 write release is documented. -// . *Apply Policies*: For targeted or supplemental policy application, use xref:exp-governance-policy-library-apply.adoc[Policy Library] to select and apply policies directly to provider-hosted API instances. - -// FLAG: Aug 13 release (policy write scope). "Read-Only Policy Status" and the credential-update-to-enable-writes flow describe Policy Write (GA Aug 13). Uncomment when the Aug 13 write release is documented. -// *Read-Only Policy Status*: If a policy shows *Read-Only* status, the provider connection uses read-only credentials. To enable policy writes, xref:exp-governance-setup-third-party-providers.adoc#update-credentials[update the credentials] with write-enabled permissions. - -// FLAG: Aug 13 release (policy write scope). The entire "Policy Library for Third-Party APIs" section applies policies to provider instances, which is Policy Write (GA Aug 13), not Jul 16 Policy Read. Uncomment when the Aug 13 write release is documented. -// == Policy Library for Third-Party APIs -// -// The xref:exp-governance-policy-library-apply.adoc[Policy Library] provides a targeted way to apply individual policies to third-party provider services: -// -// . Go to *Governance* > *Governance Strategies* > *Policy Library*. -// . Complete the four-step wizard: -// + -// -- -// ** *Select Policy*: Browse policies and filter by the Access and Security, Performance and Cost, Data Privacy and Integrity, or Compliance and Observability categories. Policies that apply to any service are marked with a *Universal* badge. -// ** *Configure Policy*: Set policy parameters. -// ** *Select Instances*: Choose API instances hosted on third-party providers. -// ** *Review & Apply*: Confirm and apply the policy. -// -- -// -// Use the Policy Library when you need supplemental or one-off policy application outside governance strategies. - -== See Also - -* xref:exp-services-view-details.adoc[] -* xref:exp-governance-create-strategy.adoc[] -* https://dev-portal.mulesoft.com/skills/author-governance-ruleset.html[Author a Governance Ruleset] -// FLAG: Aug 13 release (policy write scope). Link to the Policy Library apply topic, which is commented out until the Aug 13 write release. Uncomment together with that topic. -// * xref:exp-governance-policy-library-apply.adoc[Browse the Policy Library] -* xref:exp-governance-monitor-cross-gateway-conformance.adoc[] diff --git a/modules/ROOT/pages/exp-governance-manage-strategies.adoc b/modules/ROOT/pages/exp-governance-manage-strategies.adoc deleted file mode 100644 index bb2bb6fa0..000000000 --- a/modules/ROOT/pages/exp-governance-manage-strategies.adoc +++ /dev/null @@ -1,66 +0,0 @@ -= Managing Governance Strategies -:keywords: governance strategies, api governance, strategy metrics, filter strategies, anypoint platform, strategy actions, api management - -Keep governance strategies aligned with your portfolio by adjusting scope, rules, or status as your services and compliance requirements evolve. Summary cards show active strategy counts, type breakdowns, and governance coverage at a glance. - -== Display Governance Strategies - -Go to *Governance* > *Governance Strategies* to view all strategies. Check the strategy name, type, environment, target, status, governed services count, and last modified time. - -== Available Strategy Actions - -* View details: Open a strategy to review scope, rules or policies, and metadata. -* Enable or disable: Pause a strategy without deleting it. -* Edit configuration: Update scope, rules, name, or description, then save. -* Reorder strategies: Change strategy order when multiple strategies govern the same services. -* Delete a strategy: Permanently remove a strategy that you no longer need. - -== Filter and Search Strategies - -Use the controls above the table to narrow the list: - -* Use the strategy type tabs to show *All*, *Controls*, or *Automated Policies*. -* Use the status filter to select *Any Status*, *Active*, or *Disabled*. -* Enter text in the search field to match strategy names. - -The page updates to show only matching strategies. - -== Strategy Metrics - -Review the summary cards: - -* *Active Strategies*: The number of enabled strategies -* *Strategy Types*: The breakdown of *Controls* and *Automated Policies* -* *Governance Coverage*: When available, the portion of the portfolio governed by at least one strategy - -Use these cards to spot governance gaps quickly. - -== Akamai-Generated Strategy - -When you connect Akamai API Security as a provider, the system automatically creates a pre-configured Akamai security strategy in the strategy list. This strategy attributes Akamai security findings to your MuleSoft APIs and MCP servers. Don't delete it unless you also remove the Akamai scanner. Deleting the strategy stops security findings from appearing in conformance reports. - -== Identify When to Edit or Disable a Strategy - -Edit or disable a strategy when: - -* Scope drift causes the strategy to include the wrong services or miss intended services. -* New compliance requirements call for adding or replacing rules. -* False positives or unexpected blocking require control changes. -* Environment or tag changes make existing filters inaccurate. - -Check the *Governed Services* count before and after changes to confirm the scope adjusted as expected. - -== Impact on Governed Services - -When you disable a strategy, the system stops evaluating or enforcing that strategy for matching services. - -When you delete a strategy, active governance for that strategy stops. Historical data retention depends on your reporting backend. - -Coordinate with service owners and your governance team if changes affect production services or compliance reporting that your organization relies on. - -== See Also - -* xref:exp-governance-work-with-strategies.adoc[] -* xref:exp-governance-create-strategy.adoc[] -* xref:exp-governance-view-cost-and-token-usage.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-governance-monitor-cross-gateway-conformance.adoc b/modules/ROOT/pages/exp-governance-monitor-cross-gateway-conformance.adoc deleted file mode 100644 index cf1adeaaa..000000000 --- a/modules/ROOT/pages/exp-governance-monitor-cross-gateway-conformance.adoc +++ /dev/null @@ -1,58 +0,0 @@ -= Monitoring Cross-Gateway Conformance -:keywords: cross-gateway conformance, provider conformance, governance monitoring, compliance tracking, multi-gateway governance - -After creating governance strategies that target multiple gateway platforms or third-party providers, monitor conformance across your entire API ecosystem through a unified dashboard. The conformance summary shows conformance status for APIs hosted on Anypoint Platform gateways and connected third-party providers. - -== Before You Begin - -Before monitoring cross-gateway conformance: - -* xref:exp-services-view-details.adoc[Connect to one or more third-party providers] to enable cross-gateway governance. -* xref:exp-governance-create-strategy.adoc[Create a governance strategy] that evaluates the APIs you want to monitor. -* Verify that the strategy is active and has evaluated the targeted APIs. - -== View Cross-Gateway Conformance - -. Log in and go to *Governance* > *Governance Strategies*. -. Select an active strategy. The strategy opens on the *Configuration* tab, which shows the scope and rules. -. Select the *Governed Services* tab to view conformance results. - -The *Governed Services* tab displays: - -* A *Conformance* summary: the total number of governed services, broken down into *Conformant*, *Nonconformant*, and *Pending*. -* An *Identified Issues* summary: counts of violations, warnings, and info-level findings. -* A table of governed services with *Service*, *Type*, *Provider*, and *Conformance* columns. The *Provider* column shows which platform hosts each API. -// FLAG: Aug 13 release (policy write scope). "Policy Application Status" (Enabled/Read-Only enforcement state) reflects policy enforcement, which is Policy Write — GA Aug 13. Uncomment when the Aug 13 write release is documented. -// * *Policy Application Status*: Indicates whether policies are *Enabled* (actively enforced) or *Read-Only* (monitoring mode only). - -== Filter by Specific Provider - -To focus on conformance for a specific provider: - -. On the *Governed Services* tab, locate the *Any provider* filter. -. Select a provider from the list. - -The list updates to show only APIs hosted on the selected provider. - -Use this filter to: - -* Compare conformance across providers. -* Identify provider-specific conformance gaps. -* Focus on a subset of your multi-gateway environment during reviews or audits. - -// FLAG: Aug 13 release (policy write scope). The entire "Understanding Read-Only Policy Status" section describes policy enforcement and credential-based write access, which is Policy Write — GA Aug 13. The Jul 16 Policy Read GA monitors conformance in read-only mode only. Uncomment when the Aug 13 write release is documented. -// == Understanding Read-Only Policy Status -// -// If a policy shows *Read-Only* status in the conformance dashboard: -// -// * The provider connection uses credentials with read-only permissions. -// * Policies are applied in monitoring mode only and don't enforce requirements on the provider gateway. -// * The system can track conformance but can't automatically remediate violations. -// -// *How to Remediate*: xref:exp-governance-setup-third-party-providers.adoc#update-credentials[Update provider credentials] to grant write-enabled permissions. After updating credentials, policies transition from *Read-Only* to *Enabled* status and can enforce requirements on the provider gateway. - -== See Also - -* xref:exp-governance-create-strategy.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-governance-govern-third-party-apis.adoc[] diff --git a/modules/ROOT/pages/exp-governance-policy-library-apply.adoc b/modules/ROOT/pages/exp-governance-policy-library-apply.adoc deleted file mode 100644 index 9c7017556..000000000 --- a/modules/ROOT/pages/exp-governance-policy-library-apply.adoc +++ /dev/null @@ -1,126 +0,0 @@ -// = Browse the Policy Library -// :keywords: policy library, canonical policies, governance policies, policy catalog - -// // FLAG: Jul 16 publish condition. The read/browse description below (what the Policy Library is and what users can see) is written for the Jul 16 Policy Read GA. However, the Policy Library UI is gated behind a feature flag (W_23173868_CANONICAL_POLICIES_ENABLED, default off) and is not called out as a Jul 16 deliverable in the PRD. Confirm with the PM that the Policy Library is enabled in browse mode for Jul 16 before publishing this topic. The policy-application wizard is Policy Write (GA Aug 13) and is commented out at the end of this file. - -// The Policy Library is a catalog of predefined policies that you can browse from *Governance* > *Governance Strategies* > *Policy Library*. Use it to explore the policies available to your organization and understand what each one enforces before you govern your APIs. - -// == Browse Policies by Category - -// The Policy Library displays each available policy as a card that shows the policy name, its category, and a short description of what the policy does. - -// To find a policy, you can: - -// * Search for a policy by name using the search box. -// * Filter policies by category: -// + -// -- -// ** *Access and Security*: Authentication and authorization policies, including OAuth 2.0, JWT validation, IP filtering, and rate limiting. -// ** *Performance and Cost*: Policies that manage API performance and cost, such as caching, spike arrest, and request throttling. -// ** *Data Privacy and Integrity*: Policies that protect data privacy and ensure data integrity, such as PII masking, data encryption, and payload validation. -// ** *Compliance and Observability*: Policies that enable compliance tracking and observability, such as audit logging, correlation ID injection, and OpenTelemetry tracing. -// -- - -// Policies that apply to any service, including scanned and federated APIs, are marked with a *Universal* badge. - -// == See Also - -// * xref:exp-governance-create-strategy.adoc[] -// * xref:exp-services-view-details.adoc[] -// * xref:exp-governance-govern-third-party-apis.adoc[] - -// // FLAG: Aug 13 release (policy write scope). Everything below documents applying policies to API instances (including third-party provider instances) through the Policy Library wizard, which is Policy Write — GA Aug 13. It is out of scope for the Jul 16 Policy Read GA. Uncomment when the Aug 13 write release is documented, and fold these sections into the topic above (add the apply use cases, permissions, and wizard steps). Note: for MuleSoft-native and Kong instances, policy application already ships, but cross-gateway apply as described here aligns with the Aug 13 milestone — confirm scope with the PM before publishing. -// //// -// == When to Use the Policy Library to Apply Policies - -// Use the Policy Library instead of governance strategies when you want to: - -// * Apply a policy to a specific set of API instances without creating a governance strategy. -// * Add supplemental policies to instances that are already governed by strategies. -// * Apply policies to third-party provider services hosted on platforms such as Akamai. -// * Test policy behavior on a limited scope before a broader rollout. - -// For comprehensive, scope-driven governance across multiple services, use xref:exp-governance-create-strategy.adoc[governance strategies] instead. - -// == Before You Begin - -// Before getting started, make sure you have: - -// * An Anypoint Platform account. -// * Any of these permissions: -// + -// -- -// ** API Governance: Governance Administrator -// ** API Manager: Manage Policies -// -- -// + -// For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -// * API instances registered in the portfolio. For third-party provider services, make sure that the xref:exp-governance-setup-third-party-providers.adoc[provider connection] is established. - -// == Open the Policy Library Wizard - -// . Log in and go to *Governance* > *Governance Strategies* > *Policy Library*. -// . Select *Apply Policy* to start the policy application wizard. - -// The wizard guides you through policy selection, configuration, instance selection, and review. - -// == Select Policy - -// Browse the available policies and filter by category, then select the policy you want to apply and select *Next*. - -// == Configure Policy - -// Enter configuration parameters for your selected policy. Required and optional fields vary by policy type. - -// Common configuration fields include: - -// * *Policy Name*: A descriptive name for this policy application. -// * *Enforcement Mode*: Whether to enforce the policy or monitor violations only (if supported). -// * *Parameters*: Policy-specific settings such as rate limits, authentication providers, or transformation rules. - -// Configure the policy parameters according to your requirements and select *Next*. - -// == Select Instances - -// Choose the API instances where you want to apply the policy: - -// . Review the list of available API instances. The list includes instances from Anypoint Platform and connected third-party providers. -// . Use filters to narrow the list by: -// + -// -- -// ** *Provider*: Filter by specific providers (such as Akamai) or Anypoint Platform gateways. -// ** *Service Type*: Filter by service type (such as REST API or GraphQL). -// ** *Tags*: Filter by tags assigned to services. -// -- - -// . Select one or more instances where you want to apply the policy. -// . Select *Next*. - -// == Review and Apply - -// Review the policy application summary: - -// * *Policy*: The selected policy and its configuration. -// * *Instances*: The list of instances where the policy is applied. -// * *Expected Outcome*: A summary of what happens when you apply the policy. - -// *Read-Only Mode*: If any selected instances belong to a provider connection with read-only credentials, those instances receive the policy in monitoring mode only. To enable write access, xref:exp-governance-setup-third-party-providers.adoc#update-credentials[update provider credentials]. - -// Select *Apply* to apply the policy to the selected instances. - -// == Verify Policy Application - -// After applying the policy: - -// . Go to *Portfolio* > *APIs* and open the affected API instance. -// . Review the *Applied Policies* tab to verify the policy appears in the list. -// . Check the *Policy Application Status*: -// + -// -- -// ** *Enabled*: The policy is actively enforced on the gateway. -// ** *Read-Only*: The policy is applied in monitoring mode only (typically due to read-only provider credentials). -// -- - -// If the policy is in read-only mode and you want enforcement, xref:exp-governance-setup-third-party-providers.adoc#update-credentials[update provider credentials] to grant write access. -// //// diff --git a/modules/ROOT/pages/exp-governance-view-cost-and-token-usage.adoc b/modules/ROOT/pages/exp-governance-view-cost-and-token-usage.adoc deleted file mode 100644 index 81c172300..000000000 --- a/modules/ROOT/pages/exp-governance-view-cost-and-token-usage.adoc +++ /dev/null @@ -1,90 +0,0 @@ -= Managing Costs and Token Usage -:keywords: cost management, token usage, ai governance, usage metrics, anypoint platform, cost tracking, ai services - -Use cost and token metrics to understand usage, control spend, and identify optimization opportunities. - -Available metrics depend on your tenant configuration and role. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* These permissions: -+ --- -** API Manager: Manage Policies -** API Manager: View APIs Configuration -** API Manager: View Policies -** Anypoint Code Builder: Mule Developer Generative AI User -** Anypoint Monitoring: Monitoring Viewer -** Exchange: Exchange Viewer --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Cost and Token Data Locations - -The system displays token usage and performance data in several places: - -* *Governance* > *Cost Management*: Primary dashboard for organization-wide token usage and spend indicators -* Service detail pages: Usage and performance summaries for supported services -* *Observability*: Aggregated token and latency trends, when configured - -include::partial$exp-navigation-labels.adoc[tag=ExpNavigationLabels] - -== Open Cost Management - -. Log in and go to *Governance* > *Cost Management*. -. Adjust the time range and filters for the services or period you want to analyze. - -== Usage Metrics - -The experience organizes token and activity data into summary cards and detail views: - -* *Total Tokens*: Number of tokens processed in the selected time range -* *Saved Tokens (Est.)*: Estimated tokens saved by optimization policies -* *Tool Calls*: Number of tool or function calls in the selected time range - -Each card also shows how many instances contributed to the metric. - -== Filter and Search - -Use controls at the top of the page to narrow the view: - -* Search for service or instance names. -* Use *Filters* to refine your search by service type, environment, or metadata. -* Select a time range to search, such as 1 hour (1H), 6 hours (6H), 24 hours (24H), 7 days (7D), or 30 days (30D). - -The counter updates to show the number of matching services. - -== Saved Token Estimates - -When optimization policies are active, the system estimates saved tokens compared to unoptimized traffic. - -Treat this metric as directional, not exact. - -== Cost Data Use Cases - -Cost and performance data inform multiple workflows: - -* Cost optimization: Identify services with high usage and apply optimization controls. -* Performance triage: Correlate latency or error spikes with deployments or policy changes. -* Planning and alignment: Share trends with finance and platform teams for forecasting. - -This dashboard doesn't automatically cap usage. To limit consumption, apply governance strategies or rate-limiting policies. - -== Cost Data and Governance - -Use *Cost Management* data to create or refine governance strategies. - -For runtime enforcement, attach cost-related controls or policies to a governance strategy and apply it to the relevant services. - -== See Also - -* xref:exp-governance-work-with-strategies.adoc[] -* xref:exp-governance-create-strategy.adoc[] -* xref:exp-governance-manage-strategies.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-services-monitoring.adoc[] -* xref:exp-services-view-detailed-metrics.adoc[] diff --git a/modules/ROOT/pages/exp-governance-work-with-strategies.adoc b/modules/ROOT/pages/exp-governance-work-with-strategies.adoc deleted file mode 100644 index 2bc5f5bec..000000000 --- a/modules/ROOT/pages/exp-governance-work-with-strategies.adoc +++ /dev/null @@ -1,89 +0,0 @@ -= Working with Governance Strategies -:keywords: governance strategies, api governance, governance workflows, mulesoft governance, strategy management, anypoint platform - -Use governance strategies to apply conformance rules and policies across agents, APIs and MCP servers. When your tenant includes *Governance* and your account has the required role, you can create, manage, and monitor these strategies to validate service design compliance, automate runtime enforcement, and maintain visibility as your portfolio grows. - -NOTE: The MuleSoft interface uses two terms for strategy types: *controls* (for guardrail-based strategies) and *automated policies*. In this documentation, "strategy" refers to both types unless otherwise specified. - - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* These permissions: -+ --- -** To create governance strategies, either: -*** API Governance: Governance Administrator -*** API Manager: Manage Policies -** To view governance reports, either: -*** API Governance: Governance Viewer -*** API Governance: Governance Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Access Governance Strategy Workflows - -Log in through your organization’s entry path and go to *Governance*. - -From *Governance* > *Governance Strategies*, create strategies and map them to approved services or scopes. You can also edit, enable, disable, reorder, or delete existing strategies. - -Work with your governance lead when strategy changes affect production or compliance workflows. - -== Governance Strategy Workflows - -* Create strategies for compliance validation or runtime enforcement. See xref:exp-governance-create-strategy.adoc[]. -* Manage strategies by updating scope, rules, status, and priority. See xref:exp-governance-manage-strategies.adoc[]. -* Monitor token usage in *Governance* > *Cost Management*. See xref:exp-governance-view-cost-and-token-usage.adoc[]. -* Review conformance reporting for xref:exp-overview.adoc[supported catalog types]. -* Apply policies to services from *Portfolio*. See xref:exp-services-view-details.adoc[]. - -== Akamai Security Findings in Conformance Reports - -When Akamai API Security is connected as a provider, the *Violations*, *Warnings*, and *Info* counts in the conformance report include Akamai security findings alongside governance rule results. A service can show a *Non-Conformant* status even when no governance rules are violated, if Akamai findings contribute violations. - -The Conformance tab includes a dedicated Akamai section with two tables: - -* *Security Findings*: Individual security issues detected by Akamai through live traffic inspection, broken down per instance and per endpoint. -* *Incidents*: Recurring threats aggregated over time, with first- and last-seen timestamps and occurrence counts. - -Both tables have these sortable columns: *Finding*, *Instance*, *Endpoint*, and *Risk*. - -Akamai severity levels map to conformance tiers as follows: - -* Critical and High map to violations. -* Medium maps to warnings. -* Low and Info map to informational findings. - -The *Severity* filter at the top of the Conformance tab applies to both the governance rule results and the Akamai tables. - -=== Review a Finding - -Select a row in the *Security Findings* table to open the finding detail panel, which shows: - -* *Triggered On*: The endpoint path where the issue was detected. -* *Risk*: The severity level. -* *Exposure*: Whether the endpoint is internet-facing. -* *Remediation Opportunities*: Curated recommended policies for this finding type. Select *Apply This Policy* to open the policy-apply flow with the policy pre-selected. Select *Browse in Policy Library* if no curated policy is listed. After a policy is applied, Akamai re-inspects live traffic and updates the finding status automatically. - -=== Review an Incident - -Select a row in the *Incidents* table to open the incident detail panel, which shows: *Detection Time*, *Type*, *Triggered On*, *Severity*, *Occurrences*, *Exposure*, OWASP tags, and Compliance Frameworks. - -=== Refresh Conformance Results - -After a scan runs, the API listing and API detail pages don't automatically reflect the updated conformance status. To see the latest results, manually refresh in one of these ways: - -* Refresh a single API: On the API detail page, open the *Conformance* tab and select *Refresh*. -* Refresh all APIs: On the *Governance Strategies* page, select *Refresh Report*. - -== See Also - -* xref:exp-governance-create-strategy.adoc[] -* xref:exp-governance-manage-strategies.adoc[] -* xref:exp-governance-view-cost-and-token-usage.adoc[] -* xref:exp-overview.adoc[] -* xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-home-start.adoc b/modules/ROOT/pages/exp-home-start.adoc deleted file mode 100644 index 45deeb6e9..000000000 --- a/modules/ROOT/pages/exp-home-start.adoc +++ /dev/null @@ -1,105 +0,0 @@ -= Get Started with the Enhanced Experience -:keywords: enhanced experience, get started, permissions, workflow, access, anypoint platform, setup -:page-aliases: - -Grow and tune your AI portfolio by registering and monitoring agents, APIs, and gateways in centralized catalogs. Sign in through the entry point your organization provides, such as Anypoint Platform, or a direct URL, to access dashboards and governance strategies based on your assigned permissions. You can review live performance metrics, manage security policies, and track rule-level compliance through automated conformance reports. - -These tools ensure your AI assets remain audit-ready while providing clear visibility into cost and runtime health across your organization. - -== Access the Enhanced Experience - -Your organization determines how you access the new experience. Common options include these environments. - -* Anypoint Platform -+ -In Anypoint Platform, look for the new experience banner or shortcut and choose *Go to the new experience*. Your administrator can also add a direct link in the main navigation or workspace. -// * Slack -// + -// If your organization integrates the new experience with Slack, use the new experience Slack app to receive notifications and alerts, and follow links back into the product. Your workspace can also offer shortcuts or slash commands your admin configures. -* Coding assistants -+ -If your organization connects the new experience to a supported assistant, such as Claude Code, follow your internal instructions to open the new experience features from that development environment. -* Direct URL -+ -Your organization can share a standalone URL that signs you in to the new experience outside other apps. Use the address your administrator or internal documentation provides. -* Custom integrations -+ -Your organization can build access through another tool. Follow the internal access instructions for custom integrations. - -[NOTE] -Available access points depend on how your administrators configured the new experience's integrations with other platforms. - - -== Before You Begin - -Before you rely on the new experience in production, complete these checks with your administrator. Requirements vary by entry point and how your administrator integrates the new experience with other systems. - -Access and Credentials:: -+ -* Confirm that you have a user account for your organization's entry path, such as Anypoint Platform, and valid credentials to log in. -* Confirm that you can reach the new experience and integrated services, such as Anypoint Platform, or a connected coding assistant, from the networks and locations you use. - -Platform and Product Access:: -+ -* Confirm that your organization has the required product access for the new experience and that an administrator enabled it for your Anypoint Platform business group or organization. -+ -If the experience isn't available, contact your Anypoint Platform organization administrator or MuleSoft account team. -* Confirm that required integrations with Anypoint Platform or your development environment work end to end. -* If the new experience connects to other services, work with your administrator to configure authentication, such as API keys or OAuth tokens, to ensure successful connections. -* Confirm that your administrator approved and configured required external connections, such as cloud providers under *Providers*. - - -[[permissions]] -== Enhanced Experience Permissions -// make this a partial in access management and include there as well. - -The new experience uses Anypoint Platform access management. -Your administrator maps jobs to roles and permissions in Access Management. -Exact permission names differ by organization. -Use this table with your internal access guide. - -include::access-management::partial$include-permissions-enhanced-exp.adoc[tag=experiencePermissionsTable] - -If you can't complete an action or a page shows an authorization error, ask your Anypoint Platform organization administrator for the matching permission or role. - -//// -== High-Level Enhanced Experience Workflow - -Manage and tune your AI portfolio by registering assets, applying security policies, and monitoring runtime health. Access centralized catalogs to track agents and gateways while verifying compliance through conformance reports and cost management tools. These integrated features help you optimize performance and maintain audit readiness across your environment - -. Complete onboarding and access -+ -Confirm your credentials and the permissions your administrator assigned, as described in <>. Finish integration setup for supporting systems, such as connected providers under *Platform* > *Providers*, before you depend on the new experience in production. -. Learn the layout -+ -Sign in through your entry path and land on *Home*. Scan *Portfolio* catalogs, *Governance*, *Observability*, and *Platform* so you know where to register assets, apply policies, read health signals, and manage providers. -. Register assets in Portfolio -+ -Under *Portfolio*, open *Agents*, *MCP Servers*, *Model Proxies*, *APIs*, or *Gateways*. Add assets to work with. Register manually or use connected providers under *Platform* > *Providers* if your organization enables discovery flows. -. Create and manage instances -+ -On *Agents*, *MCP Servers*, *Model Proxies*, and *APIs*, open *Instances* to create managed or unmanaged deployments that match your needs. Managed instances on Omni Gateway give stronger governance and monitoring when the new experience exposes them. *Gateways* don't include an *Instances* tab. -. Configure policies -+ -On the *Policies* tab for a service or instance, apply governance policies that match access control, data privacy, performance, and compliance goals. Use *Governance* for gateway-wide policy work, organization strategies, and cost tools. -. Review compliance -+ -On *Agents*, *APIs*, and *MCP Servers*, open *Conformance Report* to review scores, violations, and warnings, then address the findings your governance team prioritizes. For gateways, use *Governance* for the same compliance story at the scope the new experience supports. -. Monitor runtime health -+ -On *Monitoring*, review live metrics such as latency, error rates, and request volume when the new experience surfaces Omni Gateway data for managed paths. Compare what you see with dashboards, reports, or notifications under *Observability* when your administrator enabled those views for your team. -. Manage cost -+ -Under *Governance*, open *Cost Management* to study token usage and related spend signals. Apply the cost reduction strategies your organization adopted, such as tool mapping or tool sanitization, where the new experience supports them. -. Operate and tune the portfolio -+ -Coordinate agents, APIs, gateways, MCP servers, and Model proxies so traffic, policies, and integrations stay aligned. Open *Versions* when you need configuration history before you change instances or policies. Adjust policies, instances, or registrations when monitoring and governance insights show drift or new risk. -. Improve on each cycle -+ -Feed findings from monitoring and governance back into planning for the next change window. -//// - -== See Also - -* xref:exp-overview.adoc[] -* xref:exp-compare.adoc[] diff --git a/modules/ROOT/pages/exp-instances-add.adoc b/modules/ROOT/pages/exp-instances-add.adoc deleted file mode 100644 index 8ee7f08a3..000000000 --- a/modules/ROOT/pages/exp-instances-add.adoc +++ /dev/null @@ -1,67 +0,0 @@ -= Creating and Managing Instances of Services -:keywords: api instances, apis catalog, create instance, manage instances, anypoint platform, api management, instance configuration - -Instances represent how a service runs in a specific environment, such as production or sandbox, and how traffic reaches it through gateways or runtimes your organization manages. - -Services such as APIs, agents, MCP servers, and Model proxies can include instances. In the enhanced experience, you manage instances from the service detail page through the *Instances* tab. - -Managed paths through Anypoint Omni Gateway can provide additional policy and monitoring integrations if your organization supports them. Unmanaged or external paths remain available when they align with your operating model. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* These permissions: -+ --- -** API Manager: API Creator to create instances. -** API Manager: View APIs Configuration to view instances. -** API Manager: Edit APIs Configuration to edit instances. --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Open the Service Catalog - -. In *Portfolio*, open the catalog for the service type, such as *APIs*, *Agents*, *MCP Servers*, or *Model Proxies*. -. Select a service to open its detail page. -. Open the *Instances* tab. - -Field names, required metadata, and available gateway or runtime options depend on the selected service type and your organization's configuration. - -== Create an Instance - -. In the *Instances* tab, click *Add Instance*. -. Select the instance type: -+ --- -* *Managed Instance* – Creates a new instance on an Omni Gateway with full support for authentication, monitoring, and policy enforcement. -* *Unmanaged Target* – Creates a basic record of an API endpoint. You can add management for this endpoint later. --- -. Complete the *Instance* fields: -+ --- -** *Environment* – Select the environment where the instance runs, such as Sandbox or Production. -** *Omni Gateway* – Select the gateway to route traffic through. Required for managed instances. -** *Version* – Select the API version for this instance. -** *Label* – Optional label to identify the instance. --- -. Under *Target*, enter the *Target URL* where the instance proxies requests. -. Click *Create Instance*. - -== After Creating or Updating an Instance - -After creating or updating an instance, you can continue managing the service through related areas of the experience. - -* Use the *Policies* tab to review or apply policies to the instance. If the instance uses a Kong gateway, applying a policy targets the gateway level and protects all services in that gateway. -* Use the *Monitoring* tab to review metrics and runtime performance when monitoring is available. -* Coordinate with platform owners if DNS, certificates, or upstream routing changes must happen outside the product. - -== See Also - -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-register-manually.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-services-monitoring.adoc[] diff --git a/modules/ROOT/pages/exp-overview.adoc b/modules/ROOT/pages/exp-overview.adoc deleted file mode 100644 index a27692f30..000000000 --- a/modules/ROOT/pages/exp-overview.adoc +++ /dev/null @@ -1,62 +0,0 @@ -= Enhanced MuleSoft Experience Overview -:keywords: enhanced mulesoft experience, enhanced experience, capabilities, workflow, mulesoft overview, experience features - -To grow and tune your AI portfolio, register and monitor agents, APIs, and gateways in centralized catalogs. Sign in through the entry point your organization provides, such as Anypoint Platform or a direct URL, to access dashboards and governance strategies based on your assigned permissions. Review live performance metrics, manage security policies, and track rule-level compliance through automated conformance reports. - -Your AI services stay audit-ready with clear visibility into cost and runtime health across your org. - -== Enhanced Experience Capabilities - -The enhanced MuleSoft experience supports the full lifecycle of AI-connected integration services: - -Entity Management:: Register and manage agents, REST and GraphQL APIs, MCP servers, Model proxies, and gateways, including Anypoint Omni Gateway, external gateways, and unmanaged gateways. Each type has a dedicated catalog under *Portfolio*. - -Governance and Compliance:: Define and apply policies across domains such as access and security, performance and cost, data privacy and integrity, and compliance and observability. Conformance reporting summarizes rule violations and severity so you can close gaps systematically. - -Cost and Performance Optimization:: Monitor token usage, per-instance signals, and daily cost where the product exposes them. Apply governance strategies and related controls, such as tool mapping and tool sanitization, to reduce spend and risk where the experience supports them. - -Instance Management:: Create and review instances for supported asset types. Choose managed paths through Omni Gateway when you need deeper monitoring and policy enforcement, or choose lighter models when that matches your operating model. - -AI Assistant (MuleSoft Agent):: Get help navigating, searching, and managing your portfolio through natural language conversations. The AI assistant provides context-aware guidance, performs actions with your confirmation, and suggests next steps based on your current task. Available from every page in the enhanced experience. - -== Enhanced Experience High-Level Workflow - -To manage and tune your AI portfolio, register services, apply security policies, and monitor runtime health, access centralized catalogs to track agents and gateways while verifying compliance through conformance reports and cost management tools. These integrated features help you optimize performance and maintain audit readiness across your environment. - -. Complete onboarding and access the enhanced experience. -+ -Confirm your credentials and the permissions that your administrator assigned, as described in xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. Finish integration setup for supporting systems, such as connected providers under *Platform* > *Providers*, before you rely on the experience in production. For onboarding details, see xref:exp-home-start.adoc[]. -. Learn the layout of the enhanced experience. -+ -Sign in through your entry path and land on *Home*. Scan *Portfolio* catalogs, *Governance*, *Observability*, and *Platform* so that you know where to register services, apply policies, read health signals, and manage providers. For more information about portfolio views, see xref:exp-portfolio-overview.adoc[]. -For AI assistant usage, see xref:exp-ai-assistant-use.adoc[]. -. Register services in *Portfolio*. -+ -Under *Portfolio*, open *Agents*, *MCP Servers*, *Model Proxies*, *APIs*, or *Gateways*. Add services to work with. Register them manually or use connected providers under *Platform* > *Providers* if your organization enables discovery flows. For registration methods, see xref:exp-services-add-to-portfolio.adoc[]. -. Create and manage instances. -+ -In *Portfolio*, open a service detail page from *Agents*, *MCP Servers*, *Model Proxies*, or *APIs*, then open the *Instances* tab to create managed or unmanaged deployments that match your needs. Managed instances on Omni Gateway give stronger governance and monitoring when the new experience exposes them. *Gateways* don't include an *Instances* tab on their detail page. For instance workflows, see xref:exp-instances-add.adoc[]. -. Configure policies. -+ -On a service detail page in *Portfolio*, open the *Policies* tab for the service or one of its instances to apply governance policies that match access control, data privacy, performance, and compliance goals. Use top-level *Governance* for gateway-wide policy work, organization strategies, and cost tools. For governance policy workflows, see xref:exp-governance-work-with-strategies.adoc[]. -. Review compliance. -+ -In *Portfolio*, open a service detail page from *Agents*, *APIs*, or *MCP Servers*, then open the *Conformance Report* tab to review scores, violations, and warnings and address the findings your governance team prioritizes. For gateways, use top-level *Governance* for the same compliance story at the scope the experience supports. For service-level tabs and conformance context, see xref:exp-services-view-details.adoc[]. -. Monitor runtime health. -+ -On a service detail page in *Portfolio* (*Agents*, *APIs*, *MCP Servers*, or *Model Proxies*), open the *Monitoring* tab to review live metrics such as latency, error rates, and request volume when the new experience surfaces Omni Gateway data for managed paths. Compare those service-level metrics with dashboards, reports, or notifications under top-level *Observability* when your administrator enabled those views for your team. For monitoring workflows, see xref:exp-services-monitoring.adoc[]. -. Manage costs. -+ -Under *Governance*, open *Cost Management* to study token usage and related spend signals. Apply the cost reduction strategies your organization adopted, such as tool mapping or tool sanitization, where the new experience supports them. For cost and token usage details, see xref:exp-governance-view-cost-and-token-usage.adoc[]. -. Operate and tune the portfolio. -+ -Coordinate agents, APIs, gateways, MCP servers, and Model proxies so traffic, policies, and integrations stay aligned. Open *Versions* when you need configuration history before you change instances or policies. Adjust policies, instances, or registrations when monitoring and governance insights show drift or new risk. For service detail workflows, see xref:exp-services-view-details.adoc[]. -. Improve on each cycle. -+ -Feed findings from monitoring and governance back into planning for the next change window. For strategy refinement workflows, see xref:exp-governance-work-with-strategies.adoc[]. - -== See Also - -* xref:exp-home-start.adoc[] -* xref:exp-compare.adoc[] -* xref:learning-map-exp.adoc[] diff --git a/modules/ROOT/pages/exp-playground-api.adoc b/modules/ROOT/pages/exp-playground-api.adoc deleted file mode 100644 index 89ca1f088..000000000 --- a/modules/ROOT/pages/exp-playground-api.adoc +++ /dev/null @@ -1,85 +0,0 @@ -= Testing APIs in the API Playground -:keywords: api playground, test api, api endpoints, api authentication, request snippet, api response, anypoint platform, enhanced experience - -Use the API playground to explore an API's endpoints, configure and send requests, and inspect responses from the service detail page. Instead of copying paths into an external tool such as Postman, you exercise the API in the enhanced experience and see the results next to its documentation. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Viewer -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Open the API Playground - -The API playground is available only for REST APIs that have at least one instance deployed. To find a compatible API, filter the catalog by REST API or select a REST API you know. - -. In *Portfolio*, open the *APIs* catalog and select the REST API you want to test. -. On the service detail page, select the *Playground* tab. - -The playground shows the endpoint list on the left. Each endpoint has its own required parameters and configuration. - -== Select an Endpoint and Environment - -. In the endpoint list, select the endpoint you want to test (for example, a *POST* endpoint that creates a new record). -. Select the version and instance to choose the environment you want to test against. - -== Configure Authentication - -Before sending a request, authenticate to the API. The available methods depend on what the API owner enabled. - -. In the authentication section, select an authentication method. If the API owner enabled only one method (for example, API key), use that method. -. Enter the required values, such as the API key. - -== Configure the Request - -After authenticating, configure the details of the request: - -Body:: -+ -Configure the request body in the format the endpoint expects, such as JSON, XML, form, or multipart. Multipart supports file upload. - -Parameters:: -+ -Add and configure request parameters. - -Headers:: -+ -Add and configure request headers. - -=== Copy the Request Snippet - -The playground generates a request snippet that reflects your current configuration. As you change the authentication, body, parameters, or headers, the snippet updates to match. - -. Select the format you want for the snippet. -. Copy the snippet to use it outside the playground. - -== Send the Request and Review the Response - -. After configuring the request, select *Send*. -. Review the response: -+ --- -* *Status code*, along with the response size and speed. -* *Response body*. -* *Response headers*, which you can copy. --- - -== Review Request History - -After you test several requests or endpoints within an API, the playground keeps a history of your configurations. Open the history to review a previous request or return to an earlier configuration. - -== See Also - -* xref:exp-playground-overview.adoc[] -* xref:exp-playground-mcp.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-instances-add.adoc[] diff --git a/modules/ROOT/pages/exp-playground-mcp.adoc b/modules/ROOT/pages/exp-playground-mcp.adoc deleted file mode 100644 index cfba301a6..000000000 --- a/modules/ROOT/pages/exp-playground-mcp.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= Exploring MCP Server Tools in the MCP Playground -:keywords: mcp server playground, test mcp server, mcp tools, tool invocation, anypoint platform, enhanced experience - -Use the MCP server playground to understand what an MCP server does and how it behaves without connecting it to an external tool such as Postman, the MCP Inspector, or Claude Desktop. Instead of reading only the overview and documentation, you explore the server's tools, invoke them, and see what they return, directly on the service detail page. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Viewer -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Open the MCP Server Playground - -. In *Portfolio*, open the *MCP Servers* catalog and select the MCP server you want to test. -. On the service detail page, select the *Playground* tab. - -== Inspect and Invoke Tools - -The playground lists the tools inside the MCP server so you can explore each tool's functionality and description. - -. In the tool list, select the tool you want to test. -. If you aren't already authenticated to the MCP server, configure authentication. If you're already authenticated, you don't need to authenticate again. -. Configure the tool's parameters in form or JSON format. -. (Optional) Copy the request snippet, which reflects your configuration. -. Select *Execute* to invoke the tool. -. Review the response, including the status code and the full JSON response body. - -If required parameters are missing or validation fails, the playground shows an error or an explanation of the failure. - -== See Also - -* xref:exp-playground-overview.adoc[] -* xref:exp-playground-api.adoc[] -* xref:exp-services-create-mcp-server.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-claude-desktop-connect.adoc[] diff --git a/modules/ROOT/pages/exp-playground-overview.adoc b/modules/ROOT/pages/exp-playground-overview.adoc deleted file mode 100644 index 0533e2a05..000000000 --- a/modules/ROOT/pages/exp-playground-overview.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= Testing Services with Playgrounds -:keywords: playground, api playground, mcp server playground, test api, test mcp server, anypoint platform, enhanced experience - -Use the playground to try services in your portfolio directly in the enhanced experience—no external tools required. Explore endpoints and tools, configure and send requests, and inspect responses without leaving the service detail page. - -Before the playground, understanding a service meant reading its overview and documentation, then copying paths into an external tool such as Postman or the MCP Inspector to see how it behaved. The playground brings that testing loop into the enhanced experience so you can go from reading about a service to exercising it in the same view. - -== Playground Types - -The playground adapts to the type of service you open: - -API playground:: -+ -Test an API by exploring its endpoints, configuring authentication and requests, sending calls, and inspecting responses. Serves a similar purpose to the API Console in Anypoint Platform, embedded in the enhanced experience UI. See xref:exp-playground-api.adoc[]. - -MCP server playground:: -+ -Test an MCP server by exploring and invoking individual tools and inspecting their responses. See xref:exp-playground-mcp.adoc[]. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Viewer -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Open the Playground - -. In *Portfolio*, open the catalog for the service type (for example *APIs* or *MCP Servers*). -. Use the search box to find the service by name or description, or scan the list or grid. -. Select the service to open its detail page. -. Select the *Playground* tab. - -The playground opens with the endpoints or tools available for the service you're viewing. - -== See Also - -* xref:exp-playground-api.adoc[] -* xref:exp-playground-mcp.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-instances-add.adoc[] diff --git a/modules/ROOT/pages/exp-portfolio-overview.adoc b/modules/ROOT/pages/exp-portfolio-overview.adoc deleted file mode 100644 index 7b9bf2f3e..000000000 --- a/modules/ROOT/pages/exp-portfolio-overview.adoc +++ /dev/null @@ -1,40 +0,0 @@ -= View Your Portfolio Overview -:keywords: portfolio overview, anypoint platform, api management, integration monitoring, portfolio dashboard, mulesoft - -Use portfolio-level views to see how your agents, APIs, MCP servers, Model proxies, and gateways fit together before you drill into a single service. These summaries help you spot gaps in registration, policy coverage, and health signals. - -The exact layout depends on how your administrator configured your tenant and which catalogs they enabled. -include::_partials/exp-navigation-labels.adoc[tag=ExpNavigationLabels] - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Viewer -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Access Portfolio Overview - -* *Home* -+ -After you log in, *Home* shows an overview of services discovered, consumed, and governed, as well as a list of scanners and actions to add a service. -* *Portfolio* -+ -Browse catalogs for *Agents*, *APIs*, *MCP Servers*, *Model Proxies*, and *Gateways* in *Portfolio*. Each catalog lists the services that your team registered or imported. To find a specific service, use search and filters, and then select the service to view its details. - -If you don't see an expected catalog or summary, confirm product access and permissions with your Anypoint Platform organization administrator. See xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] for more information. - -== See Also - -* xref:exp-overview.adoc[] -* xref:exp-home-start.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-providers-manage.adoc b/modules/ROOT/pages/exp-providers-manage.adoc deleted file mode 100644 index a685cc892..000000000 --- a/modules/ROOT/pages/exp-providers-manage.adoc +++ /dev/null @@ -1,112 +0,0 @@ -= Viewing and Managing Provider Connections -:keywords: providers, scanners, providers page, provider list, view providers, manage providers, anypoint platform - -The *Providers* page shows which cloud platforms and API management systems are connected to the enhanced experience. From *Platform* > *Providers*, you can view connected providers, filter scanners by provider, and connect new providers to begin discovering services. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* Any of these permissions: -+ --- -** Exchange: Exchange Administrator -** Exchange: Exchange Contributor -** API Manager: API Creator -** API Manager: Manage Policies --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Access the Providers Page - -. Sign in to the enhanced experience through your organization's entry point. -. In the navigation, select *Platform* > *Providers*. - -The *Providers* page displays the provider list and scanner list. - -=== Provider List - -The side panel shows providers organized into two groups: - -Connected:: -Providers that have active scanner connections. Each connected provider card shows the provider name, logo, number of discovered services, and number of configured scanners. - -Not Connected:: -Providers available for connection but not yet configured. Select a not-connected provider to begin the scanner setup workflow. The workflow guides you through the process of connecting the provider and configuring the scanner. - -=== Scanners List - -Select *All Providers* to view all scanners across all connected providers. The main panel displays the scanner list. - -The scanner list shows: - -* *Scanner Name*: The scanner identifier and provider platform -* *Services*: Count of services discovered by this scanner -* *Last Scanned*: Time since the last successful scan -* *Scan Trigger*: Schedule type (Scheduled, Manual, or On-Demand) - -== Filter Scanners by Provider - -To view scanners for a specific provider, select the provider from the sidebar. The scanner list updates to show only scanners configured for that provider. - -== View Scanner Details - -To see detailed information about a scanner, including scan history, activity log, and configuration, select the scanner name in the scanner list. The scanner detail page includes *Overview*, *Services*, and *Settings* tabs. - -For detailed tab behavior and scanner-type differences, see xref:exp-scanners-view-details.adoc[]. - -For information about managing scanners, see xref:exp-scanners-manage.adoc[]. -For Akamai-specific setup and result interpretation, see xref:exp-akamai-risk-correlation.adoc[]. - -== Connect a New Provider - -To add a provider connection: - -. From *Platform* > *Providers*, select a provider from the *Not Connected* section. -. Follow the connection workflow to authenticate and configure scanner settings. The wizard walks through three steps: *Choose Provider*, *Connect to Provider*, and *Connection Setup*. - -For detailed scanner setup instructions, see xref:exp-scanners-add-from-providers.adoc[]. - -== Akamai API Security Data in Portfolio - -When Akamai API Security is connected and scans have completed, security risk data appears on the detail pages of scanned APIs: - -* A *Security Risk* column in the *Instances* tab shows a color-coded risk level per instance: Low, Medium, High, or Critical. -* An *Akamai* section in the *Conformance Report* tab shows full findings and incidents from the scan. - -In list and card views, the numeric value shows Akamai correlation policy coverage (applied policies compared to total required policies), while the color-coded *Security Risk* label (Low, Medium, High, or Critical) shows the severity level of correlated security findings. - -== Supported Providers - -The enhanced experience supports connections to these providers: - -* Akamai -* Amazon -* Anthropic -* Databricks -* GoDaddy -* Google -* Kong -* LangChain -* Microsoft -* Snowflake - -[NOTE] -==== -When scanning Kong, the enhanced experience discovers gateway-level plugin information in addition to services. - -*Akamai API Security* is available only when your administrator has enabled the feature for your organization. When enabled, it appears in the *Not Connected* section of the Providers sidebar. -==== - -The specific providers available depend on your organization's enabled products and enhanced experience configuration. - -== See Also - -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-akamai-risk-correlation.adoc[] -* xref:exp-scanners-view-details.adoc[] -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-scanners-manage.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] diff --git a/modules/ROOT/pages/exp-release-notes.adoc b/modules/ROOT/pages/exp-release-notes.adoc deleted file mode 100644 index db9ebdce3..000000000 --- a/modules/ROOT/pages/exp-release-notes.adoc +++ /dev/null @@ -1,2 +0,0 @@ -:keywords: experience hub release notes, api experience hub, new features, bug fixes, known issues, version history, mulesoft experience hub -include::release-notes::partial$enhanced-mulesoft-experience/enhanced-mulesoft-exp-rn-landing-page.adoc[] diff --git a/modules/ROOT/pages/exp-scanners-add-from-providers.adoc b/modules/ROOT/pages/exp-scanners-add-from-providers.adoc deleted file mode 100644 index 1fedbdaef..000000000 --- a/modules/ROOT/pages/exp-scanners-add-from-providers.adoc +++ /dev/null @@ -1,101 +0,0 @@ -= Adding Scanners from Providers -:keywords: scanners, providers, add scanner, scanner configuration, workflow, anypoint platform, security scanning - -A scanner is the configured link between the system and a supported cloud provider that lets discovery jobs find services—such as APIs, agents, and MCP servers—and register them in the right *Portfolio* catalogs, and to discover and read policies from API configurations. Scanners enable automated discovery so your catalogs stay current without manual registration. Configure a scanner once to turn on discovery for a provider, then extend it as your organization adds catalogs or enabled features. - -For how provider connection and catalogs fit together, see xref:exp-services-connect-providers-to-add.adoc[] and xref:exp-services-add-to-portfolio.adoc[]. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* Any of these permissions: -+ --- -** Exchange: Exchange Administrator -** Exchange: Exchange Contributor -** API Manager: API Creator -** API Manager: Manage Policies --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. -For provider-specific roles, credentials, and permission scopes, see xref:exp-scanners-prerequisites-reference.adoc[]. - -== Benefits of Provider Scanners - -* Keep catalogs current -+ -New and changed services in the provider appear in the system without manually re-entering each registration. -* Centralize visibility -+ -Discovered services appear 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. - -* Policy-visibility -+ -When a scanner is enabled, it can discover and read policies from API configurations. This allows the system to enforce policies on the discovered services. This is especially useful for API-based policies, such as web application firewall (WAF) policies. - -== Workflow Entry Points for Adding a Scanner - -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 if your navigation includes it. Add or refine scanners alongside other provider work. -+ -The Akamai API Security scanner doesn't import services; it scans third-party provider security policies and surfaces vulnerability findings for related APIs, agents, and MCP services already in *Portfolio* catalogs. -* *Portfolio* -+ -Open the catalog that matches the service type you want (*Agents*, *APIs*, *MCP Servers*, and others your tenant supports). Use that catalog's add control—the label indicates the type (for example *Add API*)—then choose provider connection to scan and discover services to add to that catalog. Not all services have a catalog. If the service doesn't have a catalog, you can still add it to the system by using the *Add Service* button on the *Providers* page. - - -include::_partials/exp-navigation-labels.adoc[tag=ExpNavigationLabels] - - -== Akamai API Security Scanner - -The Akamai API Security scanner behaves differently from import-based scanners. It doesn't discover and import services from third-party providers into *Portfolio* catalogs. Instead, it scans third-party provider security policies and observed security data, correlates those results to existing services, and surfaces risk scores and vulnerability findings in related *Portfolio* catalogs. *Akamai API Security* appears in the provider list only when your administrator has enabled the Akamai API Security feature for your organization. - -When you save an Akamai API Security scanner, the system automatically starts *Akamai Correlation Policy* application. This policy is required for Akamai to attribute security findings to your MuleSoft APIs by stamping correlation headers on API responses. - -For setup details, policy behavior, and result interpretation, see xref:exp-akamai-risk-correlation.adoc[]. - -=== Monitor Correlation Policy Status - -After creating an Akamai scanner, the scanner detail page shows an *Akamai Correlation Policy* section with the live policy application status: - -* *Correlation policy not applied* — amber warning with an *Apply policy now* button. -* *Partial* — a progress indicator showing how many environments are covered while the apply workflow runs. -* *Applied* — green badge confirming all environments are covered. - -When the policy is applied, the section shows a table with one row per environment and runtime combination. The table includes columns for Environment, Runtime (Omni Gateway or Mule 4), Status (Applied or Disabled), APIM Policy ID, and Asset Version. - -If some environments show no policy binding, select *Check again* to retry the policy application for those environments only. The operation is safe to repeat. - -== Scanner Configuration Overview - -Regardless of entry point, adding a scanner establishes trust and scope. You specify which provider platform to reach, how the system authenticates, and how you validate connectivity. You also name and schedule the scanner—or configure another trigger—so discovery runs on the cadence your team expects. Saving the configuration activates the scanner for the catalogs and features your administrator enabled. - -== After the Scanner Runs - -When the scanner is active, it applies discovery results 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 API scanners, policy-read results are visible from each discovered API in *Portfolio* > *APIs* > *Policies*. This includes read policies from Amazon API Gateway, Google Apigee, Azure API Management, and Kong Gateway. Use this view to verify imported controls and confirm scanner coverage by provider. - -For ongoing operations (pause, edit, or delete), see xref:exp-scanners-manage.adoc[]. - -== See Also - -* xref:exp-scanners-prerequisites-reference.adoc[] -* xref:exp-akamai-risk-correlation.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-scanners-prerequisites-reference.adoc[] -* xref:exp-scanners-manage.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-scanners-manage.adoc b/modules/ROOT/pages/exp-scanners-manage.adoc deleted file mode 100644 index 7398c5f19..000000000 --- a/modules/ROOT/pages/exp-scanners-manage.adoc +++ /dev/null @@ -1,35 +0,0 @@ -= Running and Managing Scanners -:keywords: scanners, managing scanners, scanner actions, security scanning, mulesoft, vulnerability detection - -Scanners typically run on a schedule you or an administrator configured, or manually when you start a scan. After you configure scanners, you run them day to day. Most of that work happens under *Providers*, where you manage provider connections, scanners, and scan activity in one place. - -== Scanner Actions - -* *Run Discovery Scan* -+ -Start a manual scan when you want fresh metadata without waiting for the next scheduled window. Successful runs update or add services in the matching *Portfolio* catalogs according to your rules. -* *View Scanner* -+ -Inspect connection health, the last completed run, and scan history to verify whether discovery is healthy, slow, or failing authentication. -* *Pause Scheduled Runs* -+ -Temporarily stop scheduled triggers when you need a quiet period—for example during maintenance or while you fix credentials—without deleting the scanner. -* *Resume Scheduled Runs* -+ -Re-enable scheduled scanning after a pause. -* *Scanner Settings* -+ -Change names, descriptions, credentials, provider scope, or scan-related settings your product exposes, then save, so future runs use the new definition. -* *Delete Scanner* -+ -Remove the scanner from *Providers* when the provider link is no longer authorized or useful. Consider the impact on discovered services in *Portfolio* and on dependent teams before you delete the scanner. -+ -NOTE: When you delete an Akamai API Security scanner, the system attempts to remove the Akamai correlation policy from the scanner's environments. If the removal fails, the correlation policy may remain applied; check *Automated Policies* to verify. Discovered services remain in your portfolio regardless. - - -== See Also - -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-scanners-prerequisites-reference.adoc b/modules/ROOT/pages/exp-scanners-prerequisites-reference.adoc deleted file mode 100644 index f09f75f74..000000000 --- a/modules/ROOT/pages/exp-scanners-prerequisites-reference.adoc +++ /dev/null @@ -1,224 +0,0 @@ -= Scanner Prerequisites by Provider -:keywords: scanner prerequisites, exchange scanners, provider scanners, required roles, required credentials, scanner setup - -Scanner prerequisites by provider help you confirm required roles, credentials, and permissions before creating a scanner. Use this reference to prevent connection test failures and incomplete discovery by validating provider-specific access in advance. Each scanner also requires Exchange Administrator permission and the correct business group context. - -== Before You Begin - -Before adding any scanner, make sure you have: - -* Exchange Administrator permission. -* Access to, and active context in, the business group where you want to add the scanner. - -== Scanner Prerequisite Matrix - -[cols="1,1,3",options="header"] -|=== -| Provider -| Scanner Type -| Required Credentials, Roles, and Setup - -| Amazon Bedrock -| Agent -a| -*Credentials:* Access key ID and secret access key; AWS region - -*Permissions:* - -* `bedrock:ListAgents` -* `bedrock:GetAgent` -* `bedrock:ListAgentAliases` -* `bedrock:GetAgentAlias` -* `bedrock:ListAgentVersions` -* `bedrock:GetAgentVersion` - -*Optional (for agent invocation workflows):* - -* `bedrock:InvokeModel` -* `bedrock:InvokeAgent` -* `bedrock:InvokeInlineAgent` - -*Setup:* Agents must have an alias linked to a version and an invocable URL - -| Amazon Bedrock AgentCore Runtime -| Agent -a| -*Credentials:* Access key ID and secret access key; AWS region - -*Account:* Active AWS account with AgentCore access - -*Permissions:* - -* `bedrock-agentcore:ListAgentRuntimes` -* `bedrock-agentcore:ListAgentRuntimeEndpoints` -* `bedrock-agentcore:GetAgentCard` -* `bedrock-agentcore:GetAgentRuntime` -* `bedrock-agentcore:ListAgentRuntimeVersions` -* `bedrock:GetAgent` -* `bedrock:ListAgents` - -*Setup:* Agents must be published with an active endpoint/version - -| Anthropic Claude Managed Agents -| Agent -a| -*Credentials:* Claude API key - -*Account:* Paid Anthropic account - -| Databricks Agent Bricks -| Agent -a| -*Credentials:* Workspace URL; client ID and client secret - -*Account:* Databricks workspace access - -*Permissions:* Service principal `CAN_QUERY` on serving endpoints; `CAN_VIEW` or higher on endpoint metadata APIs - -*Setup:* Discoverable agents must be custom Unity Catalog models in `READY` state - -| GoDaddy ANS -| Agent -a| -*Credentials:* API key and API secret - -| Google Gemini Agent Enterprise Platform -| Agent -a| -*Credentials:* GCP project ID; service account email; private key - -*Role:* Vertex AI Viewer - -| LangChain LangSmith -| Agent -a| -*Credentials:* LangSmith API key; LangSmith workspace ID - -*Account:* LangSmith Plus plan (or higher) workspace - -*Setup:* Optional API host for region routing (for example, US or EU cloud host) - -| Microsoft Azure Copilot -| Agent -a| -*Credentials:* Azure app registration; tenant ID, client ID, client secret - -*Role:* Copilot Studio Scanner - -*Setup:* App added as an Application User in Power Platform; scope set to Dataverse environment URL, `\https://.crm.dynamics.com` - -| Microsoft Foundry -| Agent -a| -*Credentials:* Azure app registration; tenant ID, client ID, client secret - -*Account:* Active Azure subscription - -*Role:* Azure AI Developer - -*Setup:* Project endpoint URLs (discovery is project-specific) - -| Snowflake Cortex AI -| Agent -a| -*Credentials:* Snowflake account URL; programmatic access token (PAT) - -*Account:* Snowflake account with Cortex Agents enabled (Enterprise edition) - -*Role:* `ACCOUNTADMIN`, for one-time setup only - -*Setup:* At least one Cortex Agent created in a schema to be scanned; scanner egress IP ranges from your Anypoint deployment team (``) - -| Amazon API Gateway -| API -a| -*Credentials:* Access key ID and secret access key; AWS region - -*Permissions:* IAM read-only policy for API Gateway: - -* *Read permission:* `apigateway:GET` -* *Read action group:* `apigateway:GET*` on REST and HTTP API resources -* *Resource scope (REST APIs):* `arn:aws:apigateway:{region}::/restapis/*` -* *Resource scope (HTTP APIs):* `arn:aws:apigateway:{region}::/apis/*` - -[NOTE] -For web application firewall (WAF) policies, the scanner also uses `software.amazon.awssdk:wafv2` and `software.amazon.awssdk:route53`. - -| Azure API Management -| API -a| -*Credentials:* Tenant ID; client ID; client secret; subscription ID; resource group; service name - -*Role:* API Management Service Reader - -* *Read role scope:* API Management Service Reader at the API Management resource or resource group scope -* *Read OAuth scope:* `https://management.azure.com/.default` - -| Google Apigee -| API -a| -*Credentials:* GCP project ID; service account email; private key - -*Role:* Apigee Read-only Admin - -* *Read role:* Service account with the Viewer role, or an Apigee permission role with equivalent read access - -| Kong Gateway -| API -a| -*Credentials:* Personal access token (PAT); Kong Gateway region - -*Role:* Kong Control Plane Viewer - -* *Apply read scope:* Admin API read permission required to read policy in target environments - -| Akamai Security -| API Security -a| -*Credentials:* Akamai Security base URL; client ID and client secret - -*Permissions:* Access to create service accounts in Akamai Security; access to apply Akamai correlation policy in target environments - -*Setup:* Existing services in *Portfolio* catalogs for correlation targets; create a connected app in MuleSoft; configure Akamai-side sync with the MuleSoft connected app. For details, see xref:exp-akamai-risk-correlation.adoc[]. - -| Amazon Bedrock AgentCore MCP -| MCP -a| -*Credentials:* Access key ID and secret access key; AWS region - -*Account:* Active AWS account - -*Permissions:* IAM user with an inline policy that allows: - -* `bedrock-agentcore:ListAgentRuntimes` -* `bedrock-agentcore:GetAgentRuntime` -* `bedrock-agentcore:ListAgentRuntimeVersions` -* `bedrock-agentcore:ListAgentRuntimeEndpoints` -* `bedrock-agentcore:InvokeAgentRuntime` - -*Policy read permissions:* Runtime read actions, including `bedrock-agentcore:ListAgentRuntimes` and `bedrock-agentcore:GetAgentRuntime` - -| Azure API Management MCP Server -| MCP -a| -*Credentials:* Tenant ID; client ID; client secret; subscription ID; resource group; service name - -*Role:* API Management Service Reader - -| Snowflake MCP Server -| MCP -a| -*Credentials:* Snowflake account URL; programmatic access token (PAT) - -*Account:* Snowflake Enterprise account with MCP servers enabled - -*Role:* `ACCOUNTADMIN` - -|=== - -== See Also - -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-providers-manage.adoc[] -* xref:exp-scanners-manage.adoc[] -* xref:exp-akamai-risk-correlation.adoc[] diff --git a/modules/ROOT/pages/exp-scanners-view-details.adoc b/modules/ROOT/pages/exp-scanners-view-details.adoc deleted file mode 100644 index e1f3b1595..000000000 --- a/modules/ROOT/pages/exp-scanners-view-details.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= Viewing Scanner History and Settings -:keywords: scanner detail tabs, scanner overview tab, scanner services tab, scanner settings tab, provider scanners - -View details about a scanner and its scan history by selecting a configured scanner from the provider list. Scanner details show information about the provider, when it was created, last completed scan, and scan history. After you select a configured scanner, use the *Overview*, *Services*, and *Settings* tabs to review scanner state and configuration. Tab content varies by scanner type and provider capabilities. - -== Open Scanner Detail Tabs - -. From *Platform* > *Providers*, open a connected provider. -. Select a configured scanner from the scanner list. -. Use the tabs to review scanner results and configuration. - -== Overview Tab - -Use *Overview* to check scanner summary information, such as: - -* Services and instances counts. -* Scan history and run status. -* Last scan time and scanner health indicators. -* Activity Log with a real-time timeline of scan progress events. - -For Akamai API Security scanners, the overview represents correlation and security enrichment activity for existing services. Akamai scanners don't import new services. - -When a scan starts, the *Activity Log* appears between *Scan Details* and *Scan Results*. It's a real-time timeline of the events a scanner run emits, such as connecting to the provider, resolving credentials, processing pages, and completing the scan. Each entry shows a timestamp, a log level (`INFO` or `DEBUG`), and a message. The log also reports the total event count. - -* Log detail: -+ -By default, the log includes `DEBUG` entries. Select *Hide Debug* to show only `INFO` events; select it again to show `DEBUG` events. -* Audit trail: -+ -When you view scan history, the Activity Log shows which assets were added and which already existed (for example, `5 discovered, 5 added`). - -== Services Tab - -Use *Services* to review services linked to the scanner and open service details for investigation. The tab reflects scanner-managed output for those services. - -For import scanners, this tab reflects discovered services imported by scan runs. For Akamai API Security scanners, it reflects existing services associated with correlated security data. - -== Settings Tab - -Use *Settings* to review and update scanner configuration values, such as provider connection details, run schedule, and scanner metadata. You can also delete the scanner from this tab. - -== Tab Content by Scanner Type - -Import scanner:: -Shows imported discovery activity in scanner tabs, including newly discovered services. - -Akamai API Security scanner:: -Shows correlation and governance enrichment activity for existing services, including risk and findings signals. - -== See Also - -* xref:exp-providers-manage.adoc[] -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-akamai-risk-correlation.adoc[] -* xref:exp-scanners-manage.adoc[] diff --git a/modules/ROOT/pages/exp-services-add-to-portfolio.adoc b/modules/ROOT/pages/exp-services-add-to-portfolio.adoc deleted file mode 100644 index 3fea7422e..000000000 --- a/modules/ROOT/pages/exp-services-add-to-portfolio.adoc +++ /dev/null @@ -1,74 +0,0 @@ -= Adding Services to Your Portfolio -:keywords: add services, portfolio, service registration, service types, workflow, anypoint platform - -Your *Portfolio* is organized into catalogs: *Agents*, *MCP Servers*, *Model Proxies*, *APIs*, and *Gateways*. Each catalog holds the services (or gateway entries) your organization registered or imported for governance, monitoring, and deployment. Services enter a catalog through automated provider discovery or manual registration. For procedures, use the topics linked in each section. - -[cols="1,2",options="header"] -|=== -|Approach |What Happens - -|xref:exp-services-connect-providers-to-add.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:exp-akamai-risk-correlation.adoc[] -|The Akamai API Security scanner doesn't import or register services. It correlates Akamai security data to existing services and surfaces risk scores, findings, and incidents in catalog views. - -|xref:exp-services-register-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. -|=== - -Gateway creation starts in Anypoint Platform, which you can open from the enhanced MuleSoft experience. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator -** Exchange: Exchange Creator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Workflow Entry Points - -* *Home* -+ -Use *Add Services* to open provider connection or manual registration, then select the service type. -* *Portfolio* -+ -Open the *Agents*, *MCP Servers*, *Model Proxies*, *APIs*, or *Gateways* catalog. Use the add control for that type (for example, *Add API* or *Add Agent*), then select the available flow. For gateways, *Add Gateway* opens gateway creation in Anypoint Platform. - -include::_partials/exp-navigation-labels.adoc[tag=ExpNavigationLabels] - -== Service Type Registration Options - -*Agents*:: -Register by uploading an agent card or connect an agent provider scanner for discovery. - -*MCP Servers*:: -Register with an MCP URL or a schema file, or connect an MCP server provider. - -*Model Proxies*:: -Register manually by creating a model proxy with a routing strategy that routes requests by provider or semantic matching. - -*APIs*:: -Register with an API specification, or connect an API provider so scans import APIs into the *APIs* catalog. - -*Gateways*:: -Create gateways in Anypoint Platform. In the enhanced MuleSoft experience, select *Add Gateway* to open the Anypoint gateway creation flow. - -For more information about registering any of these types, see xref:exp-services-register-manually.adoc[] and xref:exp-services-connect-providers-to-add.adoc[]. - -== See Also - -* xref:exp-scanners-prerequisites-reference.adoc[] -* xref:exp-akamai-risk-correlation.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-services-register-manually.adoc[] -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-services-connect-providers-to-add.adoc b/modules/ROOT/pages/exp-services-connect-providers-to-add.adoc deleted file mode 100644 index 5f748e85f..000000000 --- a/modules/ROOT/pages/exp-services-connect-providers-to-add.adoc +++ /dev/null @@ -1,61 +0,0 @@ -= Create a Scanner for Provider Services -:keywords: scanner, provider services, create scanner, entry points, experience services, mulesoft integration, service discovery - -To create a scanner, connect to a provider. The system runs scanners against supported cloud platforms, discovers services (such as agents, APIs, and MCP servers), and registers them in the matching catalog in *Portfolio*. You supply credentials and scanner metadata so the integration is repeatable and auditable. - -Start the flow from *Home* or from a specific catalog in *Portfolio*. To see how this flow relates to manual registration, see xref:exp-services-add-to-portfolio.adoc[]. To create and tune scanners, see xref:exp-scanners-add-from-providers.adoc[]. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Administrator -** Exchange: Exchange Contributor -** API Manager: API Creator -** API Manager: Manage Policies --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== When to Use a Scanner - -Use a scanner when your team maintains services in an external platform and wants those services to appear automatically in portfolio catalogs after authentication and discovery, instead of registering each service manually. - -== Entry Points for Creating a Scanner - -* *Home* -+ -Use *Add Services*, select *Connect to Provider*, then work through the flow to pick a provider, validate access, and save scanner settings. Use this path when you're not starting from a single catalog view. -* *Portfolio* -+ -Open a supported service catalog in *Portfolio*. Use the add control for that service type (for example *Add API* or *Add MCP Server*), select *Connect to Provider*, and complete the same style of flow scoped to that catalog. - -Labels differ by catalog and release. Match what you see in the UI. - -== Create a Scanner - -Across *Home* and *Portfolio* entry points, scanner creation includes the same decisions: - -* Which provider or platform to target for discovery and import. -* Credentials and authentication so the system can reach the provider securely. -* Connection validation so you know discovery can run against live data. -* Scanner identity and settings: name, description, and options your administrator expects before you save the scanner. - -When the scanner runs successfully, the system registers discovered services in the catalog you started from (for example, APIs land in the *APIs* catalog). - -== How Catalog Selection Affects Registration - -Scanner setup decisions stay the same across catalogs. However, after successful runs, discovered results get registered in specific service catalogs. - -For example, when you start from *APIs*, discovered APIs are registered in the *APIs* catalog. - -== See Also - -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-register-manually.adoc[] -* xref:exp-scanners-add-from-providers.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-services-create-mcp-server.adoc b/modules/ROOT/pages/exp-services-create-mcp-server.adoc deleted file mode 100644 index 378839ff1..000000000 --- a/modules/ROOT/pages/exp-services-create-mcp-server.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= Create MCP Servers -:keywords: mcp server, create mcp server, model context protocol, anypoint platform, mcp configuration, api integration - -Create MCP servers to define identity, runtime connectivity, and the tools and resources exposed to MCP clients. - -Creating an MCP server defines a new MCP implementation—for example, by transcoding an existing REST API or creating a runtime deployment—and establishes the server identity, runtime connectivity, and the MCP capabilities (tools and resources) exposed to clients. - -When you create an MCP server in Enhanced Experience, the server is added to *Portfolio* automatically. - -During creation, you define: - -* *Service definition* -+ -Name, description, and ownership metadata so teams can identify the server in catalogs and governance views. -* *Connection and runtime details* -+ -Endpoint and access settings Enhanced Experience uses at runtime to connect to underlying SaaS systems. -* *Capability surface* -+ -The MCP tools and resources clients can discover and invoke. -* *Validation and readiness* -+ -Checks that confirm the server is reachable and that the declared MCP capabilities are usable. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these Exchange permissions: -+ --- -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator -** Exchange: Exchange Creator --- -* This API Manager permission on at least one environment: -+ -** API Manager: Manage APIs Configuration -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Create an MCP Server - -. Open *MCP Servers* and select *Add MCP Server* > *Create MCP Server*. -. In *Select Source, Instance & Tools*, select the APIs or SaaS systems you want to expose. Select the source instance or version, then select the tools to publish, including optional read-only filtering. Click *Next*. -. In *SaaS Credentials*, provide the credentials required for the selected sources so the MCP server can call them securely. Click *Next*. -. In *Review*, validate the selected sources, tools, and credential mappings, then complete creation. - -After saving, the MCP server is automatically added to the *MCP Servers* catalog in *Portfolio*. No additional action is required. - -== See Also - -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-register-manually.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-services-monitoring.adoc b/modules/ROOT/pages/exp-services-monitoring.adoc deleted file mode 100644 index 5c2734cec..000000000 --- a/modules/ROOT/pages/exp-services-monitoring.adoc +++ /dev/null @@ -1,55 +0,0 @@ -= Monitoring Services in Your Portfolio -:keywords: service monitoring, monitoring signals, access monitoring, mulesoft services, monitoring use cases, api monitoring - -Monitoring helps you see whether the services in your portfolio—and the paths that carry their traffic—are healthy, performant, and stable over time. You work from service context (what a single API, agent, MCP server, Model proxy, or gateway is doing) and, when your administrator enables it, from broader observability surfaces that sit alongside *Portfolio* and *Governance*. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* Any of these permissions: -+ --- -** Anypoint Monitoring: Monitoring Viewer -** Anypoint Monitoring: Monitoring Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Monitoring Use Cases - -* Spot regressions early. -+ -Compare latency, errors, and throughput (or equivalent signals the system exposes for your integration type) against what you expect after a release or policy change. -* Triage incidents. -+ -Correlate spikes or failures on a service with recent deployments, instances, or gateway paths your team manages. -* Support capacity and cost conversations. -+ -Use sustained load or usage patterns as inputs when you tune scaling, routing, or token-related spend with your platform owners. - -Exact metrics depend on how the service is hosted, which gateway or runtime path applies, and which observability backend your organization has connected. - -== Access Monitoring - -Monitoring appears in these areas of the experience: - -* *Home* — Your entry path sometimes highlights alerts or shortcuts back into *Portfolio* or *Observability*; use whatever your organization configured after sign-in. -* *Portfolio* and service detail — Open a catalog entry and use the *Monitoring* tab on the service (and, where the product exposes it, on instances) to read metrics scoped to that service. This is where you typically go when checking whether a specific API or agent is degrading. -* *Observability* — When your tenant includes it, *Observability* aggregates dashboards, reports, or notifications to compare service-level signals with organization-wide views your administrator configured. Use filters to narrow to the service, environment, or route you're investigating. - -include::partial$exp-navigation-labels.adoc[tag=ExpNavigationLabels] - -== Monitoring Signals - -The system emphasizes runtime health for managed integration paths—for example latency, error rates, and request volume when the new experience surfaces Omni Gateway data for routes your team operates under policy. Not every catalog type exposes the same charts; some services show richer series only after you complete instance setup or connect the observability backend your administrator approved. - -If a tab is missing, confirm with your administrator that monitoring data is flowing for that environment and that your account has the right permissions. - -== See Also - -* xref:exp-overview.adoc[] -* xref:exp-home-start.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] diff --git a/modules/ROOT/pages/exp-services-register-manually.adoc b/modules/ROOT/pages/exp-services-register-manually.adoc deleted file mode 100644 index 427687631..000000000 --- a/modules/ROOT/pages/exp-services-register-manually.adoc +++ /dev/null @@ -1,89 +0,0 @@ -= Register Services Manually -:keywords: register services manually, mcp servers, agents, service registration, mulesoft, anypoint platform, manual configuration - -Register a service to add it to your portfolio when you already have the metadata, specification, endpoint, or card required in Enhanced Experience, without running a provider scan. Start from *Home* or from the catalog for that service type in *Portfolio*. Completed registrations appear in the matching catalog. - -To learn how manual registration relates to provider connections, see xref:exp-services-add-to-portfolio.adoc[]. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator -** Exchange: Exchange Creator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Get Started - -* *Home* -+ -Open *Add Services*, select the service type, then, if it is available, select manual registration . -* *Portfolio* -+ -Open the *Agents*, *MCP Servers*, *Model Proxies*, or *APIs* catalog, use the add control for that type (for example *Add API*), and select *Register Manually*. - -To set up a gateway, select *Add Gateway* to open gateway setup in Anypoint Platform. -include::_partials/exp-navigation-labels.adoc[tag=ExpNavigationLabels] - -== Agents - -Register an agent by uploading an agent card file for an A2A or non-A2A agent. - -Manual registration does not support A2A or non-A2A connection routes, and the system does not validate a connection before creating the agent. - -== MCP Servers - -For MCP servers, define how the system reaches the server and validates runtime access: - -* *By MCP URL* — Connect over a URL and test the live server so tools and metadata can be discovered. -* *Upload Schema* — Upload a schema and supply the details needed to register and test the server. - -Successful registration stores the MCP server in the *MCP Servers* catalog. - -== Model Proxies - -Model proxy registration has two parts: associate the proxy with a gateway and deployment context, then define routing (and any provider connections your flow requires). After setup is complete, the Model proxy appears in the *Model Proxies* catalog. - -== APIs - -Add an API to the *APIs* catalog by registering it manually or by connecting to a provider. - -* *Register manually*–Upload a specification file to define a new API. -* *Connect to provider*–Discover and import APIs from external platforms. See xref:exp-services-connect-providers-to-add.adoc[]. - -=== Register an API Manually - -When you register an API manually, you provide a specification file that defines the API structure, including endpoints, operations, and data types. - -. In the navigation pane, select *APIs*. -. Click *Add API*. -. Select *Register manually*. -. Enter a name for the API. -. Select the API type. -. Upload the specification file. -. Click *Create*. - -The experience supports multiple API types and specification formats: - -* REST APIs (OAS, RAML) -* gRPC APIs (Proto files) -* Async APIs (AsyncAPI specification) - -== Gateways - -Manual gateway registration isn't supported in the enhanced experience. - -To set up a gateway, select *Add Gateway* to open gateway setup in Anypoint Platform. - -== See Also - -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-services-view-detailed-metrics.adoc b/modules/ROOT/pages/exp-services-view-detailed-metrics.adoc deleted file mode 100644 index 604df5c72..000000000 --- a/modules/ROOT/pages/exp-services-view-detailed-metrics.adoc +++ /dev/null @@ -1,46 +0,0 @@ -= View Detailed Metrics for Your Services -:keywords: detailed metrics, service metrics, anypoint platform, monitoring, metrics best practices, experience services, performance monitoring - -Detailed metrics go beyond high-level status to show time series, breakdowns, and dimensions your observability stack forwards into the enhanced experience. Use them to debug incidents, validate policy changes, and compare behavior across instances or environments. - -Available metric time series depend on the gateway or runtime path, whether the deployment is managed through Omni Gateway, and what your organization connected under *Platform* and *Observability*. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* Any of these permissions: -+ --- -** Anypoint Monitoring: Monitoring Viewer -** Anypoint Monitoring: Monitoring Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Open Detailed Views - -* From *Portfolio*, open a service and go to the *Monitoring* tab for charts scoped to that service or instance when the product exposes them. -* From *Observability*, open dashboards or explorers your administrator pinned for the organization. - -If you need a metric that doesn't appear, ask your platform team whether the integration or retention policy supports it. - -== Metrics Best Practices - -* Baseline after changes -+ -Capture before-and-after windows when you deploy instances or change policies so you can attribute shifts. -* Align with alerts -+ -Pair detailed charts with xref:exp-alerts-configure-notifications.adoc[alert notifications] so on-call engineers go to the right place. -* Respect data boundaries -+ -Some dimensions might be redacted or aggregated for privacy. Follow your organization's data-handling standards. - -== See Also - -* xref:exp-services-monitoring.adoc[] -* xref:exp-alerts-configure-notifications.adoc[] -* xref:exp-services-view-details.adoc[] -* xref:exp-overview.adoc[] diff --git a/modules/ROOT/pages/exp-services-view-details.adoc b/modules/ROOT/pages/exp-services-view-details.adoc deleted file mode 100644 index c84043a2f..000000000 --- a/modules/ROOT/pages/exp-services-view-details.adoc +++ /dev/null @@ -1,90 +0,0 @@ -= Viewing Service Details in the Portfolio -:keywords: view service details, service detail page, anypoint exchange, exchange services, service tabs, mulesoft exchange - -View scanner read policies, deployments, monitoring, and conformance for a service from one detail page in *Portfolio*. Open any service, including an API, agent, MCP server, Model Proxy, or gateway, to review current status, cost, and relationships. Use this page to validate applied controls and track changes without switching contexts. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Viewer -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -== Service Detail Tabs - -The page is organized into tabs. The table lists tabs, what they show, and whether they appear on the detail page for each catalog type: - -* *Yes* means the tab appears in typical configurations. -* *No* means the tab is omitted or you use another area of the experience for the same job (see the note after the table). - -Labels and fields inside a tab can differ by service type and release. For end-to-end portfolio tasks that reference these tabs, see xref:exp-overview.adoc[]. -tab can differ by service type and release. For end-to-end portfolio tasks that reference these tabs, see xref:exp-overview.adoc[]. - -[cols="2,3,^.^,^.^,^.^,^.^,^.^",options="header"] -|=== -|Tab |What You See |API |Agent |MCP Server |Model Proxy |Gateway - -|*Overview* -|Short summary of what the service does and its specification. -|Yes |Yes |Yes |Yes |Yes - -|*Instances* -|Deployed instances, environments (for example production or sandbox), and gateways when that catalog type supports instances. When Akamai API Security is enabled and scan data is available for this service, the table also shows a *Security Risk* column with a color-coded risk level per instance (Low, Medium, High, or Critical). Risk levels are per-instance — the same API can show different risk levels across environments. -|Yes |Yes |Yes |Each Model Proxy is exactly one instance so there is no *Instances* tab. |No - -|*Policies* -|Governance policies attached to the service or its instances (access, data, performance, compliance, and related domains your organization uses). For APIs discovered by scanners, this tab shows read policies from Amazon API Gateway, Google Apigee, Azure API Management, and Kong Gateway. If the instance uses a Kong gateway, the listed policies are gateway-level policies (plugins). Other service-level policies (plugins) can also apply. -|Yes |Yes |Yes |Yes |No - -|*Monitoring* -|Runtime metrics and analytics for health and usage when the system surfaces them for the service or gateway you are viewing. -|Yes |Yes |Yes |Yes |No - -|*Conformance* -|Compliance score and rule-level analysis for conformance reporting where that tab is available. When Akamai API Security is enabled, the tab includes an *Akamai* section with a risk score overview, a findings table (endpoint-level vulnerabilities with severity, OWASP API Top-10 tags, and compliance framework tags), and an incidents table (aggregated security incidents). Select a finding to view details and see recommended remediation policies you can apply directly from this page. -|Yes |Yes |Yes |No |No - -|=== -[NOTE] -==== -* *Instances* tab is available on *Agents*, *MCP Servers*, and *APIs*; *Model Proxies* and *Gateways* do not include an *Instances* tab. See xref:exp-overview.adoc[]. - -* *Conformance* on the detail page aligns with *Agents*, *APIs*, and *MCP Servers*; for gateways, compliance work is framed through *Governance* and related flows at the scope the system supports. See xref:exp-overview.adoc[]. -==== - -== Open a Service Detail Page - -. In *Portfolio*, open the catalog for the service type (for example *APIs* or *Agents*). -. Use the search box to find the service by name or description, or scan the list or grid. -. Select the service card to open its detail page. - -== View Read Policies Discovered by Scanners - -If a provider scanner has policy-read scopes configured, the *Policies* tab shows discovered policy entries for that API instance. The tab lists policy names and mapped governance context, such as category and apply level, when the provider returns that metadata. For providers that expose policy status, the tab also shows whether a policy is enabled so teams can validate scanner coverage and conformance inputs from the latest scan snapshot. - -. In *Portfolio*, open *APIs* and select an API discovered by a provider scanner. -. Open the *Policies* tab on the service detail page. -. Review read policies imported from Amazon API Gateway, Google Apigee, Azure API Management, or Kong Gateway. -. Use the policy list to confirm applied controls before governance reviews or conformance analysis. - -Policy visibility depends on the last successful scanner run, not on a live provider query. If required provider scopes or roles are missing, policy results can be incomplete or unavailable. Policy fields such as status, apply level, and detail can vary by provider. If expected policies are missing, check scanner run status and history in *Providers*. - -== See Also - -* xref:exp-overview.adoc[] -* xref:exp-services-add-to-portfolio.adoc[] -* xref:exp-services-connect-providers-to-add.adoc[] -* xref:exp-services-register-manually.adoc[] -* xref:exp-services-create-mcp-server.adoc[] -* xref:exp-services-add-semantic.adoc[] -* xref:exp-instances-add.adoc[] -* xref:exp-services-monitoring.adoc[] -* xref:exp-services-view-detailed-metrics.adoc[] diff --git a/modules/ROOT/pages/exp-slack-integrate.adoc b/modules/ROOT/pages/exp-slack-integrate.adoc deleted file mode 100644 index 221ea4b5e..000000000 --- a/modules/ROOT/pages/exp-slack-integrate.adoc +++ /dev/null @@ -1,113 +0,0 @@ -= Integrate the Enhanced Experience with Slack -:keywords: slack integration, mulesoft agent, slackbot, mcp server, slash commands, slack workspace, enhanced experience - -Install the MuleSoft for Slack app in your Slack workspace to receive notifications, run shortcuts, and provide deep links for responders to jump directly into the enhanced experience. The Slack app enables you to: - -* <>: Connect Slackbot to the Mulesoft Platform MCP Server to answer questions about the MuleSoft platform. -* <>: Manage your MuleSoft environment with the MuleSoft Agent integrated with Slack. Use MuleSoft Agent to create scanners, apply policies, deploy instances, and perform other management tasks. -* Configure alerts to deliver notifications to Slack channels and DMs. For instructions, see xref:exp-alerts-configure-notifications.adoc[]. - -Available commands, message templates, and workspaces depend on how your organization configured the Slack app. Internal runbooks list the slash commands or shortcuts approved for your workspace. - -NOTE: This tool uses generative AI, which can produce inaccurate or harmful responses. Review for accuracy and safety before using. - -[[connect-slack-workspace]] -== Connect Your Slack Workspace to the MuleSoft Organization - -You must be a MuleSoft organization administrator to connect or disconnect the Slack integration. - -Each MuleSoft organization can connect to only one Slack workspace, and each Slack workspace can connect to only one MuleSoft organization. - -. Log in and go to *Notifications* > *Settings*. -. In *Slack Setup*, click *Install*. -. Select the Slack workspace you want to connect to your MuleSoft organization. -. Click *Allow*. -+ -You may need Slack admin permissions to install this app in your organization's Slack workspace. Submit a request to install the app to your Slack administrator if you don't have the permissions. -. After the app is installed, select Slack as a notification delivery channel when you configure alerts and run shortcuts by using `@MuleSoft` in your Slack workspace. - -[[connect-slackbot-mcp]] -== Connect Slackbot to the MuleSoft Platform MCP Server - -After installing the Slack app app, connect Slackbot to the xref:mulesoft-mcp-server::getting-started-platform.adoc[] to answer questions about the MuleSoft platform. - -. Open Slackbot. -. Click the Slackbot logo again. -. Click *Integrations*. -. Click *Connect* for *MuleSoft Platform - MCP* and sign in to Anypoint Platform. -+ -Slackbot can now access information from the MCP Platform Server. - -[[begin-using-agent]] -== Begin Using the MuleSoft Agent - -[IMPORTANT] -==== -MuleSoft Agent is available on request. To get access, contact your account executive. -==== - -Before getting started, make sure you have: - -* An Anypoint Platform account with access to the enhanced experience. -* Agentforce enabled in your Anypoint Platform and Salesforce organizations by your administrator. -* The *MuleSoft Omni Agent for Anypoint* permission assigned to your user. -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -To assign the *MuleSoft Omni Agent for Anypoint* permission across business groups: - -. Log in to Anypoint Platform and open *Access Management*. -. Select the business group where you want to assign the permission. -. Find the user and assign the *MuleSoft Omni Agent for Anypoint* permission. -. Repeat for each business group that requires access. - -To start using the agent in Slack: - -. Open Slack in the workspace your company uses for MuleSoft or platform notifications. -. Open the MuleSoft app your administrator added. -. To message the agent in channels, add the agent to the channel and tag (`@MuleSoft`) with your question. You can only use slash commands in channels. -+ -To message the agent in DM, open the MuleSoft app in Slack and start a conversation with the agent. You can forward the agent's responses to other team members or channels. -. If it is your first time using the agent, follow the authentication flow when prompted to connect your Anypoint account to Slack. - -[[available-slash-commands]] -== MuleSoft Agent Slash Commands - -* `/mule help` -+ -Shows available commands and short usage notes in Slack. - -* `/mule feedback` -+ -Opens a feedback form to report bugs, request features, or send product feedback. - -* `/mule signin` -+ -Opens the authentication flow to connect your Anypoint account to Slack. If you’re already signed in it may show your connection status or prompt to re-authenticate. - -[[common-use-cases]] -== Common Use Cases for the MuleSoft Agent - -You can use the MuleSoft Agent to perform these platform tasks in Slack: - -* Receive alerts: -+ -Receive alerts to channels or direct messages (DMs). You can configure notifications to be sent to Slack. For more information, see xref:exp-alerts-configure-notifications.adoc[]. -* Find services by capability: -+ -Use natural-language search to discover APIs, agents, LLMs, and MCP servers. -* Run governance, monitoring, and cost drill-ins: -+ -Generate governance, monitoring, and cost reports on request. -* Take governance actions: -+ -Apply policies and apply cost management recommendations. - - - -[[see-also]] -== See Also - -* xref:exp-home-start.adoc[] -* xref:exp-overview.adoc[] -* xref:exp-claude-desktop-connect.adoc[] diff --git a/modules/ROOT/pages/exp-troubleshoot.adoc b/modules/ROOT/pages/exp-troubleshoot.adoc deleted file mode 100644 index 57b2bed9d..000000000 --- a/modules/ROOT/pages/exp-troubleshoot.adoc +++ /dev/null @@ -1,414 +0,0 @@ -= Troubleshoot the Enhanced Experience -:keywords: enhanced experience, troubleshooting, authentication errors, 403 forbidden, 401 unauthorized, permission errors, mulesoft - -When authentication, connection, or data issues occur in the enhanced experience, use this information to identify the cause and find solutions. Common issues include permission errors, provider connection failures, rate limiting, missing data, and SSL certificate problems. - -== Authentication and Permission Errors - -Authentication and permission errors prevent you from accessing features or performing actions. - -=== 403 Forbidden Errors - -If you receive a 403 Forbidden error: - -. Check your permissions: -.. Review your Access Management permissions in xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. -.. Verify that you have the required permission for the action: -+ -See xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] for more information. -.. Ask your administrator to review your role assignments if needed. - -. Check business group access: -.. Verify that you're working in the correct business group. -.. Confirm that you have permissions in the selected business group, not just at the organization level. -.. Ask your administrator to grant access to the specific business group if needed. -//// -. Check subscription tier: -.. Verify whether you have API Portfolio Access or Agent + API Portfolio Access. -+ -Some features (such as agents, MCP servers, and Model proxies) require Agent + API Portfolio Access. -.. Contact your administrator or account team about upgrading your subscription if needed. -//// - -=== 401 Unauthorized Errors - -If you receive a 401 Unauthorized error: - -. Check session status: -.. Verify that you're still signed in to the enhanced experience. -+ -If your session expired, sign in again. -.. Check the browser console for authentication errors (if you have developer tools access). - -. Clear cached credentials: -.. Sign out of the enhanced experience. -.. Clear your browser cache and cookies. -.. Sign in again. - -. Try a different browser: -.. Test with a different browser or incognito/private mode. -.. Disable browser extensions that might interfere with authentication. - -=== Permission Errors for Specific Actions - -If you can't perform a specific action: - -. Verify prerequisites: -+ -Some actions require specific service states (such as active or registered). -+ -.. Check that required configurations are in place (for example, a gateway must be configured before creating instances). -.. Verify that the service exists and hasn't been deleted. - -. Check feature availability: -.. Confirm that the feature is available in your environment. -+ -Some features might be in preview or require specific product access. -.. Ask your administrator about feature availability if needed. - -== Connection Failures - -Connection failures prevent you from connecting providers, running scanners, or accessing external systems. - -=== Provider Connection Issues - -If you can't connect a provider: - -. Verify credentials: -.. Check that you entered valid credentials for the provider. -.. Confirm that the credentials haven't expired. -.. Test the credentials directly with the provider's console or API. - -. Check network connectivity: -.. Verify that your network allows outbound connections to the provider. -.. Check for firewall rules that might block connections. -.. Confirm that proxy settings are correct if your organization uses a proxy. - -. Review provider permissions: -.. Verify that the credentials have the required permissions on the provider side. -.. Check that the account has access to the resources you want to discover. -.. Review the provider's documentation for required IAM roles or permissions. - -. Check provider status: -.. Verify that the provider's API is available and not experiencing outages. -.. Check the provider's status page for known issues. -.. Try connecting to the provider again after a few minutes. - -=== Scanner Connection Failures - -If a scanner fails to connect or discover services: - -. Check scanner authentication: -.. Verify that the scanner's authentication credentials are valid. -.. Refresh credentials if they've expired. -.. Reauthenticate with the provider if needed. - -. Review scanner permissions: -.. Confirm that the scanner has permissions to access the target resources. -.. Check that the account has list or describe permissions for the resource types you want to discover. -.. Verify that the scanner can access all regions or zones if applicable. - -. Check scanner configuration: -.. Review the scanner's settings in *Platform* > *Providers* > scanner name > *Settings*. -.. Verify that the scanner is targeting the correct resources or namespaces. -.. Check that filters are not excluding the resources you expect to discover. - -. Review scan history: -.. From *Platform* > *Providers*, select the scanner to view its scan history. -.. Look for error messages in recent scan attempts. -.. Check whether previous scans succeeded or when the problem started. - -=== Gateway Connection Issues - -If you can't connect to a gateway or gateway connections fail: - -. Verify gateway endpoint: -.. Check that the gateway URL is correct and accessible. -.. Test the gateway endpoint from your network (for example, using curl or a browser). -.. Confirm that the gateway is running and accepting connections. - -. Check SSL/TLS certificates: -.. Verify that the gateway's SSL certificate is valid and not expired. -.. Check that the certificate chain is complete. -.. If using a self-signed certificate, verify that it's trusted by your organization's certificate authority. - -. Review gateway credentials: -.. Confirm that you're using valid credentials for the gateway. -.. Check that the credentials have the required permissions. -.. Verify that authentication is configured correctly on the gateway side. - -. Check network path: -.. Verify that your network allows connections to the gateway's port (typically 443 for HTTPS). -.. Check for firewall rules that might block connections. -.. Confirm that proxy settings are correct if your organization uses a proxy. - -== Rate Limiting and Throttling - -Rate limiting occurs if you exceed the allowed number of requests in a certain period. - -=== 429 Too Many Requests Errors - -If you receive a 429 Too Many Requests error: - -. Wait before retrying: -+ -Rate limits typically reset after a short period (usually 1–5 minutes). -+ -.. Check the error message for retry-after information. -.. Wait at least 60 seconds before retrying the operation. - -. Reduce request frequency: -.. Avoid running multiple scanners simultaneously if they target the same provider. -.. Space out manual scan runs rather than triggering them in quick succession. -.. Reduce the frequency of scheduled scans if you're hitting limits regularly. - -. Review operation patterns: -.. Check whether automated processes or scripts are making excessive requests. -.. Review scanner schedules to avoid overlapping runs. -.. Contact your administrator if rate limits don't align with your usage needs. - -. Provider rate limits: -+ -Provider rate limits (AWS, Azure, GCP) are separate from enhanced experience rate limits. -+ -.. Check the provider's rate limit documentation for their specific limits. -.. Consider requesting a rate limit increase from the provider if needed. - -== Data Not Appearing - -If you expect to see data, but it's not appearing in the enhanced experience: - -=== Services Not Showing After Scanner Run - -If a scanner ran successfully, but services aren't appearing: - -. Check scanner results: -.. From *Platform* > *Providers*, select the scanner to view its scan history. -.. Verify that the scan reported discovering new services. -.. Check for any error messages in the scan history. - -. Review catalog filters: -.. From *Portfolio*, check that you're viewing the correct catalog (APIs, Agents, MCP Servers, Model Proxies, or Gateways). -.. Clear any filters that might be hiding the services. -.. Try using the search function to find specific services by name. - -. Verify service type mapping: -.. Confirm that the discovered services are of the expected type. -.. Check that the provider's resources map to the catalog you're checking. -+ -Some resources might not be imported if they don't meet the criteria for the catalog. - -. Check business group context: -.. Verify that you're viewing the correct business group or organization. -+ -Services might be registered in a different business group than you're currently viewing. -.. Switch business groups if needed to find the services. - -=== Metrics Not Displaying - -If you expect to see metrics but they're not appearing: - -. Verify monitoring is enabled: -.. Check that monitoring is configured for the service or instance. -.. From the service detail page, select *Monitoring* to verify that monitoring is active. -.. Contact your administrator if monitoring needs to be enabled. - -. Check time range: -.. Verify that you're viewing an appropriate time range for the data. -.. Expand the time range to see if data exists outside the current window. -+ -New services might not have historical data. - -. Allow time for data collection: -+ -Metrics might take several minutes to appear after an event occurs. -+ -.. Wait at least 5–10 minutes after creating or updating a service before expecting metrics. -.. Check again after the next monitoring collection cycle. - -. Verify service activity: -.. Confirm that the service is receiving traffic or requests. -.. Check that the service is deployed and running. -.. Review service logs to verify that requests are being processed. - -=== Cost or Token Usage Data Missing - -If cost or token usage data isn't appearing: - -. Check governance strategy scope: -.. From *Governance* > *Strategies*, verify that a governance strategy targets the service. -.. Confirm that the strategy is active and not in draft state. -.. Check that the strategy includes cost or token tracking. - -. Allow time for data aggregation: -.. Cost and token usage data can take several hours to appear after usage occurs. -.. Check again after 24 hours for the most complete data. -+ -Historical data might not be available for newly registered services. - -. Verify service type: -.. Cost and token usage tracking applies primarily to Model proxies and agents. -+ -APIs and other service types might not generate cost data. -.. Check the service type in *Portfolio* to confirm it supports cost tracking. - -== Async Operations and Delays - -Some operations run in the background and can take time to complete. - -=== Operations Appearing Stuck - -If an operation appears stuck or takes longer than expected: - -. Check operation type: -+ -Governance insights and conformance scoring run asynchronously and can take several minutes. -+ -.. Large scanner runs discovering many services can take 10–30 minutes or longer. -+ -Policy application to multiple instances might process in the background. - -. Review status indicators: -.. Look for progress indicators or status messages in the UI. -.. Check the service or scanner detail page for updated status. -.. Refresh the page to see if the operation has completed. - -. Wait for background processing: -.. Allow at least 15–30 minutes for governance insights to complete after creating a strategy. -+ -Scanner runs can take varying amounts of time depending on the number of resources discovered. -+ -Cost data aggregation can take several hours. - -. Check for errors: -.. Review the browser console for error messages (if you have developer tools access). -.. Check notification areas for error alerts. -.. If no error appears, but the operation doesn't complete after 30 minutes, contact support. - -=== Checking Background Job Status - -To check the status of background operations: - -. Scanner runs: -.. From *Platform* > *Providers*, select the scanner. -.. View the scan history on the *Overview* tab. -+ -The most recent entry shows the current or last completed scan. - -. Governance operations: -.. From *Governance* > *Strategies*, select the strategy. -.. Check the status indicator next to the strategy name. -.. Review conformance reports for completion status. - -. Service operations: -.. From *Portfolio*, select the service. -.. Check for status messages or progress indicators on the detail page. -.. Look for notifications in the notification area. - -== Browser and Client Issues - -Browser or client problems can affect your experience using the enhanced experience. - -=== Page Not Loading or Displaying Correctly - -If pages don't load or appear correctly: - -. Clear browser cache: -.. Clear your browser cache and cookies. -.. Hard refresh the page (Ctrl+Shift+R on Windows/Linux, Cmd+Shift+R on Mac). -.. Try accessing the enhanced experience in incognito/private mode. - -. Check browser compatibility: -.. Verify that you're using a supported browser (Chrome, Firefox, Safari, or Edge). -.. Update your browser to the latest version. -.. Check xref:browser-support.adoc[] for specific version requirements. - -. Disable browser extensions: -.. Temporarily disable browser extensions that might interfere with the enhanced experience. -+ -Ad blockers, privacy extensions, or script blockers can prevent features from working. -.. Test with extensions disabled to identify conflicts. - -. Check browser console: -.. Open browser developer tools (F12 or Cmd+Option+I). -.. Review the console for error messages. -.. Share error messages with your administrator or support team if needed. - -=== Session Timeout Issues - -If your session expires frequently or unexpectedly: - -. Adjust session settings: -.. Check your organization's session timeout policy. -.. Ask your administrator about extending session duration if needed. -+ -Security policies can limit maximum session duration. - -. Stay active: -.. Keep a tab or window with the enhanced experience open and active. -+ -Periodic interaction prevents session timeouts. -.. Refresh the page if you've been idle for an extended period. - -. Re-authenticate: -.. Sign out and sign in again to start a fresh session. -.. Clear browser cache if re-authentication fails. -.. Check with your administrator if authentication fails repeatedly. - -== SSL and Certificate Issues - -SSL and certificate problems prevent secure connections to providers or gateways. - -=== Certificate Validation Failures - -If you encounter certificate validation errors: - -. Check certificate validity: -.. Verify that the certificate hasn't expired. -.. Confirm that the certificate is issued by a trusted certificate authority. -.. Check that the certificate's common name or subject alternative name matches the hostname. - -. Review certificate chain: -.. Verify that the complete certificate chain is present. -.. Check that intermediate certificates are installed correctly. -.. Confirm that the root certificate is trusted by your system. - -. Self-signed certificates: -.. If using self-signed certificates, verify that they're trusted by your organization. -.. Ask your administrator about adding the certificate to your system's trusted store. -.. Consider using certificates from a trusted certificate authority for production systems. - -. Contact your administrator: -.. Share certificate error details with your administrator or security team. -+ -Your organization might need to update certificate trust settings. -.. Work with your administrator to resolve certificate trust issues. - -== Get Additional Help - -If these troubleshooting steps don't resolve your issue: - -. Contact your administrator: -.. Share specific error messages and steps to reproduce the problem. -.. Provide details about what you were trying to accomplish. -.. Include screenshots if they help illustrate the issue. - -. Check documentation: -.. Review feature-specific documentation for additional guidance. -.. Check xref:exp-release-notes.adoc[Release Notes] for known issues. -.. Review xref:exp-ai-assistant-troubleshoot.adoc[] for AI assistant-specific issues. - -. Gather diagnostic information: -.. Note exact error message and error code if provided. -.. Record the steps to reproduce the issue. -.. Check browser console for technical error details (F12 or Cmd+Option+I). -.. Note the time the error occurred and any patterns (happens consistently or intermittently). - -== See Also - -* xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] -* xref:exp-ai-assistant-troubleshoot.adoc[] -* xref:exp-providers-manage.adoc[] -* xref:exp-scanners-manage.adoc[] -* xref:browser-support.adoc[] -include::release-notes::partial$release-notes/rn-known-issues.adoc[tag=knownIssuesSeeAlsoLink] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 4922e0ce2..76b3b34b5 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,116 +1,121 @@ = [.brand]#MuleSoft# Documentation -:keywords: mulesoft documentation, digital transformation, getting started, api design, integration, mulesoft platform, discover mulesoft -:page-llms-exclude: true :page-layout: home +:page-article-style: learning-map +:description: Custom page description should override generic meta description :page-fragmentize: :!sectids: ifndef::env-site[:imagesdir: ../images] -[[the-road]] -== The Road to Digital Transformation +// Source: https://github.com/mulesoft/docs-general/blob/latest/modules/ROOT/pages/index.adoc?plain=1 -image::getting-started.png[""] +[#the-road] +== Agentic Orchestration with MuleSoft --- -[discrete] -=== Getting Started +MuleSoft agentic orchestration empowers agent action with flexible intelligent tooling that integrates systems and automates processes with AI to help accelerate your ability to deliver an actionable, connected enterprise by helping you build, orchestrate, and manage AI-driven experiences. -Build the digital transformation your business needs. +The end-to-end journey for MuleSoft agentic orchestration consists of various tasks, each with links to relevant content to assist you in completing them. -* xref:api-led-overview.adoc[Tutorial: Build an API from start to finish.] --- +[.lm-table, cols="1a,1a", grid="none"] +|=== +| image::reuse::lm_start.png[] +[.lm-bold]##Learn About MuleSoft AI## -image::discover.png[""] +MuleSoft AI is a set of capabilities for building, orchestrating, governing, deploying, and observing AI agents and agent networks across your enterprise. --- -[discrete] -=== Discover +- https://www.mulesoft.com/platform/ai[Learn About MuleSoft AI] +- https://www.mulesoft.com/lp/whitepaper/blueprint-for-implementing-ai[Blueprint for Implementing AI] +- https://www.mulesoft.com/lp/whitepaper/build-a-foundation-for-ai-with-integration[Build a Foundation for AI with Integration] +- https://help.salesforce.com/s/articleView?id=platform.api_catalog_use_api_actions_in_agent_actions.htm&type=5[Watch an Example of Using MuleSoft for Agentforce] -Browse Exchange to find existing API specifications, templates, examples, and other assets that you can reuse for your projects. +| image::reuse::lm_analyze_1.png[] +[.lm-bold]##Get Started## -* https://www.anypoint.mulesoft.com/exchange/[Discover reusable assets.^] --- +Start your agentic journey with guided quickstarts, templates, and planning resources that help you stand up Agent Fabric and Agentforce agents. -image::design.png[""] +- https://www.youtube.com/watch?v=GAqwPie16ic[Watch an Intro to MuleSoft Agent Fabric] +- xref:general::learning-map-agent-fabric.adoc[Get Started with Agent Fabric] +- https://trailhead.salesforce.com/content/learn/trails/design-and-implement-ai-agents-with-agentforce[Design and Implement AI Agents with Agentforce] +- https://help.salesforce.com/s/articleView?id=ai.agent_plan.htm&type=5[Plan Your AI Agent] +|=== --- -[discrete] -=== Design +[.lm-table, cols="1a,1a,1a", grid="none"] +|=== +| image::reuse::lm_explore_1.png[] +[.lm-bold]##Design and Orchestrate Agents## -Create and publish new API specifications from scratch. +Design and coordinate AI agents using a declarative approach that promotes reuse, governance, and observability. -* xref:design-center::design-create-publish-api-specs.adoc[Create a reusable API specification.] -* xref:access-management::index.adoc[Manage access to your Anypoint Platform account.] -* xref:general::security.adoc[Build security into your application network.] --- +- xref:exchange::asset-types.adoc[Learn About Agentic Asset Types Supported in Exchange] +- xref:exchange::importing-agentforce-agents.adoc[Import Agentforce Agents] +- xref:agent-network::af-get-started.adoc[Get Started with Agent Networks] +- xref:agent-network::af-create-agent-network.adoc[Build Agent Networks for Agent Fabric] +- xref:agent-network::af-deploy-agent-network-targets.adoc[Deploy Your Agent Network Instances] +- https://videos.mulesoft.com/watch/wgZ5WuV6VgDbyK3bFKV2RJ[Watch a Demo About Agent Orchestration] +- https://www.mulesoft.com/exchange/org.mule.examples/mcp-b2b-partner-manager-template/minor/0.1/[Try an MCP Tools Template for Partner Manager] -image::develop.png[""] +| image::reuse::lm_audience_1.png[] +[.lm-bold]##Govern and Secure Your Agents## --- -[discrete] -=== Develop & Test +Apply policies and secure agent network traffic. -Build and test APIs and integration apps. +- xref:gateway::index.adoc[Learn About Governance] +- xref:gateway::flex-gateway-managed-ingress-egress.adoc[Govern the Agent Network] +- xref:gateway::flex-gateway-secure-apis.adoc[Secure the Agent Network with Policies] +- https://videos.mulesoft.com/watch/zPeibGjqTAqa4fxF545Jwh[Watch how to Govern Your Agents] -* xref:studio::index.adoc[Develop your API.] -* xref:connectors::index.adoc[Connect your data, systems, and apps.] -* xref:mule-runtime::mule-app-dev.adoc[Develop the Mule app that integrates systems, services, APIs, and devices.] -* xref:dataweave::index.adoc[Access and transform data within the Mule app.] -* xref:munit::index.adoc[Build automated tests for your APIs and integrations.] --- +| image::reuse::lm_optimize_1.png[] +[.lm-bold]##Observe and Gain Actionable Insights## -image::deploy.png[""] +Visualize and monitor your agent network and agentic assets. --- -[discrete] -=== Deploy +- xref:agent-visualizer::index.adoc[Visualize and Explore Your Agent Network] +- xref:monitoring::anypoint-insights-agentic.adoc[Monitor and Troubleshoot Your Agent Network] +|=== -Choose a deployment option, deploy APIs and apps, and secure them with policies. +[.lm-table, cols="1a,1a", grid="none"] +|=== +| image::reuse::lm_build_1.png[] +[.lm-bold]##Develop with AI-Powered Tools## -* xref:runtime-manager::deployment-strategies.adoc[Choose a deployment option.] -* xref:api-manager::api-proxy-landing-page.adoc[Configure a proxy for your API.] -* xref:api-manager::manage-policies-overview.adoc[Protect your APIs with policies.] --- +Accelerate integration and agent development with AI using Anypoint Code Builder, MuleSoft connectors, MuleSoft MCP Server, and other tools. -image::monitor.png[""] +- https://www.youtube.com/watch?v=1bU8nzFI_Co[Watch an Intro to MuleSoft Dev Agent] +- xref:anypoint-code-builder::int-ai-developing-integrations.adoc[Develop Integrations with MuleSoft Dev Agent] +- xref:anypoint-code-builder::api-ai-design-spec.adoc[Design API Specs with MuleSoft Dev Agent] +- xref:anypoint-code-builder::ai-enabling-api-project-topic-center.adoc[Enable APIs for Topics and Agent Actions] +- https://help.salesforce.com/s/articleView?id=platform.api_catalog_activate_agent_topics_and_agent_actions.htm&type=5[Activate Agent Topic and Agent Actions in API Catalog] +- https://videos.mulesoft.com/watch/Fhho6DvrtMBdcgfCrcXDkz[Watch an Intro to MuleSoft MCP Support] +- https://www.mulesoft.com/platform/ai/model-context-protocol[Learn About MuleSoft MCP Support] +- xref:mulesoft-mcp-server::index.adoc[Leverage MuleSoft MCP Server] +- xref:connector-builder::index.adoc[Create Connectors with Connector Builder] --- -[discrete] -=== Monitor +| image::reuse::lm_develop_end_1.png[] +[.lm-bold]##Develop with MuleSoft AI Connectors## -Monitor your APIs and integrations using dashboards, metrics, and visualization. +Connect AI models, agents, and enterprise systems with MuleSoft AI connectors for inference, vectors, MCP, Agentforce, and more. + +- xref:a2a-connector::index.adoc[A2A Connector] +- xref:agentforce-connector::index.adoc[Agentforce Connector] +- xref:amazon-bedrock-connector::index.adoc[Amazon Bedrock Connector] +- xref:einstein-ai-connector::index.adoc[Einstein AI Connector] +- xref:mcp-connector::index.adoc[MCP Connector] +- xref:mulesoft-ai-chain-connector::index.adoc[MuleSoft AI Chain Connector] +- xref:mulesoft-inference-connector::index.adoc[MuleSoft Inference Connector] +- xref:mulesoft-vectors-connector::index.adoc[MuleSoft Vectors Connector] +- xref:mulesoft-webcrawler-connector::index.adoc[MuleSoft WebCrawler Connector] +|=== -* xref:monitoring::index.adoc[View metrics for integration apps and APIs.] -* xref:api-functional-monitoring::index.adoc[Test the functional behavior and performance of your API.] -* xref:runtime-manager::monitoring.adoc[Monitor your deployed apps.] --- == Quick Links -[[trending-topics]] -== Featured Topics -// You can update the H2 here, but please do not change the ID without contacting ms-docs-infra-requests -//// -- Add your xref to the top of the list. -- Include a comment on when you added your xref and if there's a reason it shouldn't be removed. -- If your addition(s) cause the list to exceed ten, remove xref(s) from the bottom of the list. - -//// - -// Updated 2026/06/17 - sathya -* xref:general::use-mulesoft-docs-with-ai.adoc[] -* xref:learning-map-exp.adoc[] -* xref:monitoring::integration-intelligence.adoc[] -* xref:general::learning-map-mulesoft-ai.adoc[] -* xref:general::learning-map-agent-fabric.adoc[] -* xref:agent-network::af-get-started.adoc[] -* xref:exchange::importing-agentforce-agents.adoc[] -// * xref:gateway::flex-gateway-managed-ingress-egress.adoc[] -* xref:api-manager::create-instance-task-agent-tool.adoc[] -* xref:agent-visualizer::index.adoc[] -* xref:monitoring::anypoint-insights-agentic.adoc[] -// * xref:mulesoft-mcp-server::index.adoc[] -// * xref:mcp-connector::index.adoc[MCP Connector User Guide] -// * xref:learning-map-api-management.adoc[] -//* xref:cloudhub::app-migration.adoc[] -//* xref:hyperforce::index.adoc[Salesforce Hyperforce] +[#trending-topics] +== Trending Topics +// Limit the number of links to 10 maximum + +* xref:dataweave::dataweave-cookbook-format-dates.adoc[Format Dates and Times] +* xref:dataweave::dw-operators.adoc[DataWeave Operators] +* xref:dataweave::dw-core-functions-filter.adoc[DataWeave Function: filter] +* xref:dataweave::dw-core-functions-map.adoc[DataWeave Function: map] +* xref:mule-runtime::batch-processing-concept.adoc[Batch Processing] +* xref:dataweave::dataweave-functions.adoc[DataWeave Reference] +* xref:connectors::index.adoc[Connectors] diff --git a/modules/ROOT/pages/learning-map-agent-fabric.adoc b/modules/ROOT/pages/learning-map-agent-fabric.adoc index 6b5de33e8..96d6316b4 100644 --- a/modules/ROOT/pages/learning-map-agent-fabric.adoc +++ b/modules/ROOT/pages/learning-map-agent-fabric.adoc @@ -16,7 +16,7 @@ The end-to-end journey for Agent Fabric consists of various tasks, each with lin [.lm-table, cols="1a,1a,1a", grid="none"] |=== -| image::lm_start.png[""] +| image::reuse::lm_start.png[""] [.lm-bold]##Learn About Agent Fabric## Agent Fabric helps you design and orchestrate a network of agents, brokers, and MCP servers to achieve complex goals across your enterprise. @@ -24,7 +24,7 @@ Agent Fabric helps you design and orchestrate a network of agents, brokers, and - https://www.youtube.com/watch?v=GAqwPie16ic[Watch a Video to Learn About Agent Fabric] - https://www.mulesoft.com/lp/demo/agent-fabric-interactive-demo[Watch an Interactive Demo of Agent Fabric] -| image::lm_explore_1.png[""] +| image::reuse::lm_explore_1.png[""] [.lm-bold]##Discover Agentic Assets## Use Anypoint Exchange to discover agentic assets for reuse across your enterprise. @@ -42,7 +42,7 @@ Use Anypoint Exchange to discover agentic assets for reuse across your enterpris - https://videos.mulesoft.com/watch/Dn9QXJKDzTxSJPNgra9LoM[Watch a Video to Learn About MCP Bridge] - xref:exchange::to-create-an-asset.adoc#create-llm[Create and Publish an LLM in Exchange] -| image::lm_build_1.png[""] +| image::reuse::lm_build_1.png[""] [.lm-bold]##Build and Orchestrate Agent Networks## Build your agent network and coordinate brokers and agents using a declarative YAML approach. @@ -56,7 +56,7 @@ Build your agent network and coordinate brokers and agents using a declarative Y [.lm-table, cols="1a,1a", width="66%", grid="none"] |=== -| image::lm_build_1.png[""] +| image::reuse::lm_build_1.png[""] [.lm-bold]##Govern and Secure the Agent Network## Apply policies to your agents, brokers, Model proxies, and MCP servers to help manage security and control traffic. @@ -67,7 +67,7 @@ Apply policies to your agents, brokers, Model proxies, and MCP servers to help m - xref:gateway::flex-gateway-managed-ingress-egress.adoc[Deploy Agent Fabric Ingress and Egress Managed Omni Gateways] - xref:gateway::flex-gateway-secure-apis.adoc[Secure Omni Gateway Instances with Policies] -| image::lm_analyze_1.png[""] +| image::reuse::lm_analyze_1.png[""] [.lm-bold]##Observe and Gain Actionable Insights## Visualize your agent network and monitor performance and behavior. diff --git a/modules/ROOT/pages/learning-map-exp.adoc b/modules/ROOT/pages/learning-map-exp.adoc deleted file mode 100644 index 789d437c9..000000000 --- a/modules/ROOT/pages/learning-map-exp.adoc +++ /dev/null @@ -1,83 +0,0 @@ -= Enhanced MuleSoft Experience -:keywords: enhanced mulesoft experience, learning map, mulesoft training, getting started, mulesoft resources -: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, Model proxies, 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. - -* Scan platforms and import discovered APIs and agents, then manage scanners in one place. -* Register services manually, view services across providers, and create new MCP servers. -* Govern services with runtime policies and governance strategies for design and runtime consistency. -* Observe service health and monitor overview dashboards across services and environments. - -image::enhanced-experience-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] -- xref:exp-overview.adoc[] -- xref:exp-compare.adoc[] -- xref:exp-home-start.adoc[] -- xref:exp-slack-integrate.adoc[] -- xref:exp-claude-desktop-connect.adoc[] -- https://trailhead.salesforce.com/content/learn/modules/enhanced-mulesoft-experience-quick-look[Get to Know the Enhanced MuleSoft Experience] - - -| image::lm_explore_1.png[""] -[.lm-bold]##Register## - -Register agents, APIs, and MCP servers from any provider or registry, and add Model proxies and gateways. - -- xref:exp-services-add-to-portfolio.adoc[] -- xref:exp-services-connect-providers-to-add.adoc[] -- xref:exp-services-register-manually.adoc[] -- xref:exp-services-create-mcp-server.adoc[] -- xref:exp-services-add-semantic.adoc[] -- xref:exp-services-view-details.adoc[] -- xref:exp-scanners-add-from-providers.adoc[] - - - -| image::lm_build_1.png[""] -[.lm-bold]##Monitor## - -Monitor latency, cost, invocations, and failures in real time. - -- xref:exp-services-monitoring.adoc[] -- xref:exp-governance-view-cost-and-token-usage.adoc[] -- xref:exp-services-view-detailed-metrics.adoc[] -- xref:exp-alerts-configure-notifications.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:exp-instances-add.adoc[] -- xref:exp-governance-work-with-strategies.adoc[] - -| image::lm_analyze_1.png[""] -[.lm-bold]##Transcode## - -Transcode existing REST APIs into MCP servers instantly. - -- xref:exp-services-create-mcp-server.adoc[] - - -|=== - - -== See Also - -* xref:exp-home-start.adoc[] -* xref:exp-compare.adoc[] diff --git a/modules/ROOT/pages/learning-map-mulesoft-ai.adoc b/modules/ROOT/pages/learning-map-mulesoft-ai.adoc deleted file mode 100644 index 2baf69107..000000000 --- a/modules/ROOT/pages/learning-map-mulesoft-ai.adoc +++ /dev/null @@ -1,103 +0,0 @@ -= MuleSoft AI -:keywords: mulesoft ai, ai integration, artificial intelligence, mulesoft, learning resources, ai capabilities -:page-article-style: learning-map - -MuleSoft AI empowers agent action with flexible intelligent tooling that integrates systems and automates processes with AI to help accelerate your ability to deliver an actionable, connected enterprise by helping you build, orchestrate, and manage AI-driven experiences. - -The end-to-end journey for MuleSoft AI consists of various tasks, each with links to relevant content to assist you in completing them. - -[.lm-table, cols="1a,1a,1a", grid="none"] -|=== -| image::reuse::lm_start.png[] -[.lm-bold]##Learn About MuleSoft AI## - -MuleSoft AI is a set of capabilities for building, orchestrating, governing, deploying, and observing AI agents and agent networks across your enterprise. - -- https://www.mulesoft.com/platform/ai[Learn About MuleSoft AI] -- https://www.mulesoft.com/lp/whitepaper/blueprint-for-implementing-ai[Blueprint for Implementing AI] -- https://www.mulesoft.com/lp/whitepaper/build-a-foundation-for-ai-with-integration[Build a Foundation for AI with Integration] -- https://help.salesforce.com/s/articleView?id=platform.api_catalog_use_api_actions_in_agent_actions.htm&type=5[Watch an Example of Using MuleSoft for Agentforce] - -| image::reuse::lm_analyze_1.png[] -[.lm-bold]##Get Started## - -Kick off your agentic journey with quickstarts and templates. - -- https://www.youtube.com/watch?v=GAqwPie16ic[Watch an Intro to MuleSoft Agent Fabric] -- xref:learning-map-agent-fabric.adoc[Get Started with Agent Fabric] -- https://trailhead.salesforce.com/content/learn/trails/design-and-implement-ai-agents-with-agentforce[Design and Implement AI Agents with Agentforce] -- https://help.salesforce.com/s/articleView?id=ai.agent_plan.htm&type=5[Plan Your AI Agent] - -| image::reuse::lm_explore_1.png[] -[.lm-bold]##Design and Orchestrate Agents## - -Design and coordinate AI agents using a declarative approach that promotes reuse, governance, and observability. - -- xref:exchange::asset-types.adoc[Learn About Agentic Asset Types Supported in Exchange] -- xref:exchange::importing-agentforce-agents.adoc[Import Agentforce Agents] -- xref:agent-network::af-get-started.adoc[Get Started with Agent Networks] -- xref:agent-network::af-create-agent-network.adoc[Build Agent Networks for Agent Fabric] -- xref:agent-network::af-deploy-agent-network-targets.adoc[Deploy Your Agent Network Instances] -- https://videos.mulesoft.com/watch/wgZ5WuV6VgDbyK3bFKV2RJ[Watch a Demo About Agent Orchestration] -- https://www.mulesoft.com/exchange/org.mule.examples/mcp-b2b-partner-manager-template/minor/0.1/[Try an MCP Tools Template for Partner Manager] -|=== - -[.lm-table, cols="1a,1a,1a", grid="none"] -|=== -| image::reuse::lm_build_1.png[] -[.lm-bold]##Develop with AI-Powered Tools## - -Accelerate integration and agent development with AI using Anypoint Code Builder, MuleSoft connectors, MuleSoft MCP Server, and other tools. - -- https://www.youtube.com/watch?v=1bU8nzFI_Co[Watch an Intro to MuleSoft Dev Agent] -- xref:anypoint-code-builder::int-ai-developing-integrations.adoc[Develop Integrations with MuleSoft Dev Agent] -- xref:anypoint-code-builder::api-ai-design-spec.adoc[Design API Specs with MuleSoft Dev Agent] -- xref:anypoint-code-builder::ai-enabling-api-project-topic-center.adoc[Enable APIs for Topics and Agent Actions] -- https://help.salesforce.com/s/articleView?id=platform.api_catalog_activate_agent_topics_and_agent_actions.htm&type=5[Activate Agent Topic and Agent Actions in API Catalog] -- https://videos.mulesoft.com/watch/Fhho6DvrtMBdcgfCrcXDkz[Watch an Intro to MuleSoft MCP Support] -- https://www.mulesoft.com/platform/ai/model-context-protocol[Learn About MuleSoft MCP Support] -- xref:mulesoft-mcp-server::index.adoc[Leverage MuleSoft MCP Server] -- xref:connector-builder::index.adoc[Create Connectors with Connector Builder] - -[.lm-bold]##Develop with MuleSoft AI Connectors## - - - - xref:a2a-connector::index.adoc[A2A Connector] - - xref:agentforce-connector::index.adoc[Agentforce Connector] - - xref:amazon-bedrock-connector::index.adoc[Amazon Bedrock Connector] - - xref:einstein-ai-connector::index.adoc[Einstein AI Connector] - - xref:mcp-connector::index.adoc[MCP Connector] - - xref:mulesoft-ai-chain-connector::index.adoc[MuleSoft AI Chain Connector] - - xref:mulesoft-inference-connector::index.adoc[MuleSoft Inference Connector] - - xref:mulesoft-vectors-connector::index.adoc[MuleSoft Vectors Connector] - - xref:mulesoft-webcrawler-connector::index.adoc[MuleSoft WebCrawler Connector] - -| image::reuse::lm_analyze_1.png[] -[.lm-bold]##Observe and Gain Actionable Insights## - -Visualize and monitor your agent network and agentic assets. - -- xref:agent-visualizer::index.adoc[Visualize and Explore Your Agent Network] -- xref:monitoring::anypoint-insights-agentic.adoc[Monitor and Troubleshoot Your Agent Network] - -| image::reuse::lm_audience_end_1.png[] -[.lm-bold]##Govern and Secure Your Agents## - -Apply policies and secure agent network traffic. - -- xref:gateway::index.adoc[Learn About Governance] -- xref:gateway::flex-gateway-managed-ingress-egress.adoc[Govern the Agent Network] -- xref:gateway::flex-gateway-secure-apis.adoc[Secure the Agent Network with Policies] -- https://videos.mulesoft.com/watch/zPeibGjqTAqa4fxF545Jwh[Watch how to Govern Your Agents] -|=== - -[discrete] -== See Also - -* xref:learning-map-agent-fabric.adoc[Agent Fabric] -* xref:agent-visualizer::index.adoc[] -* xref:anypoint-code-builder::index.adoc[] -* xref:monitoring::index.adoc[] -* xref:exchange::index.adoc[] -* xref:gateway::index.adoc[] -* xref:use-mulesoft-docs-with-ai.adoc[] diff --git a/modules/ROOT/pages/model-proxy-create-model-proxy.adoc b/modules/ROOT/pages/model-proxy-create-model-proxy.adoc deleted file mode 100644 index f49478821..000000000 --- a/modules/ROOT/pages/model-proxy-create-model-proxy.adoc +++ /dev/null @@ -1,79 +0,0 @@ -= Creating Model Proxies -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy-create-llm-proxy.adoc, gateway::flex-gateway-llm-proxy-create-llm-proxy.adoc - -You can configure a model proxy to route LLM traffic across different models and providers using model-based or semantic routing strategies. When you create a model proxy, you define the endpoint format, routing strategy, and at least one route that maps requests to a supported LLM provider and model. After deployment to Omni Gateway, you can edit the proxy configuration at any time. - -NOTE: A large Omni Gateway supports up to 50 Model Proxies. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account -* API Manager: API Creator permission -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -* A deployed Omni Gateway version 1.11.4 -+ -See xref:gateway::flex-gateway-managed-set-up.adoc[]. -* API keys to authenticate with your LLM Providers. -* A xref:model-proxy-semantic-service.adoc[configured semantic service] if you want to use semantic routing. - -[[create-a-model-proxy]] -== Create a Model Proxy - -. In the navigation pane, select *Model Proxies*. -. Click *Add Model Proxy* -. Configure the proxy parameters: -.. *Proxy Name*: Define a name for the Model Proxy. -.. *Description*: Provide a description of what this proxy does. -.. *Base Path*: Define a base path for the proxy endpoint (for example: `/billing-ai`). -.. *Format*: Select an endpoint format: -+ -*** *OpenAI*: Select the OpenAI API format to send requests to all supported LLM providers (including Gemini and Anthropic). Supports multi-routing and fallback mechanisms. You can't change this format later. -*** *Anthropic*: Select the Anthropic API format for native Anthropic Claude model requests. Doesn't support multi-routing or fallback mechanisms. You can't change this format later. -*** *Gemini*: Select the Gemini API format for native Google Gemini model requests. Doesn't support multi-routing or fallback mechanisms. You can't change this format later. -.. *Environment*: Select the environment for the Model Proxy. -.. *Omni Gateway*: Select an Omni Gateway to deploy the Model Proxy to. -.. *Consumer Endpoint*: Specify the URL where the Model Proxy will be accessible. -.. *Port*: Enter the port number for the Model Proxy (for example, `8081`). -. Click *Continue*. -. Configure the routing strategy: -.. Select a routing strategy: -+ -*** *Model-based*: Route requests based on the model specified in the request payload. -*** *Semantic*: Route requests based on semantic analysis of the prompt content. Requires a configured semantic service. -. Configure at least one route: -.. Provide a route name (for example, `Route A`). -.. Optionally, click *Add headers* to add routing headers that filter requests by region, SLA, or custom rules. For example, `Region: US` -.. Configure the target: -*** *Provider*: Select your LLM provider from these options: -**** *OpenAI* -**** *Gemini* -**** *Azure OpenAI* -**** *Bedrock Anthropic* -**** *NVIDIA Nemotron* -**** *Anthropic* -*** *Model*: Select a target model to override the model version specified in the payload. Selecting *Not Applicable* sends the request to the model specified in the request. A target model is required for semantic routing. -.. Configure authentication: -*** *Destination URL*: Specify the URL for your provider endpoint. Ensure the URL is correct and edit if necessary. -*** *API Key*: Choose one of the following: -**** *Static*: Enter a static API key for the provider endpoint -**** *Dynamic*: Define a DataWeave script to extract the API key from the incoming request -. Click *Add Route* to add additional routes. Complete the previous steps to configure each new route -. Click *Add Model Proxy*. - -== Edit a Model Proxy - -To edit a Model Proxy: - -. In the navigation pane, select *Model Proxies*. -. Click the name of the Model Proxy you want to edit. -. Click *Edit Configuration*. -. Make the necessary edits. -. Click *Save Changes*. \ No newline at end of file diff --git a/modules/ROOT/pages/model-proxy-policies.adoc b/modules/ROOT/pages/model-proxy-policies.adoc deleted file mode 100644 index d352eb731..000000000 --- a/modules/ROOT/pages/model-proxy-policies.adoc +++ /dev/null @@ -1,66 +0,0 @@ -= Applying Model Proxy Policies -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy-policies.adoc, gateway::flex-gateway-llm-proxy-policies.adoc - -Model Proxy enforces three policies by default to secure and route LLM traffic without additional configuration. Apply additional supported policies through API Manager to add content safety, PII detection, and token rate limiting controls. Outbound policies and the Rate Limiting SLA policy are not supported. - -By default, Model Proxy applies these policies: - -* Client ID Enforcement -* Model Proxy Core Policy -* Model Based Routing Policy or Semantic Routing Policy (policy name dependent on embedded service provider) - -You don't need to modify these policies. - -Model Proxy supports most xref:gateway::policies-included-directory.adoc[included policies], but doesn't support outbound policies. - -NOTE: Model Proxy doesn't support xref:gateway::policies-included-rate-limiting-sla.adoc[]. - -These policies are specific and useful for Model Proxies: - -* xref:gateway::policies-included-bedrock-guardrails.adoc[] -* xref:gateway::policies-included-azure-content-safety.adoc[] -* xref:gateway::policies-included-llm-pii-detection.adoc[] -* xref:gateway::policies-included-llm-token-rate-limit.adoc[] -* xref:gateway::policies-included-regex-prompt-guard.adoc[] - -== Apply Policies to Model Proxies - -. From API Manager, click *Model Proxies*. -. Click the name of the Model Proxy you want to apply a policy to. -. Click *AI Policies*. -. Click *Add inbound policy*. -. Select the policy to apply. -. Configure the required parameters. -+ -For policy configuration parameters, see xref:gateway::policies-included-directory.adoc[]. -. If necessary, configure *Advanced options*. -. Click *Apply*. - -== Model Proxy Authentication Policy - -By default, the Model Proxy has the Client ID Enforcement policy applied. -This is required because the Client ID Enforcement populates the `Authentication.clientName` variable in the `Authentication` object that is used as a unique identifier for LLM Metrics. - -To remove the Client ID Enforcement policy, ensure that you either: - -* Apply a policy that populates `Authentication.clientName`: -+ -** xref:gateway::policies-included-client-id-enforcement.adoc[] -** xref:gateway::policies-included-rate-limiting-sla.adoc[] -** xref:gateway::policies-included-oauth-token-introspection.adoc[] (If Client ID enforcement is configured, `skipClientIdValidation=false`) -** xref:gateway::policies-included-openid-token-enforcement.adoc[] (If Client ID enforcement is configured, `skipClientIdValidation=false`) -** xref:gateway::policies-included-jwt-validation.adoc[] (If Client ID enforcement is configured, `skipClientIdValidation=false`) -** A custom policy that populates `Authentication.clientName` - -* Edit the DataWeave variable in Model Proxy Core to extract a different unique identifier, such as `clientid`, `userid`, or `departmentid`. -+ -NOTE: You can't filter by this unique identifier in Usage Reports. - -== See Also - -* xref:gateway::flex-gateway-secure-apis.adoc[] -* xref:gateway::policies-included-directory.adoc[] diff --git a/modules/ROOT/pages/model-proxy-request.adoc b/modules/ROOT/pages/model-proxy-request.adoc deleted file mode 100644 index 8039f6cbf..000000000 --- a/modules/ROOT/pages/model-proxy-request.adoc +++ /dev/null @@ -1,802 +0,0 @@ -= Sending Requests to Model Proxies -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy-request.adoc, gateway::flex-gateway-llm-proxy-request.adoc - -Model Proxy supports these endpoint formats: OpenAI, Gemini, and Anthropic. The format is selected when creating a Model Proxy and can't be changed later. - -* *<>*: Supports all LLM providers with multi-routing and fallback mechanisms. Supports both Chat Completions (`/chat/completions`) and Responses (`/responses`) endpoints. -* *<>*: Native Gemini API format. Doesn't support multi-routing or fallback mechanisms. -* *<>*: Native Anthropic API format. Doesn't support multi-routing or fallback mechanisms. - -[[retrieve-the-request-configuration-parameters]] -== Retrieve the Endpoint Configuration Parameters for Your Model Proxy - -To find your Model Proxy endpoint configuration and client application credentials required to use the requests in this guide: - -. Find your public endpoint: -.. From Anypoint Platform, navigate to *Runtime Manager* > *Omni Gateways*. -.. Click the name of the Omni Gateway where your Model Proxy is deployed. -.. Copy the *Public Endpoint*. -. Find your base path: -.. From the enhanced experience, select *Model Proxies*. -.. Click the name of the Model Proxy whose base path you want to find. -.. From *Configuration*, copy the *Base path*. -. Retrieve your client ID and client secret: -.. From the *Overview* page of your Model Proxy, click *Actions* > *View Model Proxy in Exchange*. -.. Click *Request access*. -.. Select the *API Instance* you want to request access to. -.. Select the *Application* you want to request access to. -.. Select the *SLA tier*. -.. Click *Request access*. -.. Copy the *Client ID* and *Client Secret*. - -[[openai-format]] -== OpenAI Format - -Learn more about the OpenAI request types: - -* https://developers.openai.com/api/reference/resources/chat[Chat Completions] API is designed for conversational multi-turn interactions rather than simple text continuation. -* https://developers.openai.com/api/reference/resources/responses[Responses] API is recommended unified interface for building powerful agent-like applications. - -All requests are designed to work for both strategies. When sending a request to a Model Proxy with either routing strategy, you can specify a model in the request. You don't have to modify the request for different routing strategies. Each routing strategy handles the model selection differently: - -* *Model-Based Routing*: The user specifies a model in the request (`"model": "openai/gpt-5.2"`). The Model Proxy acts as a direct proxy. If no model is specified, the Model Proxy sends the request to the fallback route or returns an error if no fallback route is configured. -* *Semantic Routing*: No model is specified in the request. The Model Proxy chooses which model to use based on the request content by matching it to prompt topics you define for each route. If a model is specified in the request, like in model routing examples, it is ignored. -+ -NOTE: Adding a model to a request ensures deterministic routing to a preferred backend if the routing strategy of a Model Proxy changes. - -=== Chat Completions API Validation Request Examples - -https://developers.openai.com/api/reference/resources/chat[Chat Completions] (/chat/completions) is the standard API for interacting with models. It is designed for conversational multi-turn interactions rather than simple text continuation. The endpoint requires a model and a messages list with roles (such as system, user, or assistant) to generate context-aware responses. - -These examples validate the basic functionality of the Chat Completions API. - -==== Basic Chat Completion Example - -This request example ensures the gateway correctly routes traffic to the specified LLM provider. - -In the example, the model-based routing request ensures the gateway routes traffic to a Gemini 2.0 model. For semantic routing, the gateway routes traffic to the most suitable provider based on the request content: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "developer", "content": "You are a helpful assistant" }, - { "role": "user", "content": "Hello, please introduce yourself" } - ] -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "developer", "content": "You are a helpful assistant" }, - { "role": "user", "content": "Hello, please introduce yourself" } - ] -}' ----- -==== - -==== Creative Content Generation Temperature Control Example - -This request example performs can preform brainstorming tasks, such as generating multiple unique marketing slogans. The example writes creative content using the temperature parameter (0 to 2 value, higher values are more creative) to control the randomness and creativity of the response: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "user", "content": "Write a creative story about AI" } - ], - "temperature": 1.5 -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "user", "content": "Write a creative story about AI" } - ], - "temperature": 1.5 -}' ----- -==== - -==== Multi-Turn Context Management Example - -This request example maintains conversation context across developer persona, user query, and assistant history. The example passes the "memory" of a conversation to ensure the model knows that "it" refers to "MuleSoft" based on the previous message in the thread: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "developer", "content": "You are a MuleSoft technical expert." }, - { "role": "user", "content": "What is MuleSoft?" }, - { "role": "assistant", "content": "MuleSoft is an integration platform that helps organizations connect applications, data, and devices." }, - { "role": "user", "content": "How does it help with API management?" } - ] -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "developer", "content": "You are a MuleSoft technical expert." }, - { "role": "user", "content": "What is MuleSoft?" }, - { "role": "assistant", "content": "MuleSoft is an integration platform that helps organizations connect applications, data, and devices." }, - { "role": "user", "content": "How does it help with API management?" } - ] -}' ----- -==== - -==== Structured Data Validation JSON Format Example - -This request example extracts patterns into structured JSON to transform a messy transcript into a clean JSON object for insertion into a database by using the `top_p` and `max_completion_tokens` parameters: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "user", "content": "Explain MuleSoft Integration patterns in JSON format" } - ], - "max_completion_tokens": 50000, - "top_p": 0.9 -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "user", "content": "Explain MuleSoft Integration patterns in JSON format" } - ], - "max_completion_tokens": 50000, - "top_p": 0.9 -}' ----- -==== - -==== Enterprise Strategy Testing Example - -This request example validates the gateway's ability to handle large-payload "Expert" prompts. The example asks an AI Solution Architect to design a migration strategy from legacy SAP systems to Salesforce using MuleSoft Anypoint Platform with an API-led connectivity approach. - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "developer", "content": "You are a MuleSoft solution architect helping with enterprise integrations." }, - { "role": "user", "content": "Design a data integration strategy for a Fortune 500 company migrating from legacy systems to Salesforce using MuleSoft Anypoint Platform. Include API-led connectivity approach." } - ], - "temperature": 0.7, - "max_completion_tokens": 10000 -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "developer", "content": "You are a MuleSoft solution architect helping with enterprise integrations." }, - { "role": "user", "content": "Design a data integration strategy for a Fortune 500 company migrating from legacy systems to Salesforce using MuleSoft Anypoint Platform. Include API-led connectivity approach." } - ], - "temperature": 0.7, - "max_completion_tokens": 10000 -}' ----- -==== - -==== Streaming API Call Example - -This example supports user-facing chatbot UIs where the text must appear word-by-word as it is generated, rather than waiting for the entire response to finish. This request example validates the gateway's ability to stream real-time non-buffered token delivery using the `--no-buffer` flag: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "user", "content": "Explain step-by-step MuleSoft integration process" } - ], - "stream": true -}' \ ---no-buffer ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "user", "content": "Explain step-by-step MuleSoft integration process" } - ], - "stream": true -}' \ ---no-buffer ----- -==== - -==== Tool Calling: Initial Request with Tool Definition Example - -This request example allows the model to request real-time information from the application by invoking a function. The example asks the model to invoke a `get_current_time` function to get the current time in San Francisco, The model recognizes it can't answer from memory and instead requests to invoke a `get_current_time` function from your local API. - - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "tool_choice": "auto", - "messages": [ - { "role": "user", "content": "What is the time in San Francisco?" } - ], - "tools": [ - { - "type": "function", - "function": { - "name": "get_current_time", - "description": "When user asks for time tell me to invoke this Tool", - "parameters": { - "type": "object", - "properties": { - "timezone": { "type": "string", "description": "Timezone of the user asked location" } - }, - "required": ["timezone"] - } - } - } - ] -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "openai/gpt-5.2", - "tool_choice": "auto", - "messages": [ - { "role": "user", "content": "What is the time in San Francisco?" } - ], - "tools": [ - { - "type": "function", - "function": { - "name": "get_current_time", - "description": "When user asks for time tell me to invoke this Tool", - "parameters": { - "type": "object", - "properties": { - "timezone": { "type": "string", "description": "Timezone of the user asked location" } - }, - "required": ["timezone"] - } - } - } - ] -}' ----- -==== - -==== Tool Calling: Request with Tool Execution Response Example - -This request example sends the executed tool output back to the Model Proxy to generate a final answer. The example provides the executed tool output (current time) back to the Model Proxy so the model can generate a natural-language response for the user: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "tool_choice": "auto", - "messages": [ - { "role": "user", "content": "What is the time in San Francisco?" }, - { - "role": "assistant", - "content": null, - "tool_calls": [ - { - "id": "call_KDrTKkRTGfylhkAO4A8s0pAO", - "type": "function", - "function": { - "name": "get_current_time", - "arguments": "{\"timezone\":\"America/Los_Angeles\"}" - } - } - ] - }, - { - "role": "tool", - "tool_call_id": "call_KDrTKkRTGfylhkAO4A8s0pAO", - "content": "2026-02-20T05:02:05.873534-08:00" - } - ], - "tools": [ - { - "type": "function", - "function": { - "name": "get_current_time", - "parameters": { - "type": "object", - "properties": { "timezone": { "type": "string" } }, - "required": ["timezone"] - } - } - } - ] -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "openai/gpt-5.2", - "tool_choice": "auto", - "messages": [ - { "role": "user", "content": "What is the time in San Francisco?" }, - { - "role": "assistant", - "content": null, - "tool_calls": [ - { - "id": "call_KDrTKkRTGfylhkAO4A8s0pAO", - "type": "function", - "function": { - "name": "get_current_time", - "arguments": "{\"timezone\":\"America/Los_Angeles\"}" - } - } - ] - }, - { - "role": "tool", - "tool_call_id": "call_KDrTKkRTGfylhkAO4A8s0pAO", - "content": "2026-02-20T05:02:05.873534-08:00" - } - ], - "tools": [ - { - "type": "function", - "function": { - "name": "get_current_time", - "parameters": { - "type": "object", - "properties": { "timezone": { "type": "string" } }, - "required": ["timezone"] - } - } - } - ] -}' ----- -==== - -==== Structured Output Validation JSON Schema Example - -This request example validates entity extraction into a strictly defined JSON Schema (CalendarEvent). The example asks the model to extract the event information from a plain text user query and return a formatted JSON object that adheres to the required schema. This prevents integration or parsing errors in downstream applications: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "messages": [ - { "role": "system", "content": "Extract the event information." }, - { "role": "user", "content": "Madhu Dileep and Santosh A are going to a AI Summit on 19th Feb 2026." } - ], - "response_format": { - "type": "json_schema", - "json_schema": { - "name": "CalendarEvent", - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Name of the event" }, - "date": { "type": "string", "description": "Date of the event, in MM-DD-YYYY format" }, - "participants": { "type": "array", "items": { "type": "string" } } - }, - "required": ["name", "date", "participants"] - } - } - } -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//chat/completions' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "gemini/gemini-3-flash-preview", - "messages": [ - { "role": "system", "content": "Extract the event information." }, - { "role": "user", "content": "Madhu Dileep and Santosh A are going to a AI Summit on 19th Feb 2026." } - ], - "response_format": { - "type": "json_schema", - "json_schema": { - "name": "CalendarEvent", - "schema": { - "type": "object", - "properties": { - "name": { "type": "string", "description": "Name of the event" }, - "date": { "type": "string", "description": "Date of the event, in MM-DD-YYYY format" }, - "participants": { "type": "array", "items": { "type": "string" } } - }, - "required": ["name", "date", "participants"] - } - } - } -}' ----- -==== - -=== Responses API Validation - -https://developers.openai.com/api/reference/resources/responses[OpenAI Responses API] (/responses)is recommended unified interface for building powerful, agent-like applications, combining capabilities from previous APIs (like Chat Completions and Assistants) into a single, more efficient endpoint. It is designed to be stateful by default and offers built-in access to advanced tools. - -==== Responses Endpoint for Model Context Protocol (MCP) - -This request example integrates the gateway with an external MCP server for automated action execution. The example asks an AI agent to search a specific internal Knowledge Base or update a Jira ticket using standardized tools defined on a remote MCP server: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//responses' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "input": [ - { "role": "system", "content": "You are helpful Service Agent" }, - { "role": "user", "content": "My Laptop screen is broken" } - ], - "tools": [ - { - "type": "mcp", - "server_label": "service_mcp", - "require_approval": "never", - "server_description": "Server enabled to do Service related actions", - "server_url": "https://ask-service-mcp-dvaz3u.c87dy0.usa-e2.cloudhub.io/mcp" - } - ] -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//responses' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "openai/gpt-5.2", - "input": [ - { "role": "system", "content": "You are helpful Service Agent" }, - { "role": "user", "content": "My Laptop screen is broken" } - ], - "tools": [ - { - "type": "mcp", - "server_label": "service_mcp", - "require_approval": "never", - "server_description": "Server enabled to do Service related actions", - "server_url": "https://ask-service-mcp-dvaz3u.c87dy0.usa-e2.cloudhub.io/mcp" - } - ] -}' ----- -==== - -==== Stateful Response Persistence - -This request example validates persistent memory by creating a dependency between two requests using `previous_response_id`. The example removes the need for the client to send the entire previous chat history on every turn, reducing bandwidth and improving security by keeping the context on client side: - -Request 1: Initial stored call:: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//responses' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "instructions": "You are helpful Service Knowledge Agent", - "input": [ { "role": "user", "content": "My Laptop screen is broken" } ], - "store": true -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//responses' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "openai/gpt-5.2", - "instructions": "You are helpful Service Knowledge Agent", - "input": [ { "role": "user", "content": "My Laptop screen is broken" } ], - "store": true -}' ----- - -==== - -Request 2: Follow-up using `previous_response_id` from the response to request 1:: - -[tabs] -==== -Semantic Routing:: -+ -[source,cli] ----- -curl --location '//responses' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "instructions": "You are helpful Service Agent", - "previous_response_id": "", - "input": [ { "role": "user", "content": "Thank you!" } ], - "store": true -}' ----- - -Model-Based Routing:: -+ -[source,cli] ----- -curl --location '//responses' \ ---header 'Content-Type: application/json' \ ---header 'client_id: ' \ ---header 'client_secret: ' \ ---data '{ - "model": "openai/gpt-5.2", - "instructions": "You are helpful Service Agent", - "previous_response_id": "", - "input": [ { "role": "user", "content": "Thank you!" } ], - "store": true -}' ----- -==== - -[[gemini-format-request-example]] -== Gemini Format - -The Gemini format uses the native Gemini API format. Note that this format doesn't support multi-routing or fallback mechanisms. - -=== Basic Chat Completion Example - -This request example ensures the gateway correctly routes traffic to the Gemini provider. - -[source,cli] ----- -curl --location '//models/gemini-2.5-flash:generateContent' \ - --header 'Content-Type: application/json' \ - --header 'client_id: ' \ - --header 'client_secret: ' \ - --data '{ - "contents": [ - { "role": "user", "parts": [{ "text": "Hello, please introduce yourself" }] } - ] - }' ----- - -=== Streaming API Call Example - -This example supports user-facing chatbot UIs where the text must appear word-by-word as it is generated rather than waiting for the entire response to finish. This request example validates the gateway's ability to stream real-time, non-buffered token delivery: - -[source,cli] ----- -curl --location '//models/gemini-2.5-flash:streamGenerateContent?alt=sse' \ - --header 'Content-Type: application/json' \ - --header 'client_id: ' \ - --header 'client_secret: ' \ - --data '{ - "contents": [ - { "role": "user", "parts": [{ "text": "Explain step-by-step MuleSoft integration process" }] } - ] - }' \ - --no-buffer ----- - -[[anthropic-format-request-example]] -== Anthropic Format - -The Anthropic format uses the native Anthropic API format. Note that this format doesn't support multi-routing or fallback mechanisms. - -=== Basic Chat Completion Example - -This request example ensures the gateway correctly routes traffic to the Anthropic provider. - -[source,cli] ----- -curl --location '//v1/messages' \ - --header 'Content-Type: application/json' \ - --header 'anthropic-version: 2023-06-01' \ - --header 'client_id: ' \ - --header 'client_secret: ' \ - --data '{ - "model": "claude-opus-4-1-20250805", - "max_tokens": 1024, - "system": "You are a helpful assistant", - "messages": [ - { "role": "user", "content": "Hello, please introduce yourself" } - ] - }' ----- - -=== Streaming API Call Example - -This example supports user-facing chatbot UIs where the text must appear word-by-word as it is generated, rather than waiting for the entire response to finish. This request example validates the gateway's ability to stream real-time non-buffered token delivery using the `--no-buffer` flag: - -[source,cli] ----- -curl --location '//v1/messages' \ - --header 'Content-Type: application/json' \ - --header 'anthropic-version: 2023-06-01' \ - --header 'client_id: ' \ - --header 'client_secret: ' \ - --data '{ - "model": "claude-opus-4-1-20250805", - "max_tokens": 2048, - "stream": true, - "messages": [ - { "role": "user", "content": "Explain step-by-step MuleSoft integration process" } - ] - }' \ - --no-buffer ----- - -[[amazon-bedrock-model-names]] -== Specify Amazon Bedrock Model Names in Requests - -Amazon Bedrock Claude models must be specified in Amazon Resource Name (ARN) format, for example: - ----- -bedrockanthropic/us.anthropic.claude-sonnet-4-5-20250929-v1:0 ----- - -Formatted as: - ----- -bedrockanthropic/.anthropic. ----- - -To find your region and model name for your Claude model, see https://docs.aws.amazon.com/bedrock/latest/userguide/inference-profiles-support.html[Supported Regions and models for inference profiles]. diff --git a/modules/ROOT/pages/model-proxy-semantic-service.adoc b/modules/ROOT/pages/model-proxy-semantic-service.adoc deleted file mode 100644 index 1c54376b4..000000000 --- a/modules/ROOT/pages/model-proxy-semantic-service.adoc +++ /dev/null @@ -1,100 +0,0 @@ -= Configuring Semantic Services -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy-semantic-service.adoc, gateway::flex-gateway-llm-proxy-semantic-service.adoc, exp-services-add-semantic.adoc - -Semantic services compare incoming requests to defined prompt topics to route traffic to the best-matching model path or block requests that match denylist topics. Model Proxy supports Basic Scale semantic services for simple routing and Advanced Scale semantic services for complex routing backed by an external vector database. Configure a semantic service before creating a model proxy that uses semantic routing. - -Model Proxy supports two types of semantic services: - -* <>: -+ -For complex semantic routing. Advanced scale semantic services use a vector database to store and compare prompt topic utterances. Advanced scale semantic services support unlimited prompt topics and 2000 utterances per prompt topic. -* <>: -+ -For simple semantic routing and blocking. Basic scale semantic services support up to 6 prompt topics and 10 utterances per prompt topic. - -== Before You Begin - -Before getting started, make sure you have: - -* An Anypoint Platform account. -* One of these permissions: -+ --- -** Exchange: Exchange Contributor -** Exchange: Exchange Administrator -** Exchange: Exchange Creator --- -+ -For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. - -[[configure-an-advanced-scale-semantic-service]] -== Configure an Advanced Scale Semantic Service - -. In the navigation pane, select *Model Proxies* > *Semantic Services*. -. Click *Add Semantic Service* > *Semantic Routing Service*. -. Select *Advanced Scale*. -+ -Advanced scale supports large utterance sets per topic and requires a dedicated external vector database connection. -. Configure the embedding connection parameters: -** *Environment*: The environment to use for the semantic service. -** *Embedding service provider*: The provider of the embedding model. Select from these options: -*** *OpenAI* -*** *Hugging Face* -*** *Azure OpenAI*. -** *Service label*: Label to identify the new service. Shown as the label in the Semantic Services catalog. -** *URL*: The URL of the embedding service. -** *Model*: The embedding model to use. -** *Auth key*: The API authentication key for the embedding service. -. Configure the vector connection parameters: -** *Environment*: The environment to use for the vector database. -** *Vector Database provider*: The provider of the vector database. Select from these options: -*** *Qdrant* -*** *Pinecone* -*** *Azure AI Search* -** *Host*: The host URL of your vector database. -** *API Key*: The API authentication key for the vector database. -** *Collection*: The collection name in your vector database. -. Define prompt topics: -+ -Supports up to 2000 utterances per topic. -+ -.. Click *Create Prompt Topic*. -.. Define a *Prompt topic name*. -.. Define prompt utterances or click *Upload utterances* to upload a plain text file containing your prompt utterances. -.. Create as many prompt topics as necessary. You can also create new prompt topics later by editing the semantic service. -+ -NOTE: To deny users from asking about certain subjects, create prompt topics for the subjects and apply them as deny list topics when configuring your Model Proxy. -. Click *Save & Download Script*. -. Open the downloaded `.sh` script file in your database to populate it with your scaled vectors. - -[[configure-a-basic-scale-semantic-service]] -== Configure a Basic Scale Semantic Service - -. In the navigation pane, click the *Model Proxies* dropdown arrow. -. Select *Semantic Services*. -. Click *Add Semantic Service* > *Semantic Routing Service*. -. Select *Basic Scale*. -+ -Basic scale supports up to six topics and 10 utterances per topic. Managed via internal Model Proxy configuration. -. Configure the embedding connection parameters: -** *Environment*: The environment to use for the semantic service. -** *Embedding service provider*: The provider of the embedding model: *OpenAI*, *Hugging Face*, or *Azure OpenAI*. -** *Service label*: Label to identify the new service. Shown as the label in the Semantic Services catalog. -** *URL*: The URL of the embedding service. -** *Model*: The embedding model to use. -** *Auth key*: The API authentication key for the embedding service. -. Click *Save*. - -== Edit a Semantic Service - -To edit a semantic service: - -. From *Semantic Service Setup*, click the three-dots menu (image:gateway::image$three-dots-menu.png[3%,3%]) of the semantic service you want to edit. -. Make the necessary edits. -. Click either *Save* or *Save & Download Script* depending on your sematic service. -+ -If creating new prompt topics for an advanced scale semantic service, you must download and run the vector script in your database again. \ No newline at end of file diff --git a/modules/ROOT/pages/model-proxy-token-reports.adoc b/modules/ROOT/pages/model-proxy-token-reports.adoc deleted file mode 100644 index 463a59ddd..000000000 --- a/modules/ROOT/pages/model-proxy-token-reports.adoc +++ /dev/null @@ -1,44 +0,0 @@ -= Viewing Token Usage and Model Proxy Metrics -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy-token-reports.adoc, gateway::flex-gateway-llm-proxy-token-reports.adoc - - -Token Usage reports and API Manager insights help you monitor how your model proxies consume resources and perform over time. Token Usage reports show the number of API tokens consumed per model, broken down by business group or application. The API Manager LLM Summary page provides hourly metrics including request volume, policy violations, errors, and average response time. For deeper analysis, you can build custom dashboards in Anypoint Monitoring. - -[[view-token-usage-reports]] -== View Token Usage Reports for Model Proxies - -With Token Usage reports, you can view the amount of API tokens each Model Proxy uses for individual models. - -NOTE: To limit token usage, apply the xref:gateway::policies-included-llm-token-rate-limit.adoc[] to your Model Proxy. - -To view token usage reports: - -. In Anypoint Platform, click your Anypoint Platform profile icon (with your initials). -. Click *Usage Reports*. -. Select *Model Proxy* for *Product*. -. Filter between *Usage by Business Group* and *Usage by Application* to see how tokens are consumed. - -To learn more about Usage Reports, see xref:general::usage-reports.adoc[]. - -NOTE: Gemini models use reasoning tokens. This number is included in *Total tokens* but isn't individually listed. - -[[view-api-manager-insights]] -== View Model Proxy Metrics in API Manager - -The API Manager LLM Summary page provides these metrics for your Model Proxy: - -* Total requests per hour -* Total policy violations per hour -* Total errors per hour -* Average response time per hour - -To view the LLM Summary page for a Model Proxy: - -. From API Manager, click *Model Proxies*. -. Click the name of the Model Proxy you want to view. - -To view more detailed metrics and build custom dashboards, click *View more metrics in Anypoint Monitoring dashboard*. diff --git a/modules/ROOT/pages/model-proxy-try-out.adoc b/modules/ROOT/pages/model-proxy-try-out.adoc deleted file mode 100644 index 43ee51fa2..000000000 --- a/modules/ROOT/pages/model-proxy-try-out.adoc +++ /dev/null @@ -1,27 +0,0 @@ -= Test a Model Proxy -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy-try-out.adoc, gateway::flex-gateway-llm-proxy-try-out.adoc - -The try out feature lets you validate your model proxy configuration by testing mock LLM prompts without making external API requests. You can verify response messages, response headers, the routing path, and which model services each request. The feature is available only for model proxies configured with OpenAI input format. - -With this feature, you can verify: - -* What response message your model proxy returns. -* What response headers are returned. -* What model services the response is routed to. -* Why a request is sent to a specific route. - -NOTE: The Try Out feature only supports Model Proxies configured with OpenAI input format. For Model Proxies configured with Gemini or Anthropic native formats, use the request examples in xref:model-proxy-request.adoc[] to test your proxy. - -To test your model proxy: - -. From API Manager in Anypoint Platform, click *Model Proxies*. -. Click the name of the model proxy you want to test. -. Click *Try out*. -. Configure any authentication or other headers your request requires. -. Enter your test prompt. -. Click *Run test*. -. View the *LLM response*, *Response headers*, and *Test result* for details about your test request. diff --git a/modules/ROOT/pages/model-proxy.adoc b/modules/ROOT/pages/model-proxy.adoc deleted file mode 100644 index e33c022a1..000000000 --- a/modules/ROOT/pages/model-proxy.adoc +++ /dev/null @@ -1,94 +0,0 @@ -= Creating and Managing Model Proxies -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] -:imagesdir: ../assets/images -:page-aliases: gateway::llm-proxy.adoc, gateway::flex-gateway-llm-proxy.adoc - -Model Proxy provides a unified access layer for multiple Large Language Model (LLM) providers. Model Proxies are deployed to Omni Gateway to enable governance, intelligent routing, and cost management for AI applications. - -Model Proxy is supported on Managed Omni Gateway and Self-Managed Omni Gateway running in Connected Mode. - -By creating a proxy, the user defines a singular LLM service that can receive requests for multiple LLM providers. This simplifies the developer experience. You can seamlessly add new models to the service without changing the endpoint. - -image::model-proxy.png["A Model Proxy with a single endpoint routing requests to multiple LLM providers"] - -[[supported-endpoint-formats]] -== Supported Endpoint Formats - -Model Proxy supports these endpoint formats that are selected when creating a Model Proxy and can't be changed later: - -* *OpenAI*: The OpenAI API format works with all supported LLM providers and supports multi-routing and fallback mechanisms. -* *Gemini*: The native Gemini API format for direct Google Gemini model requests. Doesn't support multi-routing or fallback mechanisms. -* *Anthropic*: The native Anthropic API format for direct Anthropic Claude model requests. Doesn't support multi-routing or fallback mechanisms. - -Depending on configuration, the proxy then sends the request to the model defined by the user or dynamically sends the request to the provider that best matches the request: - -* <>: Static routing. The user specifies what model the Model Proxy should send the request to. -* <>: Dynamic routing. The Model Proxy chooses which model to send the request to based on the request content. - -[[supported-llm-providers]] -== Supported LLM Providers - -Model Proxy supports these LLM Providers and API endpoints: - -[%header%autowidth.spread,cols="a,a,a,a"] -|=== -| LLM Provider | Model | `/chat/completions` | `/responses` -.8+|OpenAI and Azure OpenAI -|gpt-5.2 | Yes | Yes -|gpt-5.2-pro | Yes | Yes -|gpt-5-mini | Yes | Yes -|gpt-5.2-codex | Yes | Yes -|gpt-5-nano | Yes | Yes -|gpt-5 | Yes | Yes -|gpt-4.1 | Yes | Yes -|gpt-4o-mini | Yes | Yes - -.4+|Gemini -|gemini-3-flash-preview | Yes | Yes -|gemini-2.5-flash | Yes | Yes -|gemini-2.5-flash-preview-09-2025 | Yes | Yes -|gemini-2.5-flash-lite | Yes | Yes - -.10+| Anthropic and Bedrock Anthropic -| Claude Sonnet 4.6 | Yes | Yes -| Claude Opus 4.6 | Yes | Yes -| Claude Opus 4.5 | Yes | Yes -| Claude Haiku 4.5 | Yes | Yes -| Claude Sonnet 4.5 | Yes | Yes -| Claude Opus 4 | Yes | Yes -| Claude Sonnet 4 | Yes | Yes -| Claude Sonnet 3.7 | Yes | Yes -| Claude Sonnet 3.5 | Yes | Yes -| Claude Haiku 3.5 | Yes | Yes - -.3+| NVIDIA Nemotron -| Nemotron 3 Nano 30B A3B | Yes | Yes -|Nemotron 3 Super 120B A12B | Yes | Yes -|Llama Nemotron Ultra 253B | Yes | Yes -|=== - -[[model-based-routing]] -== Model-Based Routing - -Model-based routing is static routing. In the request, the user specifies what model the Model Proxy should send the request to. By specifying a target model, Model Proxy can override the model version provided by the user. - -[[semantic-routing]] -== Semantic Routing - -Semantic routing is dynamic routing where the Model Proxy chooses which model to send the request to. For Sematic Routing, the user creates prompt topics for each route. When a request is sent to the Model Proxy, a semantic service compares the request to the define topic utterances and sends the request to the route that best matches it. - -[[connections-and-model-proxies]] -== Connections and Model Proxies - -Model Proxy includes these types: - -* *Proxy*: A proxy configuration that can route requests to one or multiple LLM providers by using model-based routing and semantic routing strategies. The enhanced experience manages proxy configurations. - -* *Connection*: A connection configuration that stores credentials and metadata for connecting to a specific LLM provider. The enhanced experience displays connections as a single-route proxy. Connection configurations are managed by external projects, such as an Agent Network project. - -[[model-proxy-limits]] -== Model Proxy Limits - -Up to 50 Model Proxies are supported per Large Omni Gateway.