diff --git a/modules/ROOT/assets/image-source-files/custom-metadata-project-prop.graffle b/modules/ROOT/assets/image-source-files/custom-metadata-project-prop.graffle new file mode 100644 index 000000000..6935cf88b Binary files /dev/null and b/modules/ROOT/assets/image-source-files/custom-metadata-project-prop.graffle differ diff --git a/modules/ROOT/assets/image-source-files/int-application-types-file.graffle b/modules/ROOT/assets/image-source-files/int-application-types-file.graffle new file mode 100644 index 000000000..82f75d398 Binary files /dev/null and b/modules/ROOT/assets/image-source-files/int-application-types-file.graffle differ diff --git a/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab-attributes.graffle b/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab-attributes.graffle index 8693bdda7..1b0ba3aff 100644 Binary files a/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab-attributes.graffle and b/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab-attributes.graffle differ diff --git a/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab.graffle b/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab.graffle index 0742864c6..83893a765 100644 Binary files a/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab.graffle and b/modules/ROOT/assets/image-source-files/int-dw-fx-data-tab.graffle differ diff --git a/modules/ROOT/assets/image-source-files/int-dw-fx-input-output-sample.graffle b/modules/ROOT/assets/image-source-files/int-dw-fx-input-output-sample.graffle index 25a58915a..71aa31bfa 100644 Binary files a/modules/ROOT/assets/image-source-files/int-dw-fx-input-output-sample.graffle and b/modules/ROOT/assets/image-source-files/int-dw-fx-input-output-sample.graffle differ diff --git a/modules/ROOT/assets/image-source-files/int-set-component-custom-metadata.graffle b/modules/ROOT/assets/image-source-files/int-set-component-custom-metadata.graffle new file mode 100644 index 000000000..15391421b Binary files /dev/null and b/modules/ROOT/assets/image-source-files/int-set-component-custom-metadata.graffle differ diff --git a/modules/ROOT/assets/images/int-application-types-file.png b/modules/ROOT/assets/images/int-application-types-file.png new file mode 100644 index 000000000..181e22d92 Binary files /dev/null and b/modules/ROOT/assets/images/int-application-types-file.png differ diff --git a/modules/ROOT/assets/images/int-custom-metadata-project-prop.png b/modules/ROOT/assets/images/int-custom-metadata-project-prop.png new file mode 100644 index 000000000..cd467322f Binary files /dev/null and b/modules/ROOT/assets/images/int-custom-metadata-project-prop.png differ diff --git a/modules/ROOT/assets/images/int-dw-fx-data-tab-attributes.png b/modules/ROOT/assets/images/int-dw-fx-data-tab-attributes.png index 3f87c171b..7c1209739 100644 Binary files a/modules/ROOT/assets/images/int-dw-fx-data-tab-attributes.png and b/modules/ROOT/assets/images/int-dw-fx-data-tab-attributes.png differ diff --git a/modules/ROOT/assets/images/int-dw-fx-data-tab.png b/modules/ROOT/assets/images/int-dw-fx-data-tab.png index fafb45a6e..56c11db76 100644 Binary files a/modules/ROOT/assets/images/int-dw-fx-data-tab.png and b/modules/ROOT/assets/images/int-dw-fx-data-tab.png differ diff --git a/modules/ROOT/assets/images/int-dw-fx-input-output-sample.png b/modules/ROOT/assets/images/int-dw-fx-input-output-sample.png index 670c55a4b..5fb0f92a7 100644 Binary files a/modules/ROOT/assets/images/int-dw-fx-input-output-sample.png and b/modules/ROOT/assets/images/int-dw-fx-input-output-sample.png differ diff --git a/modules/ROOT/assets/images/int-set-component-custom-metadata.png b/modules/ROOT/assets/images/int-set-component-custom-metadata.png new file mode 100644 index 000000000..24e8a756c Binary files /dev/null and b/modules/ROOT/assets/images/int-set-component-custom-metadata.png differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 950793bdd..7825f44d4 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -12,6 +12,7 @@ ** xref:start-add-folders.adoc[] ** xref:start-open-output-panel.adoc[] ** xref:start-scm.adoc[] +** xref:start-workspaces.adoc[] // TUTORIALS * xref:tutorials.adoc[] @@ -55,15 +56,15 @@ * xref:ai-enabling-api-project-topic-center.adoc[] // USE AI TO DESIGN AN API SPEC -* xref:api-ai-design-spec.adoc[] -** xref:a4d-get-started.adoc[] -** xref:a4d-checkpoints.adoc[] -** xref:a4d-workflows-commands.adoc[] -** xref:a4d-conversation-history.adoc[] -** xref:a4d-mcp-server.adoc[] -** xref:api-ai-create-spec.adoc[] -** xref:int-ai-create-integrations.adoc[] -** xref:a4d-prompt-examples.adoc[] +* xref:mulesoft-vibes.adoc[] +** xref:vibes-get-started.adoc[] +** xref:vibes-checkpoints.adoc[] +** xref:vibes-workflows-commands.adoc[] +** xref:vibes-conversation-history.adoc[] +** xref:vibes-mcp-server.adoc[] +** xref:vibes-api-ai-create-spec.adoc[] +** xref:vibes-create-integrations.adoc[] +** xref:vibes-prompt-examples.adoc[] ** xref:troubleshoot-generative-ai.adoc[] // DESIGN @@ -87,6 +88,7 @@ *** xref:int-configure-components-open-from-xml.adoc[] ** xref:int-create-secure-configs.adoc[] ** xref:int-trigger-flows.adoc[] +** xref:int-manage-custom-metadata.adoc[] ** xref:int-debug-mule-apps.adoc[] ** xref:int-test-munit.adoc[] ** xref:int-autodiscovery-config.adoc[] diff --git a/modules/ROOT/pages/_partials/acb-runtime-java.adoc b/modules/ROOT/pages/_partials/acb-runtime-java.adoc index 42057bafa..163d57149 100644 --- a/modules/ROOT/pages/_partials/acb-runtime-java.adoc +++ b/modules/ROOT/pages/_partials/acb-runtime-java.adoc @@ -1,7 +1,7 @@ // // tag::runtime-java-download[] -You can select any of the supported Mule runtime and Java versions. The IDE saves your version settings to the project's `mule-artifact.json` file. +You can select from locally available Mule runtime and Java versions. The dropdown shows only the Mule runtime versions that are installed on your local disk, including bundled Mule runtime versions that are available immediately after installation. The IDE saves your version settings to the project's `mule-artifact.json` file. Bundled Mule runtime versions enable instant project opening and design. To install additional Mule runtime versions, use the `MuleSoft: Install Runtime` command. // end::runtime-java-download[] // // @@ -19,7 +19,7 @@ To set default Mule runtime and Java versions for the projects you create, see x // // tag::runtime-java-notification[] -The IDE provides a notification if it is necessary to download the selected Mule runtime or Java version for the project. Mule runtime downloads to `${user.home}/AnypointCodeBuilder/runtimes`, and the selected Java version downloads to `${user.home}/AnypointCodeBuilder/java`. +Projects open instantly using the bundled Mule runtime versions. The IDE provides a notification only if you must download a specific Mule runtime version or Java version for running or debugging your application. The Mule runtime versions download to `${user.home}/AnypointCodeBuilder/runtimes`, and the selected Java version downloads to `${user.home}/AnypointCodeBuilder/java`. // end::runtime-java-notification[] // diff --git a/modules/ROOT/pages/_partials/af-shared.adoc b/modules/ROOT/pages/_partials/af-shared.adoc index 4050e05c1..5f7da34bf 100644 --- a/modules/ROOT/pages/_partials/af-shared.adoc +++ b/modules/ROOT/pages/_partials/af-shared.adoc @@ -97,7 +97,7 @@ See xref:anypoint-code-builder::af-get-started.adoc#setup-space[Set Up the Priva Now you're ready to create an agent network project. Choose one of these methods. -* xref:anypoint-code-builder::af-create-agent-network.adoc#create-dev-agent[Create a Network Using MuleSoft Dev Agent] +* xref:anypoint-code-builder::af-create-agent-network.adoc#create-dev-agent[Create a Network Using MuleSoft Vibes] * xref:anypoint-code-builder::af-create-agent-network.adoc#create-acb[Create a Network Using Anypoint Code Builder] * xref:anypoint-code-builder::af-create-agent-network.adoc#create-cli[Create a Network Using the Anypoint CLI] @@ -106,7 +106,7 @@ Now you're ready to create an agent network project. Choose one of these methods After you create your agent network project, configure `agent-network.yaml` and `exchange.json` to reflect the structure of your network. -* xref:anypoint-code-builder::af-define-your-agent-network-specification.adoc#define-dev-agent[Define a Network Using MuleSoft Dev Agent] +* xref:anypoint-code-builder::af-define-your-agent-network-specification.adoc#define-dev-agent[Define a Network Using MuleSoft Vibes] * xref:anypoint-code-builder::af-define-your-agent-network-specification.adoc#define-acb-ide[Define a Network Using Anypoint Code Builder or IDE] [[step-4-publish]] @@ -114,7 +114,7 @@ After you create your agent network project, configure `agent-network.yaml` and Build and publish your agent network project as Anypoint Exchange assets. When you publish the agent network, an asset is created in Exchange for each broker, agent, and MCP server that's in your agent network. -* xref:anypoint-code-builder::af-publish-agent-network-assets.adoc#publish-dev-agent[Publish Your Network Using MuleSoft Dev Agent] +* xref:anypoint-code-builder::af-publish-agent-network-assets.adoc#publish-dev-agent[Publish Your Network Using MuleSoft Vibes] * xref:anypoint-code-builder::af-publish-agent-network-assets.adoc#publish-acb[Publish Your Network Using Anypoint Code Builder] * xref:anypoint-code-builder::af-build-agent-networks-in-a-ci-cd-environment.adoc#agent-network-project-publish[Publish Your Network Using the Anypoint CLI] @@ -123,7 +123,7 @@ Build and publish your agent network project as Anypoint Exchange assets. When y Deploy your agent network instance to a deployment target. You can deploy to a CloudHub 2.0 private space or to a Runtime Fabric (limited availability). -* xref:anypoint-code-builder::af-deploy-agent-network-targets.adoc#deploy-dev-agent[Deploy Your Network Using the MuleSoft Dev Agent] +* xref:anypoint-code-builder::af-deploy-agent-network-targets.adoc#deploy-dev-agent[Deploy Your Network Using MuleSoft Vibes] * xref:anypoint-code-builder::af-deploy-agent-network-targets.adoc#deploy-acb[Deploy Your Network Using Anypoint Code Builder] * xref:anypoint-code-builder::af-build-agent-networks-in-a-ci-cd-environment.adoc#agent-network-project-deploy[Deploy Your Network Using the Anypoint CLI] // end::get-started[] diff --git a/modules/ROOT/pages/a4d-get-started.adoc b/modules/ROOT/pages/a4d-get-started.adoc deleted file mode 100644 index 7c25152fb..000000000 --- a/modules/ROOT/pages/a4d-get-started.adoc +++ /dev/null @@ -1,83 +0,0 @@ -= Get Started with MuleSoft Dev Agent - -MuleSoft Dev Agent helps you build APIs and integrations using natural language prompts directly in your development environment. - -== Use MuleSoft Dev Agent - -You can open MuleSoft Dev Agent from the: - -* Toolbar icon -* Top navigation bar -* *Build with AI* card in the project canvas - -When you submit a prompt, MuleSoft Dev Agent processes it using the MuleSoft MCP Server and performs actions such as generating API specifications or integration flows. - -Depending on your configuration, MuleSoft Dev Agent can: - -* Request approval before writing to your files -* Write automatically if *Auto-approve* is enabled in settings - -=== Plan and Act Modes - -MuleSoft Dev Agent operates in two modes: - -* *Plan Mode* -Dev Agent analyzes your prompt and produces a step-by-step plan describing how it will accomplish the task. No actions are executed automatically in this mode. - -* *Act Mode* -Dev Agent attempts to perform the actions outlined in the plan by using the MuleSoft MCP Server tools to modify files, create resources, or execute changes to your project. - -You can switch between modes depending on whether you prefer to review the plan before execution or allow Dev Agent to act directly. - - -=== How Dev Agent Generates Code - -MuleSoft Dev Agent uses MuleSoft-optimized AI pipelines to generate high-quality code for API specifications and integration flows. - -The pipelines are exposed to Dev Agent through these MCP tools: - -* `generate_mule_flow` – Generates Mule integration flows. -* `generate_api_spec` – Generates API specifications from natural language prompts. - -Because these tools run on pipelines optimized specifically for MuleSoft use cases, users typically receive higher-quality code outputs (on average, 60% better) compared to generic generation. - -To ensure the best results: - -* Verify that the MuleSoft MCP Server is loaded in Dev Agent prior to sending a prompt. -* Make sure Dev Agent is invoking these specialized tools. -* Verify that all required prerequisites for Dev Agent and MCP Server are enabled in your environment. - -For more information about how MuleSoft’s AI generation pipelines work, see the https://blogs.mulesoft.com/automation/how-mulesoft-turns-generative-output-into-value/[MuleSoft research blog^]. - - -== Provide Dev Agent with Context - -You can improve the accuracy of MuleSoft Dev Agent’s output by providing additional context files or inputs. -Examples include requirement files (`requirements.txt`), configuration folders, logs, URLs, or terminal output. - -To add context: - -. In the MuleSoft Dev Agent panel, click the *Add Context* icon in the lower-left corner. -. Select files or folders to attach, paste the input or output from terminal, or paste a URL. -. Confirm to add the context to your current task. - -You can also add context directly from the prompt input box by typing `@`, which opens the same context selector. - -These inputs are used as contextual references during generation. - -== Configure MuleSoft Dev Agent Settings - -You can customize how MuleSoft Dev Agent interacts with your project through the *Settings* panel. -To access this panel, click the *Auto-approve* section at the bottom of the MuleSoft Dev Agent window. - -The available options include: - -* *Auto-approve*: Automatically apply changes without prompting for confirmation. -* *Read project files*: Allow MuleSoft Dev Agent to read project files for context. -* *Edit project files*: Allow MuleSoft Dev Agent to write changes directly to your project. -* *Read all files*: Allow MuleSoft Dev Agent to read all files on your computer. -* *Edit all files*: Allow MuleSoft Dev Agent to edit any file on your computer. -* *Use MCP Servers*: Allow MuleSoft Dev Agent to use connected MCP servers. -* *Execute safe commands*: Allow MuleSoft Dev Agent to execute safe terminal commands. -* *Execute all commands*: Allow MuleSoft Dev Agent to execute any terminal command. -* *Use the browser*: Allow MuleSoft Dev Agent to launch and interact with websites in a browser. diff --git a/modules/ROOT/pages/a4d-workflows-commands.adoc b/modules/ROOT/pages/a4d-workflows-commands.adoc deleted file mode 100644 index c8a5f6a4b..000000000 --- a/modules/ROOT/pages/a4d-workflows-commands.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= Workflows and Rules - -Rules and Workflows allow developers to customize how MuleSoft Dev Agent operates within their project. - -== Add Workflows and Rules - -Rules Define natural-language constraints or guidelines for how Dev Agent should generate content. - -You can use rules to enforce naming conventions, ensure consistent error handling, or maintain coding standards across your workspace. -Rules can be defined at two levels: - -* *Global* – Applies to all prompts sent to Dev Agent. - -* *Workspace* – Applies only to the active workspace. - -Workflows create predefined multi-step tasks that Dev Agent executes automatically. - -Workflows let you streamline repeated development steps and can be triggered using slash commands (for example, `/workflow-name`) in the Dev Agent panel. - -=== Add rules or workflows - -. Open MuleSoft Dev Agent in the sidebar. -. Select *Settings*. -. In the *Rules and Workflows* section, choose whether you want to add a rule or a workflow. -. Select *Add Rule* or *Add Workflow*. -. Provide the required information: -* For rules, enter the natural-language instruction you want Dev Agent to follow. -* For workflows, enter a name, an optional description, and the steps the workflow should run. -. Select *Save*. - -You can edit or delete existing rules and workflows from the same section. - -== Add Commands - -Commands provide quick shortcuts for interacting with MuleSoft Dev Agent. -You can invoke any command by typing `/` in the prompt input box. - -Dev Agent includes several built-in commands: - -* `/newrule` — Create a new rule based on the current conversation. -* `/newchat` — Start a new chat that carries over context from your current task. -* `/reportbug` — Report an issue by creating a GitHub ticket with Agentforce Vibes formatting. - -Workflows that you define also appear as commands under *Workflow Commands*. -You can trigger them the same way by typing `/` followed by the workflow name. diff --git a/modules/ROOT/pages/acb-external-libraries.adoc b/modules/ROOT/pages/acb-external-libraries.adoc new file mode 100644 index 000000000..9f9a8bd9f --- /dev/null +++ b/modules/ROOT/pages/acb-external-libraries.adoc @@ -0,0 +1,92 @@ += Configure External Libraries for Mule Projects +:page-deployment-options: cloud-ide, desktop-ide + +External libraries are project-level dependencies that Mule applications require to support certain connectors and components, such as Database connectors or Spring-based components. +Anypoint Code Builder provides a guided interface to add, edit, and delete external libraries, and automatically manages the corresponding entries in the project POM file. + +External library configurations apply at the project level. Any change to a configured library affects all components in the project that require that library. + +== Before You Begin + +* xref:start-acb.adoc[]. +* xref:int-create-integrations.adoc[]. +* Add a connector or component that requires an external library, such as a Database or Spring component. + +== When You Need to Configure an External Library + +Anypoint Code Builder prompts you to configure an external library when you add or configure a component that requires additional dependencies. +For example, this can occur when you: + +* Add a Database connector connection +* Configure a Spring-based component +* Use a custom component that depends on external libraries + +You can also manage external libraries from the project-level configuration, independent of a specific component. + +== Add an External Library + +You can add an external library from the component configuration or from the project-level library configuration interface. + +Add external libraries from one of these sources: + +* Recommended libraries +* Maven dependencies +* Local files + +Open the library configuration interface from a component: + +. In the canvas, select a component that requires an external library. +. In the component configuration panel, locate the *Required Libraries* list. +. Click the *Configure library* icon. ++ +Anypoint Code Builder opens the *Library Configuration* page. +Changes made on this page apply to the entire project. + +=== Add a Recommended Library + +Some components provide recommended libraries that match the component requirements. + +. Open the *Library Configuration* page. +. Select *Recommended Library*. ++ +The interface shows the library to add to the project. +. Click *Apply*. ++ +The IDE adds the recommended library to the project POM file and applies it to all components that require it. + +=== Add a Maven Dependency + +Search Maven Central or manually specify Maven coordinates to add a dependency. + +. Open the *Library Configuration* page. +. Select *Maven Dependency*. +. In the *Search Maven Central Repository* field, search for a dependency or enter the required Maven fields manually. +. Specify values for *Group ID*, *Artifact ID*, and *Version*. +. Optionally, configure additional fields such as *Scope*. +. Click *Apply*. + +Only libraries that meet the required criteria appear in component library fields after configuration. + +=== Add a Library from a Local File + +Add a dependency from a local file, such as a JAR or an external POM file. + +. Open the *Library Configuration* page. +. Select *Local File*. +. Select a file from your system. ++ +Anypoint Code Builder automatically populates the Maven fields based on the selected file. +. Override the populated values if required. +. Click *Apply*. + +If you select an external POM file, it takes precedence over any POM embedded in the artifact file. + +== Edit or Delete an External Library + +Edit or remove an existing library configuration. + +. Open the *Library Configuration* page. +. Select the configured library. +. Use the available actions to update or delete the library. ++ +Deleting a library removes it from the project POM file and affects all components that use the library. diff --git a/modules/ROOT/pages/acb-reference.adoc b/modules/ROOT/pages/acb-reference.adoc index 56c60b1f6..fe36dec47 100644 --- a/modules/ROOT/pages/acb-reference.adoc +++ b/modules/ROOT/pages/acb-reference.adoc @@ -1,4 +1,4 @@ -= Reference += Anypoint Code Builder Components and Commands Reference :page-aliases: acb-components.adoc :page-deployment-options: cloud-ide, desktop-ide diff --git a/modules/ROOT/pages/af-agent-networks.adoc b/modules/ROOT/pages/af-agent-networks.adoc index 5c24d34cc..8d2570b6a 100644 --- a/modules/ROOT/pages/af-agent-networks.adoc +++ b/modules/ROOT/pages/af-agent-networks.adoc @@ -6,7 +6,7 @@ An agent network provides the building blocks of your agentic deployment while M You define your agent network in a simple, human-readable YAML file in Anypoint Code Builder. This approach abstracts away the underlying technical complexities, allowing you to focus on the business constraints and context of your process without needing to understand the inner workings of the orchestration engine. -At the start of a new agent network project, we provide a YAML template to give you a head start. You can even use MuleSoft Dev Agent to configure your network, publish the assets to Anypoint Exchange, and deploy your agent network instance. +At the start of a new agent network project, we provide a YAML template to give you a head start. You can use MuleSoft Vibes to configure your network, publish the assets to Anypoint Exchange, and deploy your agent network instance. [[key-benefits]] == Key Benefits of Agent Networks diff --git a/modules/ROOT/pages/af-create-agent-network.adoc b/modules/ROOT/pages/af-create-agent-network.adoc index 430971a96..3ad377cb2 100644 --- a/modules/ROOT/pages/af-create-agent-network.adoc +++ b/modules/ROOT/pages/af-create-agent-network.adoc @@ -1,7 +1,7 @@ [[create-networks]] = Create Agent Networks -Whether you want to use MuleSoft Dev Agent or the UI, Anypoint Code Builder includes all the agent network functionality you need to get started. +Whether you want to use MuleSoft Vibes or the UI, Anypoint Code Builder includes all the agent network functionality you need to get started. [[before-you-begin]] == Before You Begin @@ -9,12 +9,12 @@ Whether you want to use MuleSoft Dev Agent or the UI, Anypoint Code Builder incl Make sure you review the xref:af-get-started.adoc#before-you-begin[prerequisites]. [[create-dev-agent]] -== Create a Network Using the MuleSoft Dev Agent +== Create a Network Using MuleSoft Vibes -MuleSoft Dev Agent can help you create your project. For more information about MuleSoft Dev Agent, see xref:anypoint-code-builder::api-ai-create-spec.adoc[Creating API Specs with MuleSoft Dev Agent]. +MuleSoft Vibes can help you create your project. For more information, see xref:anypoint-code-builder::api-ai-create-spec.adoc[]. . In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18]. -. Describe your agent network, including the brokers, agents, MCP servers, and LLMs you want to connect. MuleSoft Dev Agent does the rest. +. Describe your agent network, including the brokers, agents, MCP servers, and LLMs you want to connect. MuleSoft Vibes does the rest. To get started try one of these suggested prompts. @@ -55,3 +55,4 @@ If you run operations within a CI/CD environment, you can use Anypoint CLI's plu == See Also * xref:af-define-your-agent-network-specification.adoc[] +* xref:start-workspaces.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/af-define-your-agent-network-specification.adoc b/modules/ROOT/pages/af-define-your-agent-network-specification.adoc index 86be8981a..bed2ca3f1 100644 --- a/modules/ROOT/pages/af-define-your-agent-network-specification.adoc +++ b/modules/ROOT/pages/af-define-your-agent-network-specification.adoc @@ -12,9 +12,9 @@ Make sure you review the xref:af-get-started.adoc#before-you-begin[prerequisites To help you identify agents that are also brokers on the Anypoint Code Builder canvas, consider appending "Broker" to the end of the name, for example `employee-onboarding-broker`. [[define-dev-agent]] -== Define a Network Using MuleSoft Dev Agent +== Define a Network Using MuleSoft Vibes -MuleSoft Dev Agent can help you configure your agent network specification. For more information about MuleSoft Dev Agent, see xref:anypoint-code-builder::api-ai-create-spec.adoc[Creating API Specs with MuleSoft Dev Agent]. +MuleSoft Vibes can help you configure your agent network specification. For more information, see xref:anypoint-code-builder::api-ai-create-spec.adoc[]. . In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18]. . Give the agent information about your agent network, including the brokers, agents, MCP servers, and LLMs you want to connect. @@ -29,7 +29,7 @@ To get started try one of these suggested prompts. [[define-acb-ide]] == Define a Network Using Anypoint Code Builder or IDE -If you don't want to use MuleSoft Dev Agent, use Anypoint Code Builder or your IDE to edit the `agent-network.yaml` and `exchange.json` files and define your agent network and authentication. +If you don't want to use MuleSoft Vibes, use Anypoint Code Builder or your IDE to edit the `agent-network.yaml` and `exchange.json` files and define your agent network and authentication. To understand sections of the project files and expected values, see xref:anypoint-code-builder::af-project-files.adoc[Agent Network Project File Reference]. The agent-network.yaml file can contain definitions for one or more brokers. @@ -42,10 +42,10 @@ Use auto-completion menus in Anypoint Code Builder to speed your development. Fo If you have existing Exchange assets you want to use in your agent network, add them to the dependencies attribute in `exchange.json` in your project. After you add assets, edit the `agent-network.yaml` file to indicate which brokers use those assets. -=== Add Assets Using MuleSoft Dev Agent +=== Add Assets Using MuleSoft Vibes . In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18]. -. Tell the agent that you want to add Exchange assets to your project. MuleSoft Dev Agent does the rest. +. Tell the agent that you want to add Exchange assets to your project. MuleSoft Vibes does the rest. To get started try one of these suggested prompts. diff --git a/modules/ROOT/pages/af-deploy-agent-network-targets.adoc b/modules/ROOT/pages/af-deploy-agent-network-targets.adoc index 4275c1f23..1748105b0 100644 --- a/modules/ROOT/pages/af-deploy-agent-network-targets.adoc +++ b/modules/ROOT/pages/af-deploy-agent-network-targets.adoc @@ -44,12 +44,12 @@ Make sure you review the xref:af-get-started.adoc#before-you-begin[prerequisites When you deploy your agent network, an instance is deployed for each connection defined in your agent network. If your agent network contains brokers, an instance is deployed per broker. [[deploy-dev-agent]] -== Deploy Your Network Using the MuleSoft Dev Agent +== Deploy Your Network Using MuleSoft Vibes -MuleSoft Dev Agent can help you deploy your agent network instances. For more information about MuleSoft Dev Agent, see xref:anypoint-code-builder::api-ai-create-spec.adoc[Creating API Specs with MuleSoft Dev Agent]. +MuleSoft Vibes can help you deploy your agent network instances. For more information, see xref:anypoint-code-builder::api-ai-create-spec.adoc[]. . In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18]. -. Tell the agent that you want to deploy your agent network. MuleSoft Dev Agent does the rest. +. Tell the agent that you want to deploy your agent network. MuleSoft Vibes does the rest. To get started, try one of these suggested prompts. diff --git a/modules/ROOT/pages/af-publish-agent-network-assets.adoc b/modules/ROOT/pages/af-publish-agent-network-assets.adoc index 6f3c106c0..499e96153 100644 --- a/modules/ROOT/pages/af-publish-agent-network-assets.adoc +++ b/modules/ROOT/pages/af-publish-agent-network-assets.adoc @@ -13,12 +13,12 @@ Make sure you review the xref:af-get-started.adoc#before-you-begin[prerequisites If you want to publish your project assets to a different business group, update the relevant `groupId` in `exchange.json`. [[publish-dev-agent]] -== Publish Your Network Using MuleSoft Dev Agent +== Publish Your Network Using MuleSoft Vibes -MuleSoft Dev Agent can help you publish your agent network specification to Anypoint Exchange. For more information about MuleSoft Dev Agent, see xref:anypoint-code-builder::api-ai-create-spec.adoc[Creating API Specs with MuleSoft Dev Agent]. +MuleSoft Vibes can help you publish your agent network specification to Anypoint Exchange. For more information, see xref:anypoint-code-builder::api-ai-create-spec.adoc[]. . In the Anypoint Code Builder activity bar, click the agent icon image:af-acb-dev-agent-icon.png["",18,18]. -. Tell the agent that you want to publish your agent network. MuleSoft Dev Agent does the rest. +. Tell the agent that you want to publish your agent network. MuleSoft Vibes does the rest. To get started try one of these suggested prompts. diff --git a/modules/ROOT/pages/des-create-api-specs.adoc b/modules/ROOT/pages/des-create-api-specs.adoc index 0d85d467b..783576469 100644 --- a/modules/ROOT/pages/des-create-api-specs.adoc +++ b/modules/ROOT/pages/des-create-api-specs.adoc @@ -283,9 +283,11 @@ If you created an OAS 3.0 (YAML) project, you can replace the initial spec with == See Also + * xref:start-acb.adoc[] * xref:tutorials.adoc[] * xref:access-management::business-groups.adoc[] * xref:start-discover-ui.adoc#use-autocomplete[Use Auto-Complete in the Editors] * xref:tut-af-design-am-flights-api.adoc[] Tutorial -* xref:des-delete-api-projects.adoc[] \ No newline at end of file +* xref:des-delete-api-projects.adoc[] +* xref:start-workspaces.adoc[] \ No newline at end of file diff --git a/modules/ROOT/pages/imp-implement-local-apis.adoc b/modules/ROOT/pages/imp-implement-local-apis.adoc index d64331911..507d6f9af 100644 --- a/modules/ROOT/pages/imp-implement-local-apis.adoc +++ b/modules/ROOT/pages/imp-implement-local-apis.adoc @@ -36,6 +36,8 @@ For your projects to work properly, the `.code-workspace` file _must not reside_ In addition, Anypoint Code Builder permits only one pair of iterative design and implementation project folders per multi-root workspace. +For general information about using workspaces in Anypoint Code Builder, see xref:start-workspaces.adoc[]. + For more information, see https://code.visualstudio.com/docs/editing/workspaces/multi-root-workspaces[Multi-root Workspaces^] in the VS Code documentation. @@ -120,7 +122,7 @@ which you then implement within a Mule application. You can switch between the spec and the implementation project in the Explorer view. -To close your multi-root workspace, see <>. +To close or reopen your workspace later, see xref:start-workspaces.adoc[Working with Workspaces]. [[rescaffold-api-spec]] @@ -143,42 +145,7 @@ After you see the message that your project was rescaffolded successfully, navig //TODO: // ADD NOTE ABOUT caveats for rescaffolding AsyncAPI specs? -[[close-workspace]] -== Close a Multi-Root Workspace - -To close the workspace: - -// Pointer to Command Palette -include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] -. Select the following command: -+ -[source,command] ----- -Workspaces: Close Workspace ----- - -After closing, you can reopen a synchronized project from the workspace that you created when implementing the API. -See <>. - -[[open-workspace]] -== Open a Multi-Root Workspace - -To open a multi-root workspace from the `.code-workspace` file: - -// Pointer to Command Palette -include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] -. Select the following command: -+ -[source,command] ----- -File: Open Workspace from File... ----- -. Navigate to your home directory and double-click the `.code-workspace` file for the workspace. -+ -The projects open in the Explorer view, and the folder name for the multi-root workspace includes *(WORKSPACE)*, for example: -+ -image::imp-local-api-open-workspace.png["A multi-root workspace in Explorer view"] - == See Also +* xref:start-workspaces.adoc[] * xref:tut-local-api-specification.adoc[] Tutorial diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 6e1d4a3f7..3306bbea5 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -45,7 +45,7 @@ MuleSoft hosts this control plane within Canada (North America) data centers. + MuleSoft hosts this control plane within Japan (APAC) data centers. -Anypoint Platform hosts deployment targets for managed runtimes and related data, including data and metadata about your Mule implementations. +Anypoint Platform hosts deployment targets for managed Mule runtime versions and related data, including data and metadata about your Mule implementations. To change the host from the default (US), see xref:start-acb.adoc#change-clouds[Set the Desktop IDE to a Different Control Plane]. diff --git a/modules/ROOT/pages/int-ai-developing-integrations.adoc b/modules/ROOT/pages/int-ai-developing-integrations.adoc index b8e8013b9..9d3c6a333 100644 --- a/modules/ROOT/pages/int-ai-developing-integrations.adoc +++ b/modules/ROOT/pages/int-ai-developing-integrations.adoc @@ -1,7 +1,7 @@ -= Developing Integrations Using MuleSoft Dev Agent += Developing Integrations Using MuleSoft Vibes :page-deployment-options: cloud-ide, desktop-ide -To develop, manage, or maintain your applications, use MuleSoft Dev Agent in Anypoint Code Builder. MuleSoft Dev Agent is a purpose-built assistant for the development lifecycle, available directly in the IDE. It integrates with the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] and supports many capabilities, such as: +To develop, manage, or maintain your applications, use MuleSoft Vibes in Anypoint Code Builder. It is a purpose-built assistant for the development lifecycle, available directly in the IDE. It integrates with the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] and supports many capabilities, such as: * Developing API specifications * Creating and configuring applications @@ -10,7 +10,7 @@ To develop, manage, or maintain your applications, use MuleSoft Dev Agent in Any All of these actions are driven by natural language prompts. -When you generate an integration, MuleSoft Dev Agent transforms your business logic into a Mule application. The generated application includes: +When you generate an integration, MuleSoft Vibes transforms your business logic into a Mule application. The generated application includes: * Flows * Connector configurations @@ -19,7 +19,7 @@ When you generate an integration, MuleSoft Dev Agent transforms your business lo These capabilities are powered by large language models (LLMs) that run within the Salesforce Shared Trust Boundary. -NOTE: MuleSoft Dev Agent is available on US, EU, Canada, and Japan cloud hosts. +NOTE: MuleSoft Vibes is available on US, EU, Canada, and Japan cloud hosts. [[before-you-begin]] == Before You Begin @@ -28,33 +28,33 @@ Before you start creating your API spec, make sure you meet the following prereq * xref:start-acb.adoc[Set up and access the web or desktop IDE]. * Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. -* Ensure you have the following permissions to use MuleSoft Dev Agent: +* Ensure you have the following permissions to use MuleSoft Vibes: ** *Mule Developer Generative AI User* * Make sure Einstein is enabled in Access Management. For more information, see xref:access-management::enabling-einstein.adoc[Enabling Einstein for Anypoint Platform]. -NOTE: MuleSoft Dev Agent always uses the permissions of the Anypoint Platform user who is logged into Anypoint Code Builder, and can only execute actions that the authenticated user has permission to perform in Anypoint Platform. +NOTE: MuleSoft Vibes always uses the permissions of the Anypoint Platform user who is logged into Anypoint Code Builder, and can only execute actions that the authenticated user has permission to perform in Anypoint Platform. -== Unified Dev Agent Experience +== Unified MuleSoft Vibes Experience -MuleSoft Dev Agent provides a single panel where you can develop integrations and API specifications. Unlike earlier versions of generative features, Dev Agent does not insert output through a separate panel. Instead, it writes directly into your project files when you grant edit permissions. +MuleSoft Vibes provides a single panel where you can develop integrations and API specifications. Unlike earlier versions of generative features, it does not insert output through a separate panel. Instead, it writes directly into your project files when you grant edit permissions. -Depending on your settings, Dev Agent can: +Depending on your settings, MuleSoft Vibes can: * Request approval before writing to your files. -* Write automatically if *Auto-approve* is enabled in the Dev Agent settings. +* Write automatically if *Auto-approve* is enabled in the MuleSoft Vibes settings. For details on configuring permissions and server connections, see xref:troubleshoot-generative-ai.adoc[]. == Provide Additional Context -You can improve the accuracy of generated outputs by adding extra context to Dev Agent. -In addition to prompts, Dev Agent accepts the following types of input: +You can improve the accuracy of generated outputs by adding extra context to MuleSoft Vibes. +In addition to prompts, it accepts the following types of input: * **Files** – Add a requirements file or other reference documents. -* **Folders** – Provide an entire project folder for Dev Agent to consider. +* **Folders** – Provide an entire project folder for MuleSoft Vibes to consider. * **Terminal Input** – Share terminal outputs as context for the request. -This context helps Dev Agent generate flows and API specifications that align more closely with your requirements. +This context helps MuleSoft Vibes generate flows and API specifications that align more closely with your requirements. == Trust Layer @@ -63,7 +63,7 @@ The Einstein trust layer bridges Anypoint Platform and the LLMs, as shown in thi image::acb-einstein-trust-layer.png["Flow depicting how the trust layer works, including the steps of the flow"] [calloutlist] -. You create a message based on your use case and send it to Dev Agent. +. You create a message based on your use case and send it to MuleSoft Vibes. . To minimize inaccurate responses, messages are grounded with MuleSoft proprietary data and user context. . To ensure safe data transfer to external LLMs, the message is sent via a secure gateway. . All data remains within Salesforce-managed boundaries. @@ -76,5 +76,5 @@ This feature uses AI models that can produce inaccurate or harmful responses. Re == See Also -* xref:troubleshooting.adoc[Troubleshooting Dev Agent] -* xref:api-ai-create-spec.adoc[Creating API Specs with Dev Agent] +* xref:troubleshooting.adoc[] +* xref:api-ai-create-spec.adoc[] diff --git a/modules/ROOT/pages/int-configure-components.adoc b/modules/ROOT/pages/int-configure-components.adoc index d9d77df75..eb8b1559c 100644 --- a/modules/ROOT/pages/int-configure-components.adoc +++ b/modules/ROOT/pages/int-configure-components.adoc @@ -34,6 +34,13 @@ Understand the basics of Mule flows, the Mule event structure, including the pay //add component content include::partial$acb-component-info.adoc[tags="add-components"] +[[set-custom-metadata-for-component]] +== Set Custom Metadata for a Component + +To set custom metadata for a component, add or open the component in the canvas and then apply the metadata using the custom metadata options from the *Metadata* tab, *Expression Builder*, or dataweave functions. For more information, see xref:int-configure-dw-expressions.adoc#set-component-custom-metadata-on-metadata-or-data-tab[Set Custom Metadata on the Metadata or Data Tab] and see xref:int-configure-dw-expressions.adoc#set-custom-metadata-in-transformation-builder[Set Custom Metadata in Transformation Builder]. + +image::int-set-component-custom-metadata.png["Set Custom Metadata for a component"] + [[copy-components]] == Copy Components diff --git a/modules/ROOT/pages/int-configure-dw-expressions.adoc b/modules/ROOT/pages/int-configure-dw-expressions.adoc index b8e08e27e..6271aae7f 100644 --- a/modules/ROOT/pages/int-configure-dw-expressions.adoc +++ b/modules/ROOT/pages/int-configure-dw-expressions.adoc @@ -1,7 +1,7 @@ = Using DataWeave Expressions and Transformations in Anypoint Code Builder :page-aliases: int-use-dw-to-transform-data.adoc, int-address-dw-errors.adoc, int-import-dw-libraries.adoc -DataWeave is the MuleSoft programming language for data transformation and for defining expressions. Use DataWeave to process Mule event data, such as `payload`, `attributes`, and `vars`, in connector operations and other components. Develop DataWeave expressions and transformations in your Mule applications using the *Expression Field*, *Expression Builder*, or *Transformation Builder*, or by editing the configuration XML. Generate DataWeave transformations with AI help by providing input and output sample data, metadata, or both. +DataWeave is the MuleSoft programming language for data transformation and for defining expressions. Use DataWeave to process Mule event data, such as `payload`, `attributes`, and `vars`, in connector operations and other components. Develop DataWeave expressions and transformations in your Mule applications using the *Expression Field*, *Expression Builder*, or *Transformation Builder*, or by editing the configuration XML. Generate DataWeave transformations with AI help by providing input and output sample data, metadata, or both. AI-powered auto mapping provides comprehensive error feedback for GenAI actions, including authorization, metadata, and request limits, ensuring a more reliable and guided mapping experience. image::int-dw-transform-ui.png["A configuration panel showing three numbered callouts: 1) fx button for Expression Field, 2) Expression Builder button, and 3) Transformation Builder button"] @@ -18,6 +18,7 @@ Anypoint Code Builder integrates DataWeave expressions and transformations into * Object-to-object and array-to-array transformations * Concatenation of strings, numbers, and booleans * Type conversions +* Custom metadata for inputs and outputs Anypoint Code Builder supports these transform mapping use cases: @@ -79,7 +80,7 @@ The markup `#[]` in the *fx* field also appears in the XML to indicate that the + image::int-dw-fx-expression-builder.png["*Expression Builder* interface shows the *Data*, *Functions*, and *Preview* tabs for building DataWeave expressions in the `Set Variable` component"] + -Use the *Data*, *Functions*, and *Preview* tabs to ease configuration of expressions in your components. Preview the expression output without running your Mule app with data from external sources: +Use the *Data*, *Functions*, and *Preview* tabs to ease configuration of expressions in your components. Select custom metadata for the payload, attributes, and Mule variables. Preview the expression output without running your Mule app with data from external sources: * <> * <> @@ -93,7 +94,7 @@ Use the *Data*, *Functions*, and *Preview* tabs to ease configuration of express [[tab-data]] === Check the Data Structure -To review the data structure of the Mule event, including the payload, attributes, and Mule variables, use the *Data* tab. The tab includes any sample data and is part of *Expression Builder* for a component *fx* field. For example: +To review the data structure of the Mule event, including the payload, attributes, and Mule variables, use the *Data* tab. The tab includes any sample data and custom metadata and is part of *Expression Builder* for a component *fx* field. For example: [%header,cols="1a,1a"] |=== @@ -105,11 +106,25 @@ image:int-dw-fx-data-tab.png["Data tab for expression field"] image:int-dw-fx-data-tab-attributes.png["Data tab for expression field with mock attributes"] |=== -Automatically generated strings are displayed as mock values and are used to generate output for previews, such as in the <> tab. The attribute metadata keys in the example come from the configuration of an `HTTP Listener` component in the flow. +The IDE shows the automatically generated strings as mock values and uses them to generate output for previews, such as in the <> tab. The attribute metadata keys in the example come from the configuration of an `HTTP Listener` component in the flow. -The *Input/Output* tab shows the structure of data entering (*Input*) and exiting (*Output*) components. For example: +[[set-component-custom-metadata-on-metadata-or-data-tab]] +=== Set Component Custom Metadata on the Metadata or Data Tab -image:int-dw-fx-input-output-sample.png["Input/Output tab for a component"] +The *Metadata* tab shows the structure of data entering (*Input*) and exiting (*Output*) components. For example: + +image:int-dw-fx-input-output-sample.png["Metadata tab for a component"] + +From the *Metadata* tab or the *Data* tab of *Expression Builder*, manage component metadata by setting, clearing, or editing custom definitions for inputs and outputs. Each payload, attribute, or variable supports only one custom metadata assignment at a time. + +To set custom metadata from the *Metadata* tab or the *Data* tab of *Expression Builder*: + +. Click *No metadata selected* if metadata isn't already set or click the name of the custom metadata. If default metadata is being used, click *Default*. +. Click *Set Custom Metadata*. +. Select, edit, or preview existing custom metadata or create new custom metadata. See xref:int-manage-custom-metadata.adoc#create-custom-metadata[Create Custom Metadata] for more information about creating custom metadata. See xref:int-manage-custom-metadata.adoc#edit-custom-metadata[Edit Custom Metadata] for more information about editing custom metadata. +. Click *Apply and Close*. + +To clear custom metadata, click the name of the custom metadata and then click *Clear Custom Metadata*. The metadata is cleared from the component. [[tab-functions]] === List DataWeave Functions and Get Documentation @@ -121,7 +136,7 @@ To get a list of available functions from a component *Functions* tab, the *fx* For guidance, see <>. . List available functions: -* To show a list of DataWeave functions from the Core module from an empty *fx* field, press Ctrl+Space in an _empty_ *fx* field. For example: +* To show a list of DataWeave functions from the `Core` module from an empty *fx* field, press Ctrl+Space in an _empty_ *fx* field. For example: + image::int-dw-fx-field-autocomplete.png["DataWeave autocomplete dropdown menu showing available Core module functions like abs, avg, ceil, and floor with their descriptions"] * To show functions from all xref:dataweave::dw-functions.adoc#dw_modules[DataWeave modules], such as `String`, `Array`, and `Core` modules: @@ -206,15 +221,18 @@ If using AI-assisted transformations, evaluate these considerations: * To generate a DataWeave script using *Map and Transform with AI*, provide input and output samples. While optional, providing metadata helps AI understand the data structure and improves the accuracy of the transformation. * Sample data provides the context to generate functions or expressions for calculations, conditions, and other operations. You can provide Web Services Description Language (WSDL) files with sample data. See <> for supported data formats (MIME types) for sample data. -* For automatic field-to-field mapping using *Map with AI*, provide both input and output metadata. *Map with AI* works only if no DataWeave script exists in the component. +* For field-to-field mapping using *Map with AI*, provide both input and output metadata. Use *Map with AI* even when a DataWeave script is already present in the component. Click *Map with AI* to trigger it. * AI requires valid data to create the transformation script. Write it manually if needed. * AI chat history isn't available in *Transformation Builder*. * Avoid using real personally identifiable information (PII) in sample data or AI inputs. Provide input and output sample data that contains only fictional or masked data. +* AI-assisted transformations provide comprehensive error feedback for GenAI actions. If you encounter errors related to authorization, metadata, or request limits, the error messages guide you to resolve the issue. See <> for detailed troubleshooting steps. [[map-with-ai]] === Map with AI -The *Map with AI* feature automatically suggests a field-to-field mapping. This feature requires you to provide both input and output metadata for the component and triggers only when no DataWeave script is present. It performs auto-mapping based on the provided metadata. +The *Map with AI* feature suggests a field-to-field mapping using AI-powered auto mapping. Click *Map with AI* to trigger it. Use it even when a DataWeave script is already present in the component. Provide both input and output metadata for the component. Mapping is performed based on the metadata you provide. + +*Map with AI* provides comprehensive error feedback for GenAI actions, including authorization errors, metadata issues, and request limits. If you encounter errors during the mapping process, see <> for detailed guidance on resolving specific error types. If you don't have access to *Map with AI*, you must: @@ -227,11 +245,9 @@ If you don't have access to *Map with AI*, you must: + image::int-map-with-ai.png["Transformation Builder showing 'Fetching metadata' status message with loading indicator for AI-assisted mapping functionality"] + -The mapping starts automatically considering the sample data provided. -+ -The mapping is applied to the XML file. +. Click *Map with AI* to start the mapping. Provide both input and output metadata if not already provided. + -The *Preview* tab shows the output of the transformation. +The mapping is applied to the XML file, and the *Preview* tab shows the output of the transformation. . After the mapping is complete, you must: .. Click *Apply Mapping* to apply suggested mapping to your project. .. Click *Revise Mapping* to get new suggestions from the AI. @@ -265,11 +281,97 @@ After inserting a script, the XML file is updated, and you can regenerate the sc [[troubleshoot-ai-assisted-transformations]] === Troubleshoot AI-Assisted Transformations -If you have issues with the AI-assisted transformations, follow these steps: +AI-assisted transformations in *Transformation Builder* provide comprehensive error feedback to help you resolve issues. Error messages indicate the type of error and provide guidance to resolve it. + +If you encounter errors when using AI-assisted transformations, identify the error type and follow the corresponding resolution steps: + +* <> +* <> +* <> +* <> + +[[troubleshoot-authorization-errors]] +==== Authorization Errors + +Authorization errors occur when your Anypoint Platform account lacks the required permissions or when Einstein generative AI isn't properly configured for your organization. + +If you receive an authorization error: + +. Verify that you are logged in to Anypoint Platform from Anypoint Code Builder. ++ +For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform from the IDE]. +. Contact your Anypoint Platform organization administrator to verify: ++ +* You have the *Mule Developer Generative AI User* permission assigned in Anypoint Platform access management. +* Einstein generative AI is enabled for your organization. For more information, see xref:access-management::enabling-einstein.adoc[Enabling Einstein for Anypoint Platform]. +* You have accepted the terms and conditions for using Einstein generative AI. +* Your Anypoint Platform organization is current and active. +. If you are the organization administrator, verify that: ++ +* The Salesforce organization connected for requests has generative AI enabled. +* The Salesforce organization has an xref:access-management::trusted-salesforce-org.adoc[established tenant relationship] with your Anypoint Platform organization, and the connection is enabled. +* The Salesforce organization is valid and not expired or disabled. + +[[troubleshoot-metadata-errors]] +==== Metadata Errors + +Metadata errors occur when the input or output metadata provided to *Map with AI* or *Map and Transform with AI* is invalid, missing, or improperly structured. + +If you receive a metadata error: + +. Verify that both input and output metadata are provided when using *Map with AI*. ++ +*Map with AI* requires both input and output metadata to perform automatic field-to-field mapping. +. Check that your metadata structure is valid: ++ +* Ensure the metadata follows the expected schema format. +* Verify that required fields are present in the metadata. +* Confirm that data types match between input and output metadata where applicable. +. Review the metadata source: ++ +* If metadata is generated from sample data, verify that the sample data structure is correct. +* If metadata is imported from an API specification, verify the specification is valid and complete. +* Refresh metadata by clicking *More Actions* in *Transformation Builder* and selecting *Refresh metadata*. +. For *Map and Transform with AI*, verify that: ++ +* Input sample data is provided and valid. +* Output sample data is provided and valid. +* Sample data formats match the expected MIME types. See <> for supported formats. + +[[troubleshoot-request-limit-errors]] +==== Request Limit Errors + +Request limit errors occur when you exceed the rate limits for GenAI API requests. These limits help ensure fair usage and system stability. + +If you receive a request limit error: + +. Wait before retrying your request: ++ +* The error message indicates when you can retry the request. +* Avoid making multiple rapid requests in succession. +. Reduce the frequency of AI-assisted transformation requests: ++ +* Batch multiple transformations when possible. +* Use manual mapping for simple transformations to reduce API calls. +. Contact your Anypoint Platform organization administrator if: ++ +* Request limits are consistently reached during normal usage. +* You must understand your organization's specific rate limits. +. Consider alternative approaches: ++ +* Use *Manually Adding Data Sources and Targets* for straightforward mappings. See <>. +* Write DataWeave scripts manually for complex transformations that don't require AI assistance. + +[[troubleshoot-general-ai-errors]] +==== General AI Errors + +If you encounter other errors with AI-assisted transformations: . Log in to Anypoint Platform and try again. -. Ask your Anypoint Platform admin to verify that generative AI is enabled for your organization. -. If you're logged in to Anypoint Platform, and your organization has access to Einstein generative AI, accept the terms and conditions for using Einstein generative AI. +. Verify that your Anypoint Platform organization has access to Einstein generative AI. +. Ensure you have accepted the terms and conditions for using Einstein generative AI. +. Check your network connection and try again. +. If the error persists, contact your Anypoint Platform organization administrator or MuleSoft support. [[manually-add-data-sources-targets]] === Manually Adding Data Sources and Targets @@ -286,6 +388,20 @@ If needed, map multiple source field to a target field, and then the Transform B + You can select the generated sample or provide your own <>. +[[set-custom-metadata-in-transformation-builder]] +=== Set Custom Metadata in Transformation Builder + +In Transformation Builder, you can manage component metadata by setting, clearing, or editing custom definitions for inputs and outputs. Each payload, attribute, or variable supports only one custom metadata assignment at a time. + +To set custom metadata: + +. Click *No metadata selected* if metadata isn't already set or click the name of the custom metadata. If default metadata is being used, click *Default*. +. Click *Set Custom Metadata*. +. Select, edit, or preview existing custom metadata or create new custom metadata. See xref:int-manage-custom-metadata.adoc#create-custom-metadata[Create Custom Metadata] for more information about creating custom metadata. See xref:int-manage-custom-metadata.adoc#edit-custom-metadata[Edit Custom Metadata] for more information about editing custom metadata. +. Click *Apply and Close*. + +To clear custom metadata, click the name of the custom metadata and then click *Clear Custom Metadata*. The metadata is cleared from the component. + [[sample-data]] == Provide Sample Data for a DataWeave Expression @@ -462,4 +578,3 @@ When complete, Anypoint Code Builder shows a message that the dependency was suc * xref:troubleshoot-dataweave.adoc[] * xref:int-create-integrations.adoc#add-components[Add a Component to Your Project] * xref:acb-reference.adoc[] - diff --git a/modules/ROOT/pages/int-create-integrations.adoc b/modules/ROOT/pages/int-create-integrations.adoc index a7b6745e7..98820b849 100644 --- a/modules/ROOT/pages/int-create-integrations.adoc +++ b/modules/ROOT/pages/int-create-integrations.adoc @@ -87,12 +87,13 @@ Partial searches are accepted. ==== . Select a *Mule runtime* and *Java* version. + +The dropdown shows only the Mule runtime versions that are installed on your local disk, including bundled Mule runtime versions that are available immediately after installation. By default, the latest bundled Mule runtime version (Java 17 compatible) is selected. For Java 8 projects, select Mule runtime version 4.8 (Java 8 compatible, reduced). ++ //Info about downloads and versioning: include::anypoint-code-builder::partial$acb-runtime-java.adoc[tags="runtime-java-download;runtime-version-note;runtime-java-defaults"] . Click *Create Project*. + -//Info about download notifications and location: -include::partial$acb-runtime-java.adoc[tags="runtime-java-notification"] +Your project opens instantly using the bundled Mule runtime versions. No Mule runtime download is required to start designing your integration. If you need a specific Mule runtime version for running or debugging, you can install it later using the `MuleSoft: Install Runtime` command. See xref:int-versions.adoc#install-additional-runtimes[Install Additional Mule Runtime Versions]. When you create an integration project from scratch or if your project from Exchange does not contain a flow structure (Flow, Subflow, or Error handling component), the canvas provides the option to create one. Otherwise, the canvas generates a graphical representation of the imported asset's components that you can use to start your configuration. @@ -129,6 +130,7 @@ The file's canvas provides the same options for building your project file that == See Also +* xref:start-workspaces.adoc[] * xref:acb-reference.adoc[] * xref:int-work-with-code-snippets.adoc[] * xref:debugging-mule-apps.adoc[] diff --git a/modules/ROOT/pages/int-create-secure-configs.adoc b/modules/ROOT/pages/int-create-secure-configs.adoc index 80c8181e6..affed74d7 100644 --- a/modules/ROOT/pages/int-create-secure-configs.adoc +++ b/modules/ROOT/pages/int-create-secure-configs.adoc @@ -9,7 +9,6 @@ include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] Define configuration properties to secure and customize your Mule application configuration for different deployment environments. - * Encrypt sensitive values used in your Mule application. * Define and use variables instead of literal strings when setting values in the configuration XML. * Configure a variable for selecting different property files for a specific deployment environment, such as development, sandbox, or production. diff --git a/modules/ROOT/pages/int-import-mule-project.adoc b/modules/ROOT/pages/int-import-mule-project.adoc index af3166fe7..45135beff 100644 --- a/modules/ROOT/pages/int-import-mule-project.adoc +++ b/modules/ROOT/pages/int-import-mule-project.adoc @@ -183,3 +183,8 @@ include::partial$acb-open-packaged-sources.adoc[tags="open-workspace-root"] include::partial$acb-open-packaged-sources.adoc[tags="load-project"] //step: test project include::partial$acb-open-packaged-sources.adoc[tags="test-project"] + +== See Also + +* xref:start-workspaces.adoc[] +* xref:int-export-mule-project.adoc[] diff --git a/modules/ROOT/pages/int-manage-custom-metadata.adoc b/modules/ROOT/pages/int-manage-custom-metadata.adoc new file mode 100644 index 000000000..6b9a04a25 --- /dev/null +++ b/modules/ROOT/pages/int-manage-custom-metadata.adoc @@ -0,0 +1,59 @@ += Managing Custom Metadata + +Define and assign custom metadata to accurately represent your organization's unique data structures within your integration projects. Create metadata for inputs and outputs using common formats so your data transformations stay accurate. Custom metadata connects your visual development tools to your data requirements, facilitating easier testing and workflow creation. + +image::int-custom-metadata-project-prop.png["Custom Metadata tab on the Project Properties page"] + +== Supported Metadata Types + +Anypoint Code Builder supports these metadata types: + +* CSV +* Copybook +* Excel +* Fixed Width +* Flat File +* JSON +* Object +* Simple type +* XML + +[[create-custom-metadata]] +== Create Custom Metadata + +To create custom metadata: + +. Click *Create New*. +. Enter a unique name for the metadata. +. Select the metadata type, such as CSV, JSON, or XML. +. Add additional required details for the metadata, depending on the type selected, such as the definition or source type, schema, and class. You must also upload a sample file for some metadata types. +. Select to wrap the element in a collection, which converts the custom metadata into an array. The enrichment element in the `application-types.xml` file is updated automatically with the conversion. +. Click *Save and Close*. + +The custom metadata is stored in the `application-types.xml` file in your project's resources folder. Sample files and custom metadata created in Anypoint Code Builder are compatible with Anypoint Studio and vice versa. + +image::int-application-types-file.png[width=50%,"The application-types.xml file in the resources folder of the project"] + +[NOTE] +To apply custom metadata to a component, add or open the component in the canvas and then apply the metadata using the custom metadata options from the Metadata tab, *Expression Builder*, or *Transformation Builder*. For more information, see xref:int-configure-dw-expressions.adoc#set-component-custom-metadata-on-metadata-or-data-tab[Set Custom Metadata on the Metadata or Data Tab] and see xref:int-configure-dw-expressions.adoc#set-custom-metadata-in-transformation-builder[Set Custom Metadata in Transformation Builder]. + +[[edit-custom-metadata]] +== Edit Custom Metadata + +To edit custom metadata, click the three dots next to the source file and then click *Edit*. Make your changes and then click *Save and Close*. The changes are applied to all components that use the custom metadata. + +== Preview Custom Metadata + +To preview custom metadata, click the name of the metadata. The preview shows the metadata in the selected format. + +[[delete-custom-metadata]] +== Delete Custom Metadata + +To delete custom metadata from the *Custom Metadata* tab, click the three dots next to the source file and then click *Delete*. The metadata is deleted from all components that use it. + +You can also delete custom metadata when editing by clicking *Delete Custom Metadata* from the three dots menu. + +== See Also + +* xref:int-configure-dw-expressions.adoc#set-component-custom-metadata-on-metadata-or-data-tab[Set Component Custom Metadata on the Metadata or Data Tab] +* xref:int-configure-dw-expressions.adoc#set-custom-metadata-in-transformation-builder[Set Custom Metadata in Transformation Builder] \ No newline at end of file diff --git a/modules/ROOT/pages/int-migrate-studio-to-acb.adoc b/modules/ROOT/pages/int-migrate-studio-to-acb.adoc index 5dbb41d77..2a40f0cf1 100644 --- a/modules/ROOT/pages/int-migrate-studio-to-acb.adoc +++ b/modules/ROOT/pages/int-migrate-studio-to-acb.adoc @@ -20,4 +20,5 @@ include::partial$acb-project-migration.adoc[tag="import-mule-project-into-acb"] == See Also +* xref:start-workspaces.adoc[] * xref:int-import-mule-project.adoc[] diff --git a/modules/ROOT/pages/int-versions.adoc b/modules/ROOT/pages/int-versions.adoc index 5b7f04f0f..21fe0144c 100644 --- a/modules/ROOT/pages/int-versions.adoc +++ b/modules/ROOT/pages/int-versions.adoc @@ -4,18 +4,39 @@ include::reuse::partial$java8-eoss-banner.adoc[tag="java8-eoss"] //used in procedures::open-project: Open your implementation or integration project// Set Mule runtime engine (Mule), Java, and connector versions to use in your projects. -* <>: Set default Mule and Java versions to display in version drop-down menus. +Anypoint Code Builder includes bundled Mule runtime versions that enable you to open and design projects instantly without mandatory Mule runtime downloads. The IDE uses these bundled Mule runtime versions for editing and DataSense. Exact Mule runtime versions are only required when you run or debug your applications. + +* <>: Learn about the Mule runtime versions included with Anypoint Code Builder. + +* <>: Set default Mule and Java versions to show in version dropdown menus. * Project-level versions: Set versions to use in a specific project. ** For Mule and Java versions, see <>. -** For connector versions, see <>. +** For connector versions, see <>. + +* <>: Download specific Mule runtime versions when needed for run or debug operations. + +[[bundled-runtimes]] +== Bundled Mule Runtime Versions + +Anypoint Code Builder includes two bundled Mule runtime versions that are available immediately after installation: + +* **Mule 4.8 (Java 8 compatible)**: A minimal Mule runtime version bundle compatible with all Java 8-based Mule 4.4 and later projects. This Mule runtime version is used for design-time activities with Java 8 projects and serves as the default fallback for legacy applications. You can't use this version to run Mule applications. + +* **Latest Runtime (Java 17)**: The most recent supported Mule runtime version (Edge or LTS) bundled with Anypoint Code Builder at the time of release. For example, Mule 4.11. This Mule runtime version supports Java 17 and can be used for both designing and running applications. Projects configured for Mule 4.6, 4.9, and 4.10 are compatible with this bundled Mule runtime version. + +The IDE automatically selects the appropriate bundled Mule runtime version based on your project's Java version: +* Java 8 projects use the bundled 4.8 minimal Mule runtime version +* Java 17 projects use the latest bundled Mule runtime version + +These bundled Mule runtime versions guarantee that the design service can always start and serve the canvas and design-time needs without requiring runtime downloads. Projects open instantly using these bundled Mule runtime versions. Download a specific Mule runtime version if you want to run or debug your application with an exact version that isn't available locally. [[default-versions]] == Select Default Mule and Java Versions Select the default Mule and Java versions for new implementation and integration projects. The defaults appear in drop-down menus from which you select a version, for example, when creating a project. -Versions not present in the IDE append a message similar to *downloads upon project creation*. Versions that don't support a feature typically append a message, such as *AsyncAPI implementation unsupported* for Mule 4.4. +The dropdown shows only locally available Mule runtime versions, including the bundled ones. Versions that don't support a feature typically append a message, such as *AsyncAPI implementation unsupported* for Mule 4.4. You can set a different version at the project level (see <>). @@ -35,17 +56,28 @@ include::partial$acb-runtime-java.adoc[tags="runtime-java-version-selection"] [[project-version-mule-java]] == Select Mule and Java Versions for a Project -Set Mule or Java versions for a specific implementation or integration project from *Project Properties*. You can change versions at any time, but it is important to test your projects with the versions you intend to deploy. +Set Mule or Java versions for a specific implementation or integration project from *Project Properties*. You can change versions at any time, but test your projects with the versions you intend to deploy. + +The IDE uses bundled Mule runtime versions to open and edit projects immediately. The design service uses the latest Java-compatible Mule runtime version available locally. Anypoint Code Builder bundles the latest Mule runtime version (for example, 4.11) for Java 17 and a reduced Mule runtime version 4.8 for Java 8. This guarantees that the design service can always start and serve the canvas and design-time needs without requiring runtime downloads. + +Because the bundled Mule runtime version is the latest one, you can open and edit any project regardless of its `minMuleVersion` property. The design service uses the latest Java-compatible Mule runtime version available locally for design-time activities. The `minMuleVersion` property in your project's `mule-artifact.json` file is checked only at deployment time. The `minMuleVersion` property specifies the minimum Mule runtime version required to run or deploy the application. Version settings are important in several scenarios: * Updating a project to use more current versions * Switching to a supported version, for example, for a project that you import into Anypoint Code Builder that uses an unsupported version -* Adding a version of Mule or Java that is missing from your project * Selecting versions of Mule or Java that are compatible with each other +* Specifying exact Mule runtime versions for run and debug operations -When a Mule or Java version isn't set for a project, the IDE's canvas and notifications provide a *Set version* button that opens the *Project Properties* tab. You can also navigate directly to the *Project Properties* tab. +When you run or debug an application, the IDE checks if the exact Mule runtime version specified in your project is available locally. If not, you see a warning dialog that allows you to: +* Continue with the latest compatible local version +* Open *Project Properties* to select or download the required Mule runtime version + +[NOTE] +Changing the minimum Mule version (`minMuleVersion`) manually can have serious implications. This requires a full test of your application so it works correctly with the target Mule runtime version. Newer Mule runtime versions turn on feature flags by default. See xref:mule-runtime::feature-flagging.adoc[]. This can change behavior that was fixed in later versions. Your application can rely on behavior that was later corrected or on a previous issue. Prefer changing the Mule runtime version through *Project Properties*, and always run full regression tests after any version change. + +When a Mule or Java version isn't set for a project, the IDE's canvas and notifications provide a *Set version* button that opens the *Project Properties* tab. You can also navigate directly to the *Project Properties* tab. [[project-versions-from-properties]] To select Mule and Java versions for a project: @@ -82,3 +114,32 @@ include::partial$acb-runtime-java.adoc[tags="open-project-properties-menu"] image::int-project-properties-connectors.png["Connector versions in Project Properties tab"] . Select connector versions. You can update Exchange connector versions for compatibility with your project's Mule runtime and Java versions. +[NOTE] +==== +Connector compatibility is checked against the selected Mule runtime and Java versions. Compatibility issues appear after you apply changes in *Project Properties*. +==== + +[[install-additional-runtimes]] +== Install Additional Mule Runtime Versions + +Bundled Mule runtime versions enable instant project opening and design. If you need specific Mule versions for running or debugging your applications, install these additional versions. + +To install a specific Mule runtime version: + +. Open *Command Palette* by pressing Cmd+Shift+P on Mac, or Ctrl+Shift+P on Windows. +. Run the command: ++ +[source,command] +---- +MuleSoft: Install Runtime +---- ++ +. Select the Mule runtime version to install. ++ +The IDE downloads the selected Mule runtime version to `${user.home}/AnypointCodeBuilder/runtimes`. + +[NOTE] +==== +The dropdown in project creation and *Project Properties* shows only locally available Mule runtime versions. After installing additional Mule runtime versions, they appear in these dropdowns for future use. +==== + diff --git a/modules/ROOT/pages/mulesoft-vibes.adoc b/modules/ROOT/pages/mulesoft-vibes.adoc index d2f78d96d..395f5c962 100644 --- a/modules/ROOT/pages/mulesoft-vibes.adoc +++ b/modules/ROOT/pages/mulesoft-vibes.adoc @@ -37,4 +37,4 @@ NOTE: Authentication happens through the user logged in to Anypoint Code Builder == See Also * xref:troubleshoot-generative-ai.adoc[Troubleshooting MuleSoft Vibes] -* xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] \ No newline at end of file +* xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] diff --git a/modules/ROOT/pages/ref-acb-commands.adoc b/modules/ROOT/pages/ref-acb-commands.adoc index 1db2ab029..21d99775b 100644 --- a/modules/ROOT/pages/ref-acb-commands.adoc +++ b/modules/ROOT/pages/ref-acb-commands.adoc @@ -69,6 +69,13 @@ MuleSoft: Develop an Integration MuleSoft: Download Mule Runtime and Java Versions ---- +* Install a specific Mule runtime version for use with your projects. This command queries available Mule runtime versions and downloads the selected version to your local Mule runtime directory. See also, xref:int-versions.adoc#install-additional-runtimes[Install Additional Mule Runtime Versions]. ++ +[source,command] +---- +MuleSoft: Install Runtime +---- + * Export a shareable JAR file that contains an integration or implementation project. Both types of projects are Mule applications. See xref:int-export-mule-project.adoc#shareable[Export to a Shareable JAR File]. + [source,command] diff --git a/modules/ROOT/pages/start-workspaces.adoc b/modules/ROOT/pages/start-workspaces.adoc new file mode 100644 index 000000000..69397d8da --- /dev/null +++ b/modules/ROOT/pages/start-workspaces.adoc @@ -0,0 +1,161 @@ += Working with Workspaces +:page-deployment-options: cloud-ide, desktop-ide + +include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] + +Organize your Mule projects in workspaces to ensure all Anypoint Code Builder features work correctly. Workspaces help you manage multiple related projects and avoid build-time and design-time issues. + +[[valid-setups]] +== Valid Setups for Anypoint Code Builder + +Anypoint Code Builder requires one of the following project configurations to function properly: + +* A single Mule project open at the root of your directory +* A multi-root workspace pointing directly to one or more Mule projects + +If your directory structure doesn't meet these requirements, Anypoint Code Builder displays a message with steps to resolve the issue, such as opening a Mule project or creating a workspace. See <>. + +[[create-project-workspace]] +== Create a Project in a Workspace + +When you create a new project, add it to a workspace. With this setup you can add more projects later without restructuring your environment. + +To create a project in a workspace: + +. Start the project creation process using one of the following methods: ++ +** From the *Quick Actions* menu, select the project type. ++ +For example, *Design an API* or *Develop an Integration*. +** From the Command Palette, run the appropriate command. ++ +For example, `MuleSoft: Design an API`. +** Ask MuleSoft Vibes to create the project using natural language. + +. In the project creation form, select *Create in workspace*. +. Complete the remaining project configuration options. +. Click *Create Project*. ++ +Anypoint Code Builder creates the project and adds it to a workspace. If no workspace is open, a new workspace is created. + +[[import-studio-workspace]] +== Import an Anypoint Studio Workspace + +If you have existing projects in Anypoint Studio, you can import your Studio workspace into Anypoint Code Builder. + +To import a Studio workspace: + +// Pointer to Command Palette +include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] +. Select the following command: ++ +[source,command] +---- +MuleSoft: Import Studio Workspace +---- +. Navigate to the location of your Studio workspace and select it. +. Choose a location to save the new workspace file. ++ +Anypoint Code Builder creates a workspace that references your existing Studio projects. Changes made to the original Studio workspace are automatically reflected in Anypoint Code Builder. + +[[switch-workspaces]] +== Open and Switch Between Workspaces + +You can open or switch between workspaces using the menu, the Command Palette, or MuleSoft Vibes. + +=== Open a Workspace Manually + +. Open the workspace file using one of these methods: ++ +* From the menu bar, select *File* > *Open Workspace from File...*. +* From the Command Palette, run the command `File: Open Workspace from File...`. +. Navigate to the location where you saved the `.code-workspace` file (for example, your home directory or a dedicated workspaces folder), and select it. ++ +The projects open in the Explorer view, and the folder name for the workspace includes *(WORKSPACE)* to indicate that you're working in a multi-root workspace: ++ +image::imp-local-api-open-workspace.png["A multi-root workspace in Explorer view"] + +=== Open a Workspace with MuleSoft Vibes + +You can ask MuleSoft Vibes to switch workspaces using natural language prompts, such as: + +* "Open my American Flights workspace" +* "Switch to the `` workspace" + +[[close-workspace]] +== Close a Workspace + +To close the current workspace: + +// Pointer to Command Palette +include::partial$acb-reusable-steps.adoc[tags="open-command-palette"] +. Select the following command: ++ +[source,command] +---- +Workspaces: Close Workspace +---- + +[[actions-in-workspaces]] +== Actions in Workspaces + +Anypoint Code Builder organizes actions based on their scope: + +[cols="1,2"] +|=== +| Action Type | Location + +| *Global actions* +| Always available from the Command Palette. These actions don't depend on a specific project, such as creating a new project, importing assets from Exchange, or opening Anypoint Code Builder settings. + +| *Project-specific actions* +| Available from the context menu (right-click) in the Explorer view. These actions apply to a specific project, such as running, debugging, deploying, or exporting a project. +|=== + +When working with multiple projects in a workspace, select the target project before running project-specific actions. For example, when you run or debug, you must select which project in the workspace to execute. + +[[workspace-file]] +== Workspace File Location + +VS Code stores workspace configuration in a file with the `.code-workspace` extension. This file maps the folders for your projects. + +[IMPORTANT] +==== +The `.code-workspace` file must not reside within any of your project folders. Save it in a separate directory, such as your home directory or a dedicated workspaces folder. +==== + +[[fix-nested-project]] +== Fix a Nested Project Error + +This error appears when you open a folder that contains your Mule project instead of opening the project directly, and that folder isn't configured as a multi-root workspace. + +To fix this issue, open the project folder at the root level or add it to a multi-root workspace. + +=== Open the Project at the Root + +If you're working with a single project, open it directly so it appears at the top level of the Explorer view. + +. From the menu bar, select *File* > *Open Folder...*. +. Navigate to your Mule project's root folder (the folder containing the `pom.xml` file). +. Select the folder and click *Open*. ++ +The project now appears at the top level of the Explorer view, and Anypoint Code Builder features are available. + +=== Add the Project to a Multi-Root Workspace + +If you want to keep your current folder structure or work with multiple projects, create a multi-root workspace that points directly to your Mule project. + +. From the menu bar, select *File* > *Add Folder to Workspace...*. +. Navigate to your Mule project's root folder and select it. +. When prompted, save the workspace file (`.code-workspace`) to a location outside of your project folders. ++ +The project appears in the Explorer view with the *(WORKSPACE)* indicator, and Anypoint Code Builder features are available. + +TIP: If you frequently work with multiple projects, creating a workspace from the start avoids this issue. See <>. + +== See Also + +* xref:imp-implement-local-apis.adoc[Iteratively Design and Implement APIs] +* xref:int-create-integrations.adoc[Creating Integrations] +* xref:des-create-api-specs.adoc[Creating and Importing API Specifications] +* https://code.visualstudio.com/docs/editor/multi-root-workspaces[Multi-root Workspaces^] in the VS Code documentation diff --git a/modules/ROOT/pages/troubleshoot-generative-ai.adoc b/modules/ROOT/pages/troubleshoot-generative-ai.adoc index 041024eda..26352c9be 100644 --- a/modules/ROOT/pages/troubleshoot-generative-ai.adoc +++ b/modules/ROOT/pages/troubleshoot-generative-ai.adoc @@ -1,27 +1,27 @@ = Troubleshoot AI Features in Anypoint Code Builder -The following errors sometimes occur when you use MuleSoft Dev Agent in Anypoint Code Builder. +The following errors sometimes occur when you use MuleSoft Vibes in Anypoint Code Builder. -== Unexpected Results When Using Dev Agent +== Unexpected Results When Using Mulesoft Vibes If the generated flow doesn't return accurate or useful results for your prompt, try rewriting your prompt and follow the guidelines to xref:int-ai-create-integrations.adoc#craft-ai-prompt[write an effective prompt]. -If results are still inconsistent, verify that your project context and Dev Agent settings are correctly configured. +If results are still inconsistent, verify that your project context and Mulesoft Vibes settings are correctly configured. -== Troubleshoot Dev Agent Access Errors +== Troubleshoot Mulesoft Vibes Access Errors -If you can't open MuleSoft Dev Agent, verify the following: +If you can't open MuleSoft Vibes, verify the following: * You are logged in to Anypoint Platform from the IDE. For more information, see xref:start-acb.adoc#log-in-to-anypoint-platform-from-the-ide[Log in to Anypoint Platform from the IDE]. * You have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions], including: ** *Mule Developer Generative AI User* -* You have the required permissions for the tools in the MuleSoft MCP Server that MuleSoft Dev Agent uses to generate accurate responses. +* You have the required permissions for the tools in the MuleSoft MCP Server that MuleSoft Vibes uses to generate accurate responses. [[required-permissions]] -=== Required Permissions for MuleSoft Dev Agent +=== Required Permissions for MuleSoft Vibes -MuleSoft Dev Agent always uses the permissions of the logged-in Anypoint Platform user. -Dev Agent cannot perform any action that the user does not already have permission to perform. +MuleSoft Vibes always uses the permissions of the logged-in Anypoint Platform user. +MuleSoft Vibes can't perform any action that the user doesn't already have permission to perform. Here are the permissions required across capabilities in the MuleSoft MCP Server: @@ -57,7 +57,7 @@ Here are the permissions required across capabilities in the MuleSoft MCP Server * Usage Viewer ==== -If you want to configure MuleSoft Dev Agent with a different set of permissions, you must: +If you want to configure MuleSoft Vibes with a different set of permissions, you must: . Remove or disable the out-of-the-box MuleSoft MCP Server. . Follow the steps in the xref:mulesoft-mcp-server::getting-started.adoc#set-up-authentication[MuleSoft MCP Server documentation] to set up a connected app with the desired permissions. diff --git a/modules/ROOT/pages/troubleshoot-loading-errors.adoc b/modules/ROOT/pages/troubleshoot-loading-errors.adoc index 6cc246319..41b8a2787 100644 --- a/modules/ROOT/pages/troubleshoot-loading-errors.adoc +++ b/modules/ROOT/pages/troubleshoot-loading-errors.adoc @@ -63,7 +63,7 @@ File: Open Folder... + The root is the top-level folder that Anypoint Code Builder generates when it creates a project. Do not navigate to the project's parent or ancestor directory or to one of its child or descendant directories. -See also xref:int-import-mule-project.adoc[]. +See also xref:int-import-mule-project.adoc[] and xref:start-workspaces.adoc[]. [[mule-dx]] == Mule DX API Component Was Not Installed diff --git a/modules/ROOT/pages/troubleshoot-mcp-server.adoc b/modules/ROOT/pages/troubleshoot-mcp-server.adoc index be46da433..3ff68d77d 100644 --- a/modules/ROOT/pages/troubleshoot-mcp-server.adoc +++ b/modules/ROOT/pages/troubleshoot-mcp-server.adoc @@ -8,9 +8,9 @@ When using the MuleSoft MCP Server in Anypoint Code Builder, you might encounter [[verify-mcp-server]] == Verify the MCP Server Is Running -If MuleSoft Dev Agent isn't responding to commands or tools aren't available, verify that the MuleSoft MCP Server is running: +If MuleSoft Vibes isn't responding to commands or tools aren't available, verify that the MuleSoft MCP Server is running: -. Open the MuleSoft Dev Agent panel in Anypoint Code Builder. +. Open the MuleSoft Vibes panel in Anypoint Code Builder. . Click *Manage MCP Servers*. . Click image:anypoint-code-builder::icon-gear.png["",18,18] (Settings) to open the MCP Server settings. . In the *Installed* tab, verify that the MuleSoft MCP Server is enabled (toggled on and marked in green). @@ -41,7 +41,7 @@ You can also check the *Tasks* section in the Output panel for additional errors If the MCP server stops responding or behaves unexpectedly, restart it: -. Open the MuleSoft Dev Agent panel in Anypoint Code Builder. +. Open the MuleSoft Vibes panel in Anypoint Code Builder. . Click *Manage MCP Servers*. . Click image:anypoint-code-builder::icon-gear.png["",18,18] (Settings) to open the MCP Server settings. . In the *Installed* tab, locate the MuleSoft MCP Server. diff --git a/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc b/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc index 3f151201b..33c1d5c7b 100644 --- a/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc +++ b/modules/ROOT/pages/troubleshoot-mule-runtime-errors.adoc @@ -3,16 +3,16 @@ include::reuse::partial$beta-banner.adoc[tag="anypoint-code-builder"] -Anypoint Code Builder bundles a version 4 instance of Mule runtime engine (Mule) to run your integrations and implementations. +Anypoint Code Builder includes bundled Mule runtime versions that enable instant project opening and design. When you run or debug applications, the IDE checks for the exact runtime version specified in your project. If the exact version isn't available locally, error dialogs appear to help you resolve the issue. Don't change the default locations of Mule. If you receive an error that Mule isn't found or installed, configure the Mule Home path. -If configuring your Mule runtime, ensure you're defining the `mule.homeDirectory` property. +When you configure Mule runtime, ensure you define the `mule.homeDirectory` property. [NOTE] The `mule.runtime.muleRuntimesDirectory` and `mule.runtime.muleHome` properties are legacy configurations no longer used. -* *Mule runtimes*: The Mule runtimes are located in the `{yourACBHome}/runtimes` directory. +* *Mule runtime versions*: The Mule runtime versions are located in the `{yourACBHome}/runtimes` directory. + Default value: `/Users/{user}/AnypointCodeBuilder/runtime`. @@ -62,13 +62,78 @@ image::troubleshoot-download-java-notification.png["Notification showing a reque Instead of using this feature, you can use the command *Download Mule Runtime and Java Versions*. See xref:anypoint-code-builder::int-versions.adoc[]. +== Mule Runtime Version Not Defined + +The error *Mule runtime version not defined* occurs when your project doesn't specify a Mule runtime version in the project's `mule-artifact.json` file. + +To resolve this issue: + +. Click *Open Project Properties* in the error dialog, or run the command `MuleSoft: Open Mule Project Properties`. +. In *Project Properties*, select a Mule runtime version. +. Click *Apply*. + +== Java Version Not Defined + +The error *Java version not defined* occurs when your project doesn't specify a Java version in the project's `mule-artifact.json` file. + +To resolve this issue: + +. Click *Open Project Properties* in the error dialog, or run the command `MuleSoft: Open Mule Project Properties`. +. In *Project Properties*, select a Java version. +. Click *Apply*. + +== Mule Runtime Version Not Found (Compatible Version Available) + +The error *Mule runtime [version] not found* occurs when you try to run or debug an application, but the exact Mule runtime version specified in your project isn't available locally. However, a compatible local version is available. + +To resolve this issue, you have two options: + +* **Continue with compatible version**: Click *Continue* to use the latest local compatible version. The dialog shows which version to use. +* **Select a different version**: Click *Open Project Properties* to select a different local Mule runtime version or install the exact version using the `MuleSoft: Install Runtime` command. + +== Mule Runtime Version Not Found (No Compatible Version) + +The error *Mule runtime [version] not found* occurs when you try to run or debug an application, but the exact Mule runtime version specified in your project isn't available locally, and no compatible version is available. + +To resolve this issue: + +. Click *Open Project Properties* in the error dialog. +. In *Project Properties*, either: +** Select a locally available Mule runtime version from the dropdown, or +** Use the `MuleSoft: Install Runtime` command to download the required version. +. Click *Apply*. + +== Java Version Not Found + +The error *Java [version] not found* occurs when you try to run or debug an application, but the Java version specified in your project isn't available locally. + +To resolve this issue: + +. Click *Open Project Properties* in the error dialog. +. In *Project Properties*, either: +** Select Java 17 (or another available version) from the dropdown, or +** Use the `MuleSoft: Download Mule Runtime and Java Versions` command to download the required Java version. +. Click *Apply*. + +== Mule Runtime and Java Version Not Found + +The error *Mule runtime [version] and Java [version] not found* occurs when you try to run or debug an application, but both the Mule runtime and Java versions specified in your project aren't available locally. + +To resolve this issue: + +. Click *Open Project Properties* in the error dialog. +. In *Project Properties*: +** Select a locally available Mule runtime version and Java 17 (or another compatible version) from the dropdowns, or +** Use the `MuleSoft: Install Runtime` command to download the required Mule runtime version, and use the `MuleSoft: Download Mule Runtime and Java Versions` command to download the required Java version. +. Click *Apply*. + [[reinstall-mule-runtime]] == Reinstall Mule Runtime If your Mule runtime installation becomes corrupted, you can force a reinstallation: . Close Anypoint Code Builder. -. Navigate to your Mule runtimes directory: `${user.home}/AnypointCodeBuilder/runtimes`. +. Navigate to your Mule runtime directory: `${user.home}/AnypointCodeBuilder/runtimes`. . Remove or rename the folder for the runtime version you want to reinstall (for example, `mule-4.6.0`). . Open Anypoint Code Builder. . Select the Mule runtime version from *Project Properties*. @@ -76,4 +141,4 @@ If your Mule runtime installation becomes corrupted, you can force a reinstallat The IDE downloads and reinstalls the selected version. For details on selecting versions, see xref:int-versions.adoc#project-version-mule-java[Select Mule and Java Versions for a Project]. [NOTE] -Your projects and other installed runtimes are not affected. \ No newline at end of file +Your projects and other installed Mule runtime versions are not affected. \ No newline at end of file diff --git a/modules/ROOT/pages/troubleshooting.adoc b/modules/ROOT/pages/troubleshooting.adoc index 896d9a6e6..8a755e0af 100644 --- a/modules/ROOT/pages/troubleshooting.adoc +++ b/modules/ROOT/pages/troubleshooting.adoc @@ -169,5 +169,5 @@ Remove any folders starting with `salesforce.mule-dx-` or `mulesoftinc.mule-dx-` [NOTE] -- -This procedure removes downloaded Mule runtimes and Java versions. You can re-download them after reinstalling. +This procedure removes downloaded Mule runtime versions and Java versions. You can re-download them after reinstalling. -- \ No newline at end of file diff --git a/modules/ROOT/pages/tut-af-design-am-flights-api.adoc b/modules/ROOT/pages/tut-af-design-am-flights-api.adoc index 21e4e4af2..7cad477d7 100644 --- a/modules/ROOT/pages/tut-af-design-am-flights-api.adoc +++ b/modules/ROOT/pages/tut-af-design-am-flights-api.adoc @@ -35,7 +35,7 @@ image::acb-mulesoft-in-activity-bar.png["MuleSoft icon in the VS Code Activity B + image::design-api-1.png["Link to Design an API in the MuleSoft panel"] + -If you receive the error *Mule DX API Component was not installed*, wait for Mule runtime to load and for background processes to complete. To monitor background processes, see xref:troubleshoot-loading-errors.adoc[]. +If you receive the error *Mule DX API Component was not installed*, wait for Mule runtime engine to load and for background processes to complete. To monitor background processes, see xref:troubleshoot-loading-errors.adoc[]. . Configure your API specification project using these values: + [%header,cols="1a,1a"] diff --git a/modules/ROOT/pages/api-ai-create-spec.adoc b/modules/ROOT/pages/vibes-api-ai-create-spec.adoc similarity index 63% rename from modules/ROOT/pages/api-ai-create-spec.adoc rename to modules/ROOT/pages/vibes-api-ai-create-spec.adoc index 355384133..183d80936 100644 --- a/modules/ROOT/pages/api-ai-create-spec.adoc +++ b/modules/ROOT/pages/vibes-api-ai-create-spec.adoc @@ -1,9 +1,10 @@ -= Creating API Specs with MuleSoft Dev Agent += Creating API Specs with MuleSoft Vibes :page-deployment-options: cloud-ide, desktop-ide +:page-aliases: api-ai-create-spec.adoc -MuleSoft Dev Agent is a purpose-built assistant for the development lifecycle, available directly in Anypoint Code Builder. It provides a unified panel that lets you interact with AI features using natural language prompts. Dev Agent works with the embedded MuleSoft MCP Server (see xref:mulesoft-mcp-server::index.adoc[Mulesoft MCP Server]) to support capabilities such as deploying applications, managing instances, and creating new projects. +MuleSoft Vibes is a purpose-built assistant for the development lifecycle, available directly in Anypoint Code Builder. It provides a unified panel that lets you interact with AI features using natural language prompts. Mulesoft Vibes works with the embedded MuleSoft MCP Server (see xref:mulesoft-mcp-server::index.adoc[Mulesoft MCP Server]) to support capabilities such as deploying applications, managing instances, and creating new projects. -One of these capabilities is AI-powered API specification generation. With Dev Agent, you can generate and mock API specifications from natural language prompts. This feature reduces the time spent on API design by simplifying the creation of syntax-heavy specifications. +One of these capabilities is AI-powered API specification generation. With Mulesoft Vibes, you can generate and mock API specifications from natural language prompts. This feature reduces the time spent on API design by simplifying the creation of syntax-heavy specifications. [[before-you-begin]] == Before You Begin @@ -12,20 +13,20 @@ Before you start creating your API spec, make sure you meet the following prereq * xref:start-acb.adoc[Set up and access the web or desktop IDE]. * Make sure you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. -* Ensure you have the following permissions to use MuleSoft Dev Agent: -** *Anypoint Code Builder Developer* (to use Dev Agent in the Cloud IDE) +* Ensure you have the following permissions to use Mulesoft Vibes: +** *Anypoint Code Builder Developer* (to use Mulesoft Vibes in the Cloud IDE) ** *Mule Developer Generative AI User* * Make sure Einstein is enabled in Access Management. For more information, see xref:access-management::enabling-einstein.adoc[Enabling Einstein for Anypoint Platform]. -NOTE: Authentication happens through the user logged into Anypoint Code Builder. MuleSoft Dev Agent inherits the same permissions as that user and can only execute actions that the user is authorized to perform in Anypoint Platform. +NOTE: Authentication happens through the user logged into Anypoint Code Builder. Mulesoft Vibes inherits the same permissions as that user and can only execute actions that the user is authorized to perform in Anypoint Platform. [[design-spec-ai]] == Design an API Spec with AI -To design an API spec with MuleSoft Dev Agent: +To design an API spec with Mulesoft Vibes: -. Open MuleSoft Dev Agent from the toolbar or from the *Build Your Ecosystem with AI* card in the canvas. +. Open Mulesoft Vibes from the toolbar or from the *Build Your Ecosystem with AI* card in the canvas. . Enter a prompt that describes your API specification. + Include these required details and consider including optional details to generate a more precise spec: @@ -163,58 +164,59 @@ Optionally, provide a description, format, minimum and maximum length, default v Governance isn't included in the validation. [start=3] -. Enter your prompt in MuleSoft Dev Agent and submit it. +. Enter your prompt in Mulesoft Vibes and submit it. . Review the generated specification. -. If *Auto-approve* is enabled, Dev Agent writes the generated API spec directly into your project files. -. If *Auto-approve* is disabled, Dev Agent prompts you to approve or reject each file change before applying it. +. If *Auto-approve* is enabled, Mulesoft Vibes writes the generated API spec directly into your project files. +. If *Auto-approve* is disabled, Mulesoft Vibes prompts you to approve or reject each file change before applying it. . After the API project is generated, you can also: -** Ask Dev Agent to publish the API asset to Exchange. +** Ask Mulesoft Vibes to publish the API asset to Exchange. ** Add governance rulesets to validate your specification. ** Mock requests to the API directly from the IDE. [[rules-workflows]] == Define Rules and Workflows -To define reusable rules and workflows for MuleSoft Dev Agent: +To define reusable rules and workflows for Mulesoft Vibes: -. In the MuleSoft Dev Agent panel, click the *Rules/Workflows* icon in the lower-left corner (next to the *Context* icon). +. In the Mulesoft Vibes panel, click the *Rules/Workflows* icon in the lower-left corner (next to the *Context* icon). . Choose one of the following tabs: * Rules: Define constraints or guidelines for how the API spec should be generated. + For example, enforce naming conventions or require consistent error handling. + Rules can be defined at the *Global Rules* or *Workspace Rules* level. -* Workflows: Create a series of steps that MuleSoft Dev Agent executes as a predefined action. + -Workflows are invoked using slash commands (for example, `/workflow-name`) in the MuleSoft Dev Agent panel. +* Workflows: Create a series of steps that Mulesoft Vibes executes as a predefined action. + +Workflows are invoked using slash commands (for example, `/workflow-name`) in the Mulesoft Vibes panel. [[context-files]] == Provide Additional Context -You can provide additional inputs, such as requirement files (for example, `requirements.txt`), terminal outputs, or project folders, to help Mulesoft Dev Agent generate more accurate API specifications. These files are used as contextual references during API generation. +You can provide additional inputs, such as requirement files (for example, `requirements.txt`), terminal outputs, or project folders, to help Mulesoft Vibes generate more accurate API specifications. These files are used as contextual references during API generation. To add context: -. In the MuleSoft Dev Agent panel, click the *Add Context* icon in the lower-left corner. +. In the Mulesoft Vibes panel, click the *Add Context* icon in the lower-left corner. . Select the file or folder you want to attach, or paste terminal input/output. . Confirm to add the context to your current task. [[settings]] -== MuleSoft Dev Agent Settings +== MuleSoft Vibes Settings -You can control how MuleSoft Dev Agent interacts with your project through the *Settings* panel. -To access this panel, click the *Auto-approve* section at the bottom of the MuleSoft Dev Agent window. +You can control how Mulesoft Vibes interacts with your project through the *Settings* panel. +To access this panel, click the *Auto-approve* section at the bottom of the Mulesoft Vibes window. Available settings are: * *Auto-approve*: Enable to apply changes automatically without prompting for confirmation. + -If Auto-approve is disabled, Dev Agent will request your approval before making any file changes. -* *Read project files*: Allow MuleSoft Dev Agent to read project files for context. -* *Edit project files*: Allow MuleSoft Dev Agent to write changes directly to your project. -* *Read all files*: Allow MuleSoft Dev Agent to read all files on your computer. -* *Edit all files*: Allow MuleSoft Dev Agent to edit any file on your computer. -* *Use MCP Servers*: Allow MuleSoft Dev Agent to use connected MCP servers. -* *Execute safe commands*: Allow MuleSoft Dev Agent to execute safe terminal commands. -* *Execute all commands*: Allow MuleSoft Dev Agent to execute any terminal command. -* *Use the browser*: Allow MuleSoft Dev Agent to launch and interact with websites in a browser. +If Auto-approve is disabled, Mulesoft Vibes requests your approval before making any file changes. +* *Read project files*: Allow MuleSoft Vibes to read project files for context. +* *Edit project files*: Allow Mulesoft Vibes to write changes directly to your project. +* *Read all files*: Allow Mulesoft Vibes to read all files on your computer. +* *Edit all files*: Allow Mulesoft Vibes to edit any file on your computer. +* *Use MCP Servers*: Allow Mulesoft Vibes to use connected MCP servers. + +* *Execute safe commands*: Allow Mulesoft Vibes Agent to execute safe terminal commands. +* *Execute all commands*: Allow Mulesoft Vibes to execute any terminal command. +* *Use the browser*: Allow Mulesoft Vibes to launch and interact with websites in a browser. == See Also diff --git a/modules/ROOT/pages/a4d-checkpoints.adoc b/modules/ROOT/pages/vibes-checkpoints.adoc similarity index 70% rename from modules/ROOT/pages/a4d-checkpoints.adoc rename to modules/ROOT/pages/vibes-checkpoints.adoc index 718048093..691915f1b 100644 --- a/modules/ROOT/pages/a4d-checkpoints.adoc +++ b/modules/ROOT/pages/vibes-checkpoints.adoc @@ -1,14 +1,15 @@ = Use Checkpoints to Track Changes +:page-aliases: a4d-checkpoints.adoc When you have a folder or directory open in Visual Studio Code, you can use checkpoints to track changes to your workspace. -Checkpoints capture the state of your files and Dev Agent tasks at a specific moment in time, allowing you to restore or compare your project with a prior state. +Checkpoints capture the state of your files and MuleSoft Vibes tasks at a specific moment in time, allowing you to restore or compare your project with a prior state. To restore or compare your workspace: . Open a folder or directory in Visual Studio Code. -. Interact with Dev Agent to generate actions that create checkpoints. -. In the MuleSoft Dev Agent panel, locate the checkpoint that you want to reference. +. Interact with MuleSoft Vibes to generate actions that create checkpoints. +. In the MuleSoft Vibes panel, locate the checkpoint that you want to reference. . Choose one of the available options: * *Restore* – Revert your workspace to the selected checkpoint. You can restore: diff --git a/modules/ROOT/pages/a4d-conversation-history.adoc b/modules/ROOT/pages/vibes-conversation-history.adoc similarity index 77% rename from modules/ROOT/pages/a4d-conversation-history.adoc rename to modules/ROOT/pages/vibes-conversation-history.adoc index e0553eee1..e076e7c58 100644 --- a/modules/ROOT/pages/a4d-conversation-history.adoc +++ b/modules/ROOT/pages/vibes-conversation-history.adoc @@ -1,10 +1,10 @@ = View Conversation History -MuleSoft Dev Agent allows you to return to tasks you have previously started and continue working from where you left off. +MuleSoft Vibes allows you to return to tasks you have previously started and continue working from where you left off. To open a recently started task: -. In the MuleSoft Dev Agent panel, locate the *Recent Tasks* section. +. In the MuleSoft Vibes panel, locate the *Recent Tasks* section. . Select the task you want to reopen. If the task is not listed under Recent Tasks: diff --git a/modules/ROOT/pages/int-ai-create-integrations.adoc b/modules/ROOT/pages/vibes-create-integrations.adoc similarity index 50% rename from modules/ROOT/pages/int-ai-create-integrations.adoc rename to modules/ROOT/pages/vibes-create-integrations.adoc index d9c9cb6a8..81b6716f8 100644 --- a/modules/ROOT/pages/int-ai-create-integrations.adoc +++ b/modules/ROOT/pages/vibes-create-integrations.adoc @@ -1,32 +1,32 @@ -= Creating Integrations with MuleSoft Dev Agent += Creating Integrations with MuleSoft Vibes :page-deployment-options: cloud-ide, desktop-ide -:page-aliases: int-ai-enable-einstein.adoc +:page-aliases: int-ai-enable-einstein.adoc int-ai-create-integrations.adoc -MuleSoft Dev Agent is a purpose-built assistant for the development lifecycle, available right in Anypoint Code Builder. MuleSoft Dev Agent supports many capabilities through the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server], such as deploying applications, managing instances, and more. One such capability is transforming your business logic into a Mule application. +MuleSoft Vibes is a purpose-built assistant for the development lifecycle, available right in Anypoint Code Builder. MuleSoft Vibes supports many capabilities through the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server], such as deploying applications, managing instances, and more. One such capability is transforming your business logic into a Mule application. The generated application includes the integration, connector configurations, a sample properties file, and the dependencies required for connectors. These artifacts ensure that the generated integration is runnable and can be deployed directly from Anypoint Code Builder. [[before-you-begin]] == Before You Begin -To create integrations with MuleSoft Dev Agent, ensure you: +To create integrations with Mulesoft Vibes, ensure you: * Read xref:start-acb.adoc[]. * Set the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. -* Configure the following permissions to use MuleSoft Dev Agent: +* Configure the following permissions to use Mulesoft Vibes: ** *Mule Developer Generative AI User* * Enable Einstein in Access Management. See xref:access-management::enabling-einstein.adoc[]. * xref:access-management::connecting-salesforce-orgs.adoc[]. [[access-dev-agent]] -== Access Dev Agent +== Access Mulesoft Vibes -There are two ways to open MuleSoft Dev Agent: +There are two ways to open Mulesoft Vibes: * When you create a new integration project, click a card in the canvas. For example, the *Build an Ecosystem with AI* card. -* Click the Dev Agent icon in the toolbar. +* Click the Mulesoft Vibes icon in the toolbar. + -image::int-einstein-icon-in-toolbar.png["Arrow pointing to Dev Agent icon in the toolbar"] +image::int-einstein-icon-in-toolbar.png["Arrow pointing to the Mulesoft Vibes icon in the toolbar"] [[create-integration-project]] == Create a New Integration Project @@ -55,12 +55,12 @@ For example, if the project name is "My Integration", the name of the folder for + The integration builder canvas appears with starting cards. -To generate an integration with AI, click *Use Dev Agent* in the *Build an Ecosystem with AI* card. +To generate an integration with AI, click *Use Mulesoft Vibes* in the *Build an Ecosystem with AI* card. [[craft-ai-prompt]] == Write Your Prompt -Before you create an integration, define what you want to achieve with the integration, for example, optimizing a business process. In the Dev Agent panel, enter your prompt using natural language. The clearer and more specific your prompt, the more accurate the generated integration. +Before you create an integration, define what you want to achieve with the integration, for example, optimizing a business process. In the Mulesoft Vibes panel, enter your prompt using natural language. The clearer and more specific your prompt, the more accurate the generated integration. Best practices for prompts: @@ -70,38 +70,12 @@ Best practices for prompts: * Specify the data objects (for example, *Salesforce Account object*). * Review your prompt before submitting it. -After Dev Agent generates the initial integration, the code is written directly into your project. You can further customize it to fit your requirements. - -[[agent-settings]] -== Configure Dev Agent Settings - -You can control how MuleSoft Dev Agent interacts with your project through the *Settings* panel. - -You can configure: - -* *Enable auto-approve*: Apply changes automatically without prompting for confirmation. + -If *Auto-approve* is disabled, MuleSoft Dev Agent will request your approval before making any file changes. -* *Read project files*: Allow MuleSoft Dev Agent to read project files for context. -* *Edit project files*: Allow MuleSoft Dev Agent to write changes directly to your project. -* *Read all files*: Allow MuleSoft Dev Agent to read all files on your computer. -* *Edit all files*: Allow MuleSoft Dev Agent to edit any file on your computer. -* *Use MCP Servers*: Allow MuleSoft Dev Agent to use connected MCP servers. -* *Execute safe commands*: Allow MuleSoft Dev Agent to execute safe terminal commands. -* *Execute all commands*: Allow MuleSoft Dev Agent to execute any terminal command. -* *Use the browser*: Allow MuleSoft Dev Agent to launch and interact with websites in a browser. - -[[extend-dev-agent]] -== Adding Rules and Workflows - -* The MuleSoft MCP server comes embedded in Dev Agent, providing built-in tools for tasks such as listing or deploying applications. -* You can add custom MCP servers from Marketplace or by configuring a remote server. -* Define *rules* to guide how Dev Agent generates integrations according to your organization’s standards. -* Create *workflows* to automate multi-step actions, which can be triggered through slash commands in the panel. +After Mulesoft Vibes generates the initial integration, the code is written directly into your project. You can further customize it to fit your requirements. [[complete-gen-flow]] == Complete Your Integration -After Dev Agent builds the integration, complete the configuration as needed. +After Mulesoft Vibes builds the integration, complete the configuration as needed. Components that require further configuration display the error icon. Select the component in the canvas to determine where the error is. Anypoint Code Builder highlights the location of the error within the configuration XML. diff --git a/modules/ROOT/pages/vibes-get-started.adoc b/modules/ROOT/pages/vibes-get-started.adoc new file mode 100644 index 000000000..0d20a498e --- /dev/null +++ b/modules/ROOT/pages/vibes-get-started.adoc @@ -0,0 +1,85 @@ += Get Started with MuleSoft Vibes +:page-aliases: a4d-get-started.adoc + +MuleSoft Vibes helps you build APIs and integrations using natural language prompts directly in your development environment. + +== Use MuleSoft Vibes + +You can open MuleSoft Vibes from the: + +* Toolbar icon +* Top navigation bar +* *Build with AI* card in the project canvas + +When you submit a prompt, MuleSoft Vibes processes it using the MuleSoft MCP Server and performs actions such as generating API specifications or integration flows. + +Depending on your configuration, MuleSoft Vibes can: + +* Request approval before writing to your files +* Write automatically if *Auto-approve* is enabled in settings + +=== Plan and Act Modes + +MuleSoft Vibes operates in two modes: + +* *Plan Mode* +MuleSoft Vibes analyzes your prompt and produces a step-by-step plan describing how it will accomplish the task. No actions are executed automatically in this mode. + +* *Act Mode* +MuleSoft Vibes attempts to perform the actions outlined in the plan by using the MuleSoft MCP Server tools to modify files, create resources, or execute changes to your project. + +You can switch between modes depending on whether you prefer to review the plan before execution or allow MuleSoft Vibes to act directly. + + +=== How MuleSoft Vibes Generates Code + +MuleSoft Vibes uses MuleSoft-optimized AI pipelines to generate high-quality code for API specifications and integration flows. + +The pipelines are exposed to MuleSoft Vibes through these MCP tools: + +* `generate_mule_flow` – Generates Mule integration flows. +* `generate_api_spec` – Generates API specifications from natural language prompts. + +Because these tools run on pipelines optimized specifically for MuleSoft use cases, users typically receive higher-quality code outputs (on average, 60% better) compared to generic generation. + +To ensure the best results: + +* Verify that the MuleSoft MCP Server is loaded in MuleSoft Vibes prior to sending a prompt. +* Make sure MuleSoft Vibes is invoking these specialized tools. +* Verify that all required prerequisites for MuleSoft Vibes and MCP Server are enabled in your environment. + +For more information about how MuleSoft’s AI generation pipelines work, see the https://blogs.mulesoft.com/automation/how-mulesoft-turns-generative-output-into-value/[MuleSoft research blog^]. + + +== Provide MuleSoft Vibes with Context + +You can improve the accuracy of MuleSoft Vibes output by providing additional context files or inputs. +Examples include requirement files (`requirements.txt`), configuration folders, logs, URLs, or terminal output. + +To add context: + +. In the MuleSoft Vibes panel, click the *Add Context* icon in the lower-left corner. +. Select files or folders to attach, paste the input or output from terminal, or paste a URL. +. Confirm to add the context to your current task. + +You can also add context directly from the prompt input box by typing `@`, which opens the same context selector. + +These inputs are used as contextual references during generation. + +== Configure MuleSoft Vibes Settings + +You can customize how MuleSoft Vibes interacts with your project through the *Settings* panel. +To access this panel, click the *Auto-approve* section at the bottom of the MuleSoft Vibes window. + +The available options include: + +* *Auto-approve*: Automatically apply changes without prompting for confirmation. +* *Read project files*: Allow MuleSoft Vibes to read project files for context. +* *Edit project files*: Allow MuleSoft Vibes to write changes directly to your project. +* *Read all files*: Allow MuleSoft Vibes to read all files on your computer. +* *Edit all files*: Allow MuleSoft Vibes to edit any file on your computer. +* *Use MCP Servers*: Allow MuleSoft Vibes to use connected MCP servers. + +* *Execute safe commands*: Allow MuleSoft Vibes to execute safe terminal commands. +* *Execute all commands*: Allow MuleSoft Vibes to execute any terminal command. +* *Use the browser*: Allow MuleSoft Vibes to launch and interact with websites in a browser. diff --git a/modules/ROOT/pages/a4d-mcp-server.adoc b/modules/ROOT/pages/vibes-mcp-server.adoc similarity index 84% rename from modules/ROOT/pages/a4d-mcp-server.adoc rename to modules/ROOT/pages/vibes-mcp-server.adoc index 9ac6159a4..253d62ffe 100644 --- a/modules/ROOT/pages/a4d-mcp-server.adoc +++ b/modules/ROOT/pages/vibes-mcp-server.adoc @@ -1,10 +1,11 @@ = Configure an MCP Server +:page-aliases: a4d-mcp-server.adoc -Add and manage MCP servers in Anypoint Code Builder to extend MuleSoft Dev Agent with tools for API design, integrations, governance, and agent networks. +Add and manage MCP servers in Anypoint Code Builder to extend MuleSoft Vibes with tools for API design, integrations, governance, and agent networks. == Use the MuleSoft MCP Server -The MuleSoft MCP Server is integrated within Anypoint Code Builder and provides built-in tools to extend MuleSoft Dev Agent’s capabilities. +The MuleSoft MCP Server is integrated within Anypoint Code Builder and provides built-in tools to extend MuleSoft Vibes capabilities. You can use these tools to generate API specifications, create and deploy integrations, manage governance rulesets, and build Agent Fabric agent networks. You can also work with DataWeave and gain insights into the performance of your applications and APIs—all directly from Anypoint Code Builder. @@ -14,14 +15,14 @@ For more information about the MuleSoft MCP Server tools and their parameters, s == Add and Manage Custom MCP Servers -From the MuleSoft Dev Agent panel, you can add your own MCP server or manage connected MCP servers through the MCP Server settings. +From the MuleSoft Vibes panel, you can add your own MCP server or manage connected MCP servers through the MCP Server settings. == Open MCP Server Settings -. Open the MuleSoft Dev Agent panel in Anypoint Code Builder. +. Open the MuleSoft Vibes panel in Anypoint Code Builder. . Select *Manage MCP Servers*. + -NOTE: From this view, you can enable or disable MCP servers that have been installed. The MuleSoft MCP Server comes pre-installed with Dev Agent. +NOTE: From this view, you can enable or disable MCP servers that have been installed. The MuleSoft MCP Server comes pre-installed with MuleSoft Vibes. . Select the gear icon to open the full MCP Server settings. This opens the MCP Servers UI with three tabs: @@ -74,18 +75,18 @@ Once an MCP server has been installed, you can manage it from the *Installed* ta == Manage Tools for an MCP Server -Each MCP server provides a set of tools that Dev Agent can use. The following steps show you how to work with an MCP server: +Each MCP server provides a set of tools that MuleSoft Vibes can use. The following steps show you how to work with an MCP server: . In the *Installed* tab, select a server to expand its details. . View the list of available tools for that server. . To auto-approve an individual tool, check the *Auto-approve* box next to that tool. + -NOTE: Auto-approval for tools is available only if Auto-approve has been enabled in Dev Agent settings. +NOTE: Auto-approval for tools is available only if Auto-approve has been enabled in MuleSoft Vibes settings. . To auto-approve all tools from a server, scroll to the bottom of the list and enable *Auto-approve all tools*. == Configure Request Timeout -Follow these steps to configure how long Dev Agent waits for a response from an MCP server: +Follow these steps to configure how long MuleSoft Vibes waits for a response from an MCP server: . In the server details panel, locate *Request Timeout*. . Select a timeout value. diff --git a/modules/ROOT/pages/a4d-prompt-examples.adoc b/modules/ROOT/pages/vibes-prompt-examples.adoc similarity index 98% rename from modules/ROOT/pages/a4d-prompt-examples.adoc rename to modules/ROOT/pages/vibes-prompt-examples.adoc index e03a544af..c122109a3 100644 --- a/modules/ROOT/pages/a4d-prompt-examples.adoc +++ b/modules/ROOT/pages/vibes-prompt-examples.adoc @@ -1,6 +1,8 @@ -= Mulesoft Dev Agent Example Prompts += Mulesoft Vibes Example Prompts +:page-aliases: a4d-prompt-examples.adoc -Use these example prompts to guide MuleSoft Dev Agent in completing common tasks. Customize the values to match your project or environment. + +Use these example prompts to guide Mulesoft Vibes in completing common tasks. Customize the values to match your project or environment. include::mulesoft-mcp-server::partial$agent-prompts.adoc[tag=app-deployment,leveloffset=+1] diff --git a/modules/ROOT/pages/vibes-workflows-commands.adoc b/modules/ROOT/pages/vibes-workflows-commands.adoc new file mode 100644 index 000000000..fe667cd3e --- /dev/null +++ b/modules/ROOT/pages/vibes-workflows-commands.adoc @@ -0,0 +1,65 @@ += Workflows and Rules +:page-aliases: a4d-workflows-commands.adoc + + +Rules and Workflows allow developers to customize how Mulesoft Vibes operates within their project. + +Rules Define natural-language constraints or guidelines for how Mulesoft Vibes should generate content. + +You can use rules to enforce naming conventions, ensure consistent error handling, or maintain coding standards across your workspace. +Rules can be defined at two levels: + +* *Global* – Applies to all prompts sent to Mulesoft Vibes. + +* *Workspace* – Applies only to the active workspace. + +Workflows create predefined multi-step tasks that MuleSoft Vibes executes automatically. + +Workflows let you streamline repeated development steps and can be triggered using slash commands (for example, `/workflow-name`) in the Mulesoft Vibes panel. + +== Add Workflows or Rules + +. Open MuleSoft Mulesoft Vibes in the sidebar. +. Select *Settings*. +. In the *Rules and Workflows* section, choose whether you want to add a rule or a workflow. +. Select *Add Rule* or *Add Workflow*. +. Provide the required information: +* For rules, enter the natural-language instruction you want Mulesoft Vibes to follow. +* For workflows, enter a name, an optional description, and the steps the workflow should run. +. Select *Save*. + +You can edit or delete existing rules and workflows from the same section. + +=== Rule examples + +You can use rules to guide how Mulesoft Vibes generates or validates content. For example: + +* *Naming convention rule*: Instruct Mulesoft Vibes to ensure that all API names follow your organization’s naming standards. + +* *Validation rule*: Require that every API specification includes version information before generating related files. + +* *Security rule*: Ask Mulesoft Vibes to flag endpoints that expose sensitive data without authentication. + +==== Workflow examples + +Workflows define a sequence of steps that Mulesoft Vibes executes to complete a task. For example: + +* *API design validation workflow*: Validate an API specification, check naming conventions, verify security requirements, and generate a summary of issues. + +* *API creation workflow*: Generate an API specification, apply validation rules, suggest improvements, and save the final version to the workspace. + +* *Troubleshooting workflow*: Analyze an error, identify the root cause, propose a fix, and update the configuration if needed. + +== Add Commands + +Commands provide quick shortcuts for interacting with Mulesoft Vibes. +You can invoke any command by typing `/` in the prompt input box. + +Mulesoft Vibes includes several built-in commands: + +* `/newrule` — Create a new rule based on the current conversation. +* `/newchat` — Start a new chat that carries over context from your current task. +* `/reportbug` — Report an issue by creating a GitHub ticket with Agentforce Vibes formatting. + +Workflows that you define also appear as commands under *Workflow Commands*. +You can trigger them the same way by typing `/` followed by the workflow name.