diff --git a/modules/ROOT/images/enhanced-experience-pillars.png b/modules/ROOT/images/enhanced-experience-pillars.png new file mode 100644 index 000000000..0e934f12b Binary files /dev/null and b/modules/ROOT/images/enhanced-experience-pillars.png differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 7435a0d69..646241636 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,5 +1,34 @@ .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-ai-assistant-troubleshoot.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-services-view-details.adoc[] + ** xref:exp-scanners-add-from-providers.adoc[] + *** xref:exp-scanners-manage.adoc[] + ** xref:exp-providers-manage.adoc[] + ** xref:exp-instances-add.adoc[] + ** xref:exp-governance-work-with-strategies.adoc[] + *** xref:exp-governance-create-strategy.adoc[] + *** xref:exp-governance-strategies-manage.adoc[] + *** xref:exp-governance-view-cost-and-token-usage.adoc[] + ** xref:exp-services-monitoring.adoc[] + ** xref:exp-services-view-detailed-metrics.adoc[] + ** xref:exp-alerts-configure-notifications.adoc[] + ** xref:exp-slack-access.adoc[] + ** xref:exp-claude-desktop-connect.adoc[] + ** xref:exp-troubleshoot.adoc[] * xref:learning-map-mulesoft-ai.adoc[] * xref:learning-map-agent-fabric.adoc[Agent Fabric] ** xref:agent-fabric-release-notes.adoc[] diff --git a/modules/ROOT/pages/exp-ai-assistant-troubleshoot.adoc b/modules/ROOT/pages/exp-ai-assistant-troubleshoot.adoc new file mode 100644 index 000000000..80f9424b6 --- /dev/null +++ b/modules/ROOT/pages/exp-ai-assistant-troubleshoot.adoc @@ -0,0 +1,299 @@ += Troubleshoot the AI Assistant + +If you experience issues using the Ask MuleSoft 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, LLM 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). + +== Confirmation Prompts Don't Appear + +If the assistant describes an action but doesn't show a confirmation prompt: + +Check for permissions issues: + +. The assistant may detect that you don't have permission and skip the confirmation. +. Review any messages from the assistant explaining why the action can't be performed. + +Verify the action type: + +. Some responses are informational only and don't require confirmation. +. Only actions that navigate, create, update, or delete data show confirmation prompts. + +Refresh and retry: + +. Refresh the page and try the request again. +. Rephrase your request more explicitly: "Apply a rate limit policy to my API instance." + +== Form Assistance Doesn't Work + +If the assistant can't help fill in forms: + +Check that a form is open: + +. Form assistance only works when you have an active form visible on the page. +. Navigate to the form (for example, "Add Instance" or "Create Governance Strategy") before asking for help. + +Be specific about what you want: + +. Tell the assistant exactly what values to use: "Set the instance URL to https://api.example.com/v1." +. Provide all required information for the form fields. + +Confirm changes manually: + +. Review the confirmation banner carefully before accepting form changes. +. Remember that form assistance only fills in fields—you still need to submit the form. + +== 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. + +== Suggestions Aren't Showing + +If suggestion chips don't appear after the assistant responds: + +Check response completeness: + +. Wait for the assistant's full response to complete. +. Suggestions appear after the assistant finishes streaming the response. + +Check context: + +. Suggestions are context-aware. If no relevant suggestions exist for your current situation, the assistant may not show any. +. Try asking a more specific question that has clear follow-up actions. + +Refresh the conversation: + +. Scroll to the bottom of the chat panel to ensure suggestions are visible. +. If the chat panel is too small, expand it or use the full-screen AI assistant page. + +== 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 Isn't Visible + +If you can't find the AI assistant panel or icon: + +Check the page layout: + +. Look for an icon on the right side of the screen or in the main navigation. +. Try different screen sizes—some layouts may move the assistant to different locations. + +Check feature availability: + +. Verify that the AI assistant is enabled for your organization. +. Ask your administrator if the feature is available in your business group. + +Check browser compatibility: + +. Ensure you're using a supported browser version. +. Update your browser if necessary. +. Disable browser extensions that might hide UI elements. + +== 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." + +== Getting 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-home-start.adoc[] +* xref:exp-overview.adoc[] diff --git a/modules/ROOT/pages/exp-ai-assistant-use.adoc b/modules/ROOT/pages/exp-ai-assistant-use.adoc new file mode 100644 index 000000000..c68e656e5 --- /dev/null +++ b/modules/ROOT/pages/exp-ai-assistant-use.adoc @@ -0,0 +1,482 @@ += Use the AI Assistant (Ask MuleSoft) + +The enhanced experience includes an AI assistant called Ask MuleSoft 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. + +== What Ask MuleSoft Can Do + +The AI assistant provides context-aware help based on where you are in the enhanced experience: + +Portfolio Management:: ++ +* Search for agents, APIs, MCP servers, LLM 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. + +== Before You Begin + +Before using the AI assistant, make sure you have: + +* An Anypoint Platform account with access to the enhanced experience +* Mule Developer Generative AI User permission to send prompts to the agent + +The AI assistant respects your Access Management permissions and can only perform actions you're authorized to do. If you want the assistant to help with specific tasks like creating governance strategies or managing services, you also need the appropriate permissions for those actions. + +For more information, see xref:exp-start-home.adoc#permissions[Enhanced Experience Permissions]. + +== Access the AI Assistant + +The AI assistant is available from every page in the enhanced experience. + +. Look for the AI assistant icon or panel. +. Select the icon to open the chat panel. +. Type your question or request in the message box. +. Press Enter or select the send button. + +The assistant responds with relevant information, suggestions, or actions you can take. + +[TIP] +You can also use the AI assistant as a dedicated full-screen page by clicking *Open full view* in the Ask MuleSoft menu. + +== 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 LLM 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. +. Select *Confirm* to navigate, or *Cancel* to stay on the current page. ++ +If you confirm, the page navigates to the destination. + +=== 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. The AI assistant performs the exact action you confirm. + +=== 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. + +== Context-Aware Responses + +The AI assistant tailors its responses based on: + +Current Page:: ++ +When you ask questions from a specific page (such as an API detail page or the monitoring dashboard), the assistant prioritizes information relevant to that context. + +Available Features:: ++ +The assistant only suggests actions and features available to your subscription tier. If you have API Portfolio Access, it focuses on API-related capabilities. If you have Agent + API Portfolio Access, it includes agent-specific features. + +Your Permissions:: ++ +The assistant respects your Access Management permissions. It won't suggest actions you don't have permission to perform. + +Active Services:: ++ +When viewing a service detail page, the assistant knows which service you're looking at and can answer questions about that specific service. + +Open Forms:: ++ +When you have a form open, the assistant can help fill in form fields based on your requirements. + +=== Example: Context-Aware Help + +On the APIs catalog page: + +* Prompt: `Show me APIs with errors` +* Assistant: `Here are the APIs with recent errors...` + +On a specific API detail page: + +* You: `Show me errors` +* Assistant: `Here are the recent errors for Payment Processing API...` + +== Search with Natural Language + +Use the AI assistant to search your portfolio using natural language descriptions: + +Semantic Search:: ++ +Describe what you're looking for conceptually, and the assistant finds matching services based on capabilities and descriptions, not just exact name matches. ++ +[source,text] +---- +Find services that handle payments +---- ++ +[source,text] +---- +Show me agents that use GPT-4 +---- ++ +[source,text] +---- +Which APIs expose customer data? +---- ++ +[source,text] +---- +Find MCP servers for database operations +---- + +Filtered Search:: ++ +Ask for services with specific characteristics: ++ +[source,text] +---- +Show me production APIs with rate limiting policies +---- ++ +[source,text] +---- +Find staging agents with high token usage +---- ++ +[source,text] +---- +Which services don't have governance strategies applied? +---- ++ +[source,text] +---- +Show me APIs registered in the last week +---- + +== 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. + +== Troubleshooting with the AI Assistant + +The AI assistant can help diagnose and resolve issues: + +[source,text] +---- +Why isn't my policy being enforced? +---- + +[source,text] +---- +My instance shows a connection error, what should I check? +---- + +[source,text] +---- +Why can't I see monitoring data for my service? +---- + +[source,text] +---- +My scanner failed, how do I fix it? +---- + +The assistant reviews your configuration, identifies potential issues, and suggests fixes. + +== 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. + +== Tips for Advanced Use + +Combine with Manual Actions:: ++ +Use the assistant for discovery and research, then perform detailed configuration manually when you need precise control. + +Explore Capabilities:: ++ +Ask "What can you help me with?" to learn about available features for your current context. + +Check Status:: ++ +Regularly ask for summaries: "Show me my portfolio health status" or "What governance issues need attention?" + +Automate Repetitive Tasks:: ++ +Use the assistant for tasks you perform frequently, like checking monitoring data or reviewing compliance reports. + +Learn Features:: ++ +Ask the assistant to explain features: "What is tool mapping?" or "How do governance strategies work?" + +== See Also + +* xref:exp-ai-assistant-troubleshoot.adoc[] +* xref:exp-start-home.adoc[] +* xref:exp-overview.adoc[] +* xref:exp-view-portfolio-overview.adoc[] +* xref:exp-monitor-your-services.adoc[] +* xref:exp-work-with-governance-strategies.adoc[] diff --git a/modules/ROOT/pages/exp-alerts-configure-notifications.adoc b/modules/ROOT/pages/exp-alerts-configure-notifications.adoc new file mode 100644 index 000000000..2ddf02dcc --- /dev/null +++ b/modules/ROOT/pages/exp-alerts-configure-notifications.adoc @@ -0,0 +1,53 @@ += Configure Notifications for Alerts + +Route API and runtime alerts from Anypoint Platform into channels your team monitors, such as email, Slack, or ticketing integrations your administrator configured. Connect alerts to the enhanced experience so responders can jump directly from a signal into *Portfolio* or *Observability*. + +Delivery channels and alert types depend on API Manager, Runtime Manager, and any add-on connectors your organization purchased. You configure the subscription side in those products; the enhanced experience surfaces links and context when your entry path integrates them. + +== Before You Begin + +Before getting started, make sure you have: + +* An Anypoint Platform account. +* Any of these permissions to view alerts: ++ +** API Manager: View API Alerts +** Runtime Manager: Read Alerts +* Any of these permissions to manage alerts: ++ +** API Manager: Manage API Alerts +** Runtime Manager: Manage Alerts + +For more information, see xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions]. + +== Alert Configuration + +* Who receives alerts ++ +Assign viewers or managers for API alerts in API Manager and for runtime alerts in Runtime Manager. +* Severity and routing ++ +Map critical alerts to high-priority channels and informational alerts to lower-noise destinations to reduce noise for your team. +* Deep links ++ +When your organization uses Slack or another integrated client, follow notifications back into the enhanced experience using the shortcuts your administrator enabled. + +Find detailed steps in the +xref:runtime-manager::alerts-on-runtime-manager.adoc[Runtime Manager alerts] and +xref:api-manager::add-api-alert-task.adoc[API Manager instance alerts] documentation. + +== Relate Alerts to Portfolio Work + +When an alert references a service you govern in the enhanced experience, open the service from *Portfolio* and review *Monitoring*, *Policies*, and *Instances* together. +xref:exp-services-monitoring.adoc[Monitoring] explains how service-level signals relate to organization-wide observability. + +== Permissions Overview + +Managing alert subscriptions requires *API Manager* > *Manage API Alerts* or *Runtime Manager* > *Manage Alerts*. Viewing alerts uses the corresponding view permissions. See xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] for how those roles appear in access guides. + +== 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 new file mode 100644 index 000000000..fdd4e4b8f --- /dev/null +++ b/modules/ROOT/pages/exp-claude-desktop-connect.adoc @@ -0,0 +1,34 @@ += Connect the Enhanced Experience to Claude Desktop + +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. + +== See Also + +* xref:exp-home-start.adoc[] +* xref:exp-slack-access.adoc[] +* xref:exp-overview.adoc[] diff --git a/modules/ROOT/pages/exp-compare.adoc b/modules/ROOT/pages/exp-compare.adoc new file mode 100644 index 000000000..deb805a96 --- /dev/null +++ b/modules/ROOT/pages/exp-compare.adoc @@ -0,0 +1,73 @@ += Enhanced MuleSoft Experience and Anypoint Platform Comparison + +Both the enhanced MuleSoft experience and Anypoint Platform include robust capabilities, but they emphasize different strengths, especially if you manage AI assets such as agents, LLM proxies, and MCP servers next to APIs and gateways. + +Adopting the new experience gives you a fuller way to manage and optimize AI assets, with the flexibility and governance modern AI-driven environments need. You configure AI policies and map relationships among assets 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, LLM 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 assets 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 Ask MuleSoft assistant targets setup, questions, and recommendations across the assets 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, open the relevant asset in the enhanced experience to review its compliance details alongside the design. + +| Policy enforcement and governance +| Enhanced MuleSoft experience +a| +The new experience excels in applying and managing governance policies across agents, APIs, and other assets 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 assets 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 assets. +|=== + +== See Also + +* xref:exp-overview.adoc[] +* xref:exp-home-start.adoc[] diff --git a/modules/ROOT/pages/exp-glossary.adoc b/modules/ROOT/pages/exp-glossary.adoc new file mode 100644 index 000000000..9f4dde2b5 --- /dev/null +++ b/modules/ROOT/pages/exp-glossary.adoc @@ -0,0 +1,93 @@ += Enhanced MuleSoft Experience Glossary + +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. + +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. + +Ask MuleSoft:: +The embedded agentic experience built into the enhanced MuleSoft experience UI. Use Ask MuleSoft 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. + +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 > 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 LLM proxies. + +LLM Proxy:: +A gateway-backed service that routes requests to a large language model. LLM proxies register in the LLM 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, LLM 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. + +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 new file mode 100644 index 000000000..9e2120ce8 --- /dev/null +++ b/modules/ROOT/pages/exp-governance-create-strategy.adoc @@ -0,0 +1,78 @@ += Create Governance Strategies + +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 when 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 wizard. + +The wizard guides you through type, scope, rules or policies, and activation. + +== Select Strategy Type + +Choose 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 + +Specify which services that the strategy governs and under what conditions those services are included. + +Use *Select Filter Criteria* to Refine the scope by tag, environment, or other available metadata. + +Use *Preview Governed Scope* to see which services currently match your criteria before you move forward. + +== Configure Rules or Policies + +Depending on the strategy type, select the rules 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 entitlements. + +== 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. You can disable a strategy later from *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 your strategies affect production services or if you need to coordinate rollout timing. + +== See Also + +* xref:exp-governance-work-with-strategies.adoc[] +* xref:exp-governance-strategies-manage.adoc[] +* xref:exp-governance-view-cost-and-token-usage.adoc[] +* xref:exp-services-view-details.adoc[] diff --git a/modules/ROOT/pages/exp-governance-strategies-manage.adoc b/modules/ROOT/pages/exp-governance-strategies-manage.adoc new file mode 100644 index 000000000..e71cb1f4b --- /dev/null +++ b/modules/ROOT/pages/exp-governance-strategies-manage.adoc @@ -0,0 +1,61 @@ += Managing Governance Strategies + +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 name, type, status, governed services, 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 filter to select *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. + +== Reasons to Adjust 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-view-cost-and-token-usage.adoc b/modules/ROOT/pages/exp-governance-view-cost-and-token-usage.adoc new file mode 100644 index 000000000..c4f0e12d3 --- /dev/null +++ b/modules/ROOT/pages/exp-governance-view-cost-and-token-usage.adoc @@ -0,0 +1,86 @@ += Viewing Cost and Token Usage + +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 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 + +Navigation labels can vary by release. + +== 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, estimated*: 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 1H, 6H, 24H, 7D, or 30D to search per time range. + +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-strategies-manage.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 new file mode 100644 index 000000000..5672db0cc --- /dev/null +++ b/modules/ROOT/pages/exp-governance-work-with-strategies.adoc @@ -0,0 +1,48 @@ += Working with Governance Strategies + +Use governance strategies to apply rules and policies across agents, APIs, MCP servers, LLM proxies, and gateways. You can create, manage, and monitor strategies when your tenant includes *Governance* and your account has the required role. Use strategies to validate service compliance, automate runtime enforcement, and maintain visibility as your portfolio grows. + + +== 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-strategies-manage.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[]. + +== Required Permissions + +Creating strategies typically requires the Governance Administrator role. You can view reports with the Governance Viewer or Governance Administrator role, depending on how your organization maps roles. + +== See Also + +* xref:exp-governance-create-strategy.adoc[] +* xref:exp-governance-strategies-manage.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 new file mode 100644 index 000000000..d765754a0 --- /dev/null +++ b/modules/ROOT/pages/exp-home-start.adoc @@ -0,0 +1,104 @@ += Get Started with the Enhanced Experience +: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, Slack, 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 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, Slack, or a connected coding assistant, from the networks and locations you use. + +Platform and Product Access:: ++ +* Confirm that your organization has the entitlements required 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 MuleSoft account team or Anypoint Platform organization administrator. +* Confirm that required integrations with Anypoint Platform, Slack, 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*, *LLM 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*, *LLM 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 LLM 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 new file mode 100644 index 000000000..0511e35e8 --- /dev/null +++ b/modules/ROOT/pages/exp-instances-add.adoc @@ -0,0 +1,109 @@ += Creating and Managing Instances + +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 LLM 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 Instances Experience + +. In *Portfolio*, open the catalog for the service type, such as *APIs*, *Agents*, *MCP Servers*, or *LLM 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. + +== API Instances + +Register APIs as services defined by formal specifications and manage them alongside other service types in the enhanced experience. + +Creating an API establishes its structure and makes it available in the portfolio, while instances represent deployed or managed versions of that API across environments or providers. + +=== Create an API + +To create an API, add it to the APIs catalog either 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) + +=== View API Details + +After creating or selecting an API, the detail page displays multiple views that expose its structure, runtime state, and governance status. + +The API detail view is organized into tabs: + +* *Overview* – Displays API structure and metadata +* *Instances* – Lists and manages API instances +* *Monitoring* – Displays performance metrics +* *Policies* – Displays applied policies +* *Conformance Report* – Displays governance status +* *Versions* – Displays available API versions + +NOTE: Manage monitoring, policies, and conformance details in their respective sections. + +==== Overview Tab + +The *Overview* tab displays information derived from the API specification. + +Depending on the API type, this includes: + +* Endpoints or resources defined in the API +* Available methods, such as GET, POST, PUT, and DELETE +* Request and response details +* Parameters and headers +* Example requests and responses +* Data types and schemas +* Security definitions + +This view reflects the structure and behavior defined in the uploaded specification. + +== After You Create or Change 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. +* 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. + +== Required Permissions + +Creating instances uses Anypoint Platform permissions such as API Creator for API-related flows. Viewing or editing instance configuration requires the corresponding permissions defined by your organization. See xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] for role details. + +== 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 new file mode 100644 index 000000000..939c97ab4 --- /dev/null +++ b/modules/ROOT/pages/exp-overview.adoc @@ -0,0 +1,60 @@ += Enhanced MuleSoft Experience Overview + +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, Slack, 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 assets 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 assets: + +Entity Management:: Register and manage agents, REST and GraphQL APIs, MCP servers, LLM 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 (Ask MuleSoft):: 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 assets, 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 depend on the experience in production. +. 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 assets, apply policies, read health signals, and manage providers. Access the AI assistant from any page to get guided help and answer questions. +. Register assets in *Portfolio*. ++ +Under *Portfolio*, open *Agents*, *MCP Servers*, *LLM 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*, *LLM 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 experience supports. +. Monitor run-time 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 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. +. Operate and tune the portfolio. ++ +Coordinate agents, APIs, gateways, MCP servers, and LLM 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-home-start.adoc[] +* xref:exp-compare.adoc[] +* xref:learning-map-exp.adoc[] diff --git a/modules/ROOT/pages/exp-portfolio-overview.adoc b/modules/ROOT/pages/exp-portfolio-overview.adoc new file mode 100644 index 000000000..c7f266549 --- /dev/null +++ b/modules/ROOT/pages/exp-portfolio-overview.adoc @@ -0,0 +1,48 @@ += View Your Portfolio Overview + +Use portfolio-level views to see how your agents, APIs, MCP servers, LLM proxies, and gateways fit together before you drill into a single service. Summaries help you spot gaps in registration, policy coverage, or health signals your organization cares about. + +The exact layout depends on how your administrator configured your tenant and which catalogs they enabled. Labels and widgets differ by release. + +== Before You Begin + +Before getting started, make sure you have: + +* An Anypoint Platform account. +* Any 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 sign-in, your landing page sometimes highlights portfolio activity, shortcuts into *Portfolio*, or high-level counts your organization chose to show. +* *Portfolio* ++ +Browse catalogs for *Agents*, *APIs*, *MCP Servers*, *LLM 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 a catalog or a summary you expect, confirm entitlements and permissions with your Anypoint Platform organization administrator. See xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] for more information. + +== Overview + +* Coverage ++ +Which service types your team has registered and which environments or instances they map to. +* Health and cost signals ++ +Summary metrics or badges if the experience exposes them at list level (for example status or daily cost on cards). +* Next actions ++ +Entry points to add services, connect providers, or open governance and observability areas described in xref:exp-overview.adoc[]. + +== 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 new file mode 100644 index 000000000..e0c7817aa --- /dev/null +++ b/modules/ROOT/pages/exp-providers-manage.adoc @@ -0,0 +1,93 @@ += Viewing Providers + +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 lists. + +== 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. + +== View All Scanners + +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. The main panel displays the scanner list. + +== View Scanner Details + +To see detailed information about a scanner, including scan history and settings, select the scanner name in the scanner list. The scanner detail page opens with two tabs: + +Overview:: +Displays services count, instances count, and scan history. Each scan history entry shows status (Success, Failed), timestamp, and number of new services discovered. + +Settings:: +Shows scanner configuration including provider, created date, last scanned time, and services count. Use this tab to modify scanner settings or delete the scanner. + +For information about managing scanners, see xref:exp-scanners-manage.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. + +For detailed scanner setup instructions, see xref:exp-scanners-add-from-providers.adoc[]. + +== Supported Providers + +The enhanced experience supports connections to these providers: + +* Amazon +* Anthropic +* Databricks +* GoDaddy ANS +* Google Cloud +* Kong Konnect +* Langchain +* Microsoft +* Snowflake + +The specific providers available depend on your organization's entitlements and the enhanced experience configuration. + +== See Also + +* xref:exp-services-connect-providers-to-add.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 new file mode 100644 index 000000000..760f0fabb --- /dev/null +++ b/modules/ROOT/pages/exp-release-notes.adoc @@ -0,0 +1 @@ +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 new file mode 100644 index 000000000..595bda552 --- /dev/null +++ b/modules/ROOT/pages/exp-scanners-add-from-providers.adoc @@ -0,0 +1,64 @@ += Adding Scanners from Providers + +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. 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 entitlements. + +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]. + +== 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. + +== 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. +* *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. + +Exact labels and options can vary by release; follow the UI your organization provides. + +== 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 entitlements 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 ongoing operations (pause, edit, or delete), see xref:exp-scanners-manage.adoc[]. + +== See Also + +* xref:exp-services-connect-providers-to-add.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 new file mode 100644 index 000000000..7c0b706ab --- /dev/null +++ b/modules/ROOT/pages/exp-scanners-manage.adoc @@ -0,0 +1,32 @@ += Managing Scanners + +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. + +== Available Scanner Actions + +* Run discovery on demand. ++ +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. +* Review status and history. ++ +Inspect connection health, the last completed run, and scan history to verify whether discovery is healthy, slow, or failing authentication. +* Pause scheduled scans. ++ +Temporarily stop scheduled triggers when you need a quiet period—for example during maintenance or while you fix credentials—without deleting the scanner. +* Edit configuration. ++ +Change names, descriptions, credentials, provider scope, or scan-related settings your product exposes, then save so future runs use the new definition. +* Delete a 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. + +== How Scanners Run + +Scanners typically run on a schedule you or an administrator configured, or manually when you start a scan. + +== 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-services-add-semantic.adoc b/modules/ROOT/pages/exp-services-add-semantic.adoc new file mode 100644 index 000000000..4737fea05 --- /dev/null +++ b/modules/ROOT/pages/exp-services-add-semantic.adoc @@ -0,0 +1,54 @@ += Adding Semantic Services + +Semantic services improve how the system interprets and routes LLM-driven requests across your portfolio. They help teams apply context-aware behavior so the system directs requests to the most relevant tools, services, or pathways that your organization configured. + +Use this capability when your workflows need more than static routing. With semantic context in place, the system can support better request matching, more consistent response behavior, and stronger control as usage grows across agents, APIs, MCP servers, and related integrations. + +To add semantic services, follow these steps: + +. Define the semantic service your organization uses for contextual matching. +. Associate that semantic capability with the relevant enhanced experience (for example, LLM-related routing paths where supported). +. Operate the service as part of your broader governance and monitoring model so behavior remains reliable as traffic and use cases evolve. + +== Before You Begin + +Before getting started, make sure you have: + +* An Anypoint Platform account. +* Any 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]. + +== Create a Semantic Service + +. In the navigation, under *Portfolio*, expand *LLM Proxies*, and select *Semantic Services*. +. Select *Add Semantic Service*. +. Select the scale model that matches your traffic profile and operational needs. ++ +* *Basic scale* ++ +Choose *Basic scale* for faster managed setup. This scale is best for smaller topic sets (up to 6 topics and 10 utterances per topic). Uses managed internal LLM proxy configuration. ++ +* *Advanced scale* ++ +Choose *Advanced scale* when you need greater scale and external infrastructure control. This scale is best for larger utterance sets per topic. Uses external semantic infrastructure, including an embedding API connection and a vector database connection. + +Semantic service setup defines the embedding connection used for contextual matching. Provide a value for these fields: + +* *Environment* +* *Embedding service provider* +* *Service label* +* *URL* +* *Model* +* *Auth key* + + +== See Also + +* xref:exp-services-add-to-portfolio.adoc[] +* xref:exp-services-view-details.adoc[] +* xref:exp-services-monitoring.adoc[] diff --git a/modules/ROOT/pages/exp-services-add-to-portfolio.adoc b/modules/ROOT/pages/exp-services-add-to-portfolio.adoc new file mode 100644 index 000000000..870df5c56 --- /dev/null +++ b/modules/ROOT/pages/exp-services-add-to-portfolio.adoc @@ -0,0 +1,66 @@ += Adding Services to Your Portfolio + +Your *Portfolio* is organized into catalogs: *Agents*, *MCP Servers*, *LLM Proxies*, *APIs*, and *Gateways*. Each catalog holds the services (or gateway entries) that your organization registered or imported so you can govern, monitor, and deploy them from one place. Services enter a catalog either through automated provider discovery or through manual registration. For step-by-step 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-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. +|=== + +Gateways follow the same entry points; the linked topics cover gateway-specific behavior where it applies. + +== Before You Begin + +Before getting started, make sure you have: + +* An Anypoint Platform account. +* Any 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*, *LLM Proxies*, *APIs*, or *Gateways* catalog. Use the add control for that type (for example, *Add API* or *Add Agent*), then select *Connect to Provider* or *Register Manually*. + +Labels can vary by catalog; match what you see in the UI. + +== Service Type Registration Options + +*Agents*:: +Register by connecting to an agent-to-agent (A2A) endpoint, uploading an agent card, or registering without a card—or connect an agent provider for discovery. + +*MCP Servers*:: +Register with an MCP URL or a schema file, or connect an MCP server provider. + +*LLM Proxies*:: +Register manually by configuring a gateway and routing strategy, or use provider flows your tenant exposes for LLM proxies. + +*APIs*:: +Register with an API specification and instance details, or connect an API provider so scans import APIs into the *APIs* catalog. + +*Gateways*:: +Add a new gateway runtime by configuring a gateway and routing strategy, import an existing runtime through provider discovery, or browse the marketplace catalog to add pre-configured gateway options to the *Gateways* catalog. + +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-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 new file mode 100644 index 000000000..0bf86fd2f --- /dev/null +++ b/modules/ROOT/pages/exp-services-connect-providers-to-add.adoc @@ -0,0 +1,57 @@ += Connect to Providers to Add Services + +Connect a provider so 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. + +You can start the flow from *Home* or from a specific catalog in *Portfolio*. To see how this relates to manual registration, see xref:exp-services-add-to-portfolio.adoc[]. For creating and tuning scanners themselves, see xref:exp-scanners-add-from-providers.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]. + +== When to Use Provider Connection + +Use provider connection 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 one by hand. + +== Workflow Entry Points + +* *Home* ++ +Use *Add Services*, select *Connect to Provider*, then work through the wizard 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 the *Agents*, *MCP Servers*, *LLM Proxies*, *APIs*, or *Gateways* catalog. 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 wizard scoped to that catalog. + +Labels differ by catalog and release. Match what you see in the UI. + +== Wizard Settings + +Across *Home* and *Portfolio* entry points, provider connection covers 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 connection. + +When the scanner runs successfully, the system registers discovered services in the catalog you started from (for example, APIs land in the *APIs* catalog). + +== Catalog-Specific Flows +//EBM: Is this still valid? I am not sure how to validate this. +The *Agents*, *APIs*, and *MCP Servers* catalog-specific flows emphasize the service type you're enriching. +Discovery results populate that catalog when the system supports provider mapping for that type. + +== 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 new file mode 100644 index 000000000..2ccc3259e --- /dev/null +++ b/modules/ROOT/pages/exp-services-create-mcp-server.adoc @@ -0,0 +1,53 @@ += Create an MCP Server + +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. + +Creating an MCP server is different from adding one to *Portfolio*. Creation defines the MCP implementation and runtime behavior. Adding to *Portfolio* registers an existing MCP server so teams can govern, monitor, and manage lifecycle in the enhanced experience. + +During creation, you define: + +* *Service definition* ++ +Name, description, and ownership metadata so teams can identify the server in catalogs and governance views. +* *Connection/runtime details* ++ +Endpoint and access settings the enhanced experience uses to connect to and validate the server. +* *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. +* Any 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]. + +== Steps to 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, select the tools to publish (including optional read-only filtering) and then click *Next*. +. In *SaaS Credentials*, provide the credentials required for the selected sources so the MCP server can call them securely and then click *Next*. +. In *Review*, validate the selected sources, tools, and credential mappings, then complete creation. + +== After You Create an MCP Server + +After you save, the MCP server is ready for governance and operations. Register the MCP server in *Portfolio* so it appears in the *MCP Servers* catalog for governance, monitoring, and operations. + +== 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 new file mode 100644 index 000000000..cdcb7fce2 --- /dev/null +++ b/modules/ROOT/pages/exp-services-monitoring.adoc @@ -0,0 +1,54 @@ += Monitoring Your Services + +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, LLM 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. + +== Where Monitoring Appears + +* *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. + +Navigation labels and depth vary by entitlement and release; follow the UI your business group was given. + +== 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. + +== Permissions + +The system relies on Anypoint Platform access control. Roles such as Monitoring Viewer or Monitoring Administrator control access to monitoring views at the service and instance level, and control whether you can update monitoring configuration. See xref:exp-home-start.adoc#permissions[Enhanced Experience Permissions] for role details. + +== 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 new file mode 100644 index 000000000..8aba8d8b5 --- /dev/null +++ b/modules/ROOT/pages/exp-services-register-manually.adoc @@ -0,0 +1,81 @@ += Register Services Manually + +Register a service to add it to your portfolio when you already have the metadata, specification, endpoint, or card the new experience needs—without running a provider scan. You start from *Home* or from the catalog for that service type in *Portfolio*; completed registrations appear in the matching catalog. + +For how manual registration fits with connecting providers, see 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 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 select manual registration if the UI offers it. +* *Portfolio* ++ +Open the *Agents*, *MCP Servers*, *LLM Proxies*, *APIs*, or *Gateways* catalog, use the add control for that type (for example *Add API*), and select *Register Manually*. + +Exact labels can vary by release; follow the options your tenant shows. + +== Agents + +You register an agent by supplying one of these protocols: + +* A2A connection ++ +Point to an A2A endpoint to fetch an agent card. +* Non-A2A connection ++ +Provide metadata and connection details when you're not using a card workflow. +* Agent Card File +Provide an agent card file you already have. + +The connection gets validated, makes it possible to review metadata, and saves the agent into the *Agents* catalog. + +== MCP Servers + +You define how the system reaches the MCP 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. + +== LLM proxies + +LLM proxy registration is a two-part configuration: you associate the proxy with a gateway (and related deployment context), then define routing (and any provider connections your flow requires). After the wizard completes, the LLM proxy appears in the *LLM Proxies* catalog. + +== APIs + +Manual API registration expects an API specification and a way to reach a running instance (or instance-only registration when that path is enabled). Select the API type and then upload a specification file from your environment. + +The system uses the spec to discover endpoints, parameters, and related metadata where applicable, then writes the API into the *APIs* catalog after you confirm. + +== Gateways + +Register gateways manually when you want to add an existing gateway runtime to *Portfolio* without using provider discovery. This flow establishes gateway identity, connection context, and metadata so teams can govern and monitor gateway traffic in the enhanced experience. + +Manual gateway registration includes: + +* Defining gateway identity and descriptive metadata used in catalog and governance views. +* Providing environment and runtime connection details so the gateway maps to your organization topology. +* Validating registration inputs before saving to make the gateway ready for operational workflows. + +After registration, the gateway appears in the *Gateways* catalog in *Portfolio*, where teams can review details and apply supported governance workflows. + +== 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 new file mode 100644 index 000000000..f97175ee0 --- /dev/null +++ b/modules/ROOT/pages/exp-services-view-detailed-metrics.adoc @@ -0,0 +1,43 @@ += View Detailed Metrics for Your Services + +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 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. Use filters to narrow to the service, environment, or route you're investigating. + +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 new file mode 100644 index 000000000..8813d848c --- /dev/null +++ b/modules/ROOT/pages/exp-services-view-details.adoc @@ -0,0 +1,82 @@ += View Service Details + +Open a catalog entry in *Portfolio* to see its service detail page: a single view of one service—an agent, MCP server, LLM proxy, API, or a gateway, depending on the catalog. From there you can review status and cost, relationships to other services, deployments, policies, monitoring, conformance, and change history without switching contexts. + +//placeholder for image of service detail page + +== Before You Begin + +Before getting started, make sure you have: + +* An Anypoint Platform account. +* Any 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 following table lists each tab, what it shows, and whether that tab appears on the detail page for each catalog type. *Yes* means the tab is shown in typical configurations; *No* means it 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[]. + +[cols="2,3,^.^,^.^,^.^,^.^,^.^",options="header"] +|=== +|Tab |What You See |API |Agent |MCP server |LLM proxy |Gateway + +|*Overview* +|Status, average latency, daily cost, and a short summary of what the service does. +|Yes |Yes |Yes |Yes |Yes + +|*Connections* +|Relationships and integrations with other services, such as APIs, agents, or MCP servers. +|Yes |Yes |Yes |Yes |Yes + +|*Instances* +|Deployed instances, environments (for example production or sandbox), and gateways when that catalog type supports instances. +|Yes |Yes |Yes |Yes |No + +|*Policies* +|Governance policies attached to the service or its instances (access, data, performance, compliance, and related domains your organization uses). +|Yes |Yes |Yes |Yes |Yes + +|*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 |Yes + +|*Conformance Report* +|Compliance score and rule-level analysis for conformance reporting where that tab is available. +|Yes |Yes |Yes |No |No + +|*Governance* +|Governance policies and rules for the service and its instances, including gateway-wide or organization-level views where the system exposes them. +|Yes |Yes |Yes |Yes |Yes + +|*Versions* +|History of changes to the service configuration so you can compare before and after updates. +|Yes |Yes |Yes |Yes |Yes +|=== + +[NOTE] +==== +* *Instances* tab is available on *Agents*, *MCP Servers*, *LLM Proxies*, and *APIs*; *Gateways* do not include an *Instances* tab. See xref:exp-overview.adoc[]. + +* *Conformance Report* 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. +. Click the service card to open its detail page. + +== See Also + +* xref:exp-overview.adoc[] +* xref:exp-services-add-to-portfolio.adoc[] +* xref:exp-instances-add.adoc[Add Instances to a Service] +* xref:exp-add-policies.adoc[Add Policies to a Service] +* xref:exp-add-monitoring.adoc[Add Monitoring to a Service] +* xref:exp-add-governance.adoc[Add Governance to a Service] +* xref:exp-add-versions.adoc[Add Versions to a Service] diff --git a/modules/ROOT/pages/exp-slack-access.adoc b/modules/ROOT/pages/exp-slack-access.adoc new file mode 100644 index 000000000..a2486a449 --- /dev/null +++ b/modules/ROOT/pages/exp-slack-access.adoc @@ -0,0 +1,33 @@ += Access the Enhanced Experience from Slack + +After your administrator installs and configures the Slack integration, you can receive notifications, run shortcuts, and open deep links from the enhanced MuleSoft experience using your existing identity. Slack becomes a companion connection for alerts and collaboration while *Portfolio* and *Governance* remain the source of truth for configuration. + +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. + +== Sign In and Open the Experience + +. Open Slack in the workspace your company uses for MuleSoft or platform notifications. +. Use the app your administrator added. ++ +The display name is set during installation. +. Follow a notification action, a pinned link, or a slash command your internal documentation describes to authenticate and open the enhanced experience in the browser or embedded client your organization chose. + +If authentication fails: + +. Confirm that you're in the correct Slack workspace. +. Verify your Anypoint Platform user is linked according to your IT team's instructions. + +== Common Tasks from Slack + +* Respond to alerts ++ +Open a thread from an alert message and follow the link into the service or dashboard referenced in the payload. +* Share context ++ +Post links back into Slack after you verify state in *Portfolio*. This helps incident channels stay aligned with what you saw in the product. + +== 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 new file mode 100644 index 000000000..25f1fd7cb --- /dev/null +++ b/modules/ROOT/pages/exp-troubleshoot.adoc @@ -0,0 +1,412 @@ += Troubleshoot the Enhanced Experience + +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 LLM 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 entitlements. +.. 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, LLM 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 LLM 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. + +== Getting 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[] diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index d6a0f25d2..902d9c533 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -95,7 +95,8 @@ Monitor your APIs and integrations using dashboards, metrics, and visualization. //// -// Updated 2026/03/23 - valkyrie +// Updated 2026/05/11 - hanna +* xref:learning-map-exp.adoc[] * xref:monitoring::integration-intelligence.adoc[] * xref:general::learning-map-mulesoft-ai.adoc[] * xref:general::learning-map-agent-fabric.adoc[] @@ -107,6 +108,6 @@ Monitor your APIs and integrations using dashboards, metrics, and visualization. * 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:learning-map-api-management.adoc[] //* xref:cloudhub::app-migration.adoc[] //* xref:hyperforce::index.adoc[Salesforce Hyperforce] diff --git a/modules/ROOT/pages/learning-map-agent-fabric.adoc b/modules/ROOT/pages/learning-map-agent-fabric.adoc index 8b657bf31..d8444b65b 100644 --- a/modules/ROOT/pages/learning-map-agent-fabric.adoc +++ b/modules/ROOT/pages/learning-map-agent-fabric.adoc @@ -58,7 +58,7 @@ Build your agent network and coordinate brokers and agents using a declarative Y | image::lm_build_1.png[] [.lm-bold]##Govern and Secure the Agent Network## -Apply policies to your agents, brokers, LLMs, and MCP servers to help manage security and control traffic. +Apply policies to your agents, brokers, LLM proxies, and MCP servers to help manage security and control traffic. - xref:api-manager::create-instance-task-agent-tool.adoc[Add an Omni Gateway Agent or Tool Instance in API Manager] - https://videos.mulesoft.com/watch/2E2PkqzMnLEjoDhL5YkywT[Watch a Video to Learn About AI Gateway from MuleSoft] diff --git a/modules/ROOT/pages/learning-map-exp.adoc b/modules/ROOT/pages/learning-map-exp.adoc new file mode 100644 index 000000000..970c60723 --- /dev/null +++ b/modules/ROOT/pages/learning-map-exp.adoc @@ -0,0 +1,82 @@ += Enhanced MuleSoft Experience +:page-article-style: learning-map + +The enhanced MuleSoft experience helps you manage, optimize, and govern a multi-agent ecosystem from one place. Work with agents, APIs, MCP servers, LLM 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-access.adoc[] +- xref:exp-claude-desktop-connect.adoc[] +- https://trailhead.salesforce.com/content/learn/modules/get-to-know-the-enhanced-mulesoft-experience[Get to Know the Enhanced MuleSoft Experience: Quick Look] + + +| image::lm_explore_1.png[] +[.lm-bold]##Register## + +Register agents, APIs, and MCP servers from any provider or registry, and add LLM proxies and gateways. + +- xref: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[]