diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 55e078ccb..4180d4bb0 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -54,6 +54,17 @@ ** xref:af-project-files.adoc[] * xref:ai-enabling-api-project-topic-center.adoc[] +// USE AI TO DESIGN AN API SPEC +* xref:dev-agent-overview.adoc[] +* xref:api-ai-design-spec.adoc[] +** xref:api-ai-create-spec.adoc[] +** xref:int-ai-developing-integrations.adoc[] +** xref:int-ai-create-integrations.adoc[] +** xref:gen-ai-examples.adoc[] +** xref:int-ai-gen-flow-examples.adoc[] +** xref:troubleshoot-generative-ai.adoc[] + + // DESIGN * xref:des-designing-api-specs.adoc[] ** xref:des-create-api-specs.adoc[] @@ -63,12 +74,6 @@ ** xref:des-govern-api.adoc[] ** xref:des-delete-api-projects.adoc[] -// USE AI TO DESIGN AN API SPEC -* xref:api-ai-design-spec.adoc[] -** xref:api-ai-create-spec.adoc[] -** xref:gen-ai-examples.adoc[] -** xref:troubleshoot-generative-ai.adoc[] - // INTEGRATE * xref:int-developing-integrations.adoc[] ** xref:int-create-integrations.adoc[] @@ -90,11 +95,6 @@ ** xref:int-deploy-mule-apps.adoc[] ** xref:int-versions.adoc[] -// USE AI TO BUILD AN INTEGRATION -* xref:int-ai-developing-integrations.adoc[] -** xref:int-ai-create-integrations.adoc[] -** xref:int-ai-gen-flow-examples.adoc[] -** xref:troubleshoot-generative-ai.adoc[] // IMPLEMENT * xref:imp-implementing-apis.adoc[] diff --git a/modules/ROOT/pages/dev-agent-overview.adoc b/modules/ROOT/pages/dev-agent-overview.adoc new file mode 100644 index 000000000..01ffe2cb1 --- /dev/null +++ b/modules/ROOT/pages/dev-agent-overview.adoc @@ -0,0 +1,168 @@ += MuleSoft Dev Agent Overview +:page-deployment-options: cloud-ide, desktop-ide + +MuleSoft Dev Agent is a purpose-built assistant for the development lifecycle, available directly in Anypoint Code Builder. +It enables you to build, manage, and maintain your projects using natural language prompts. +MuleSoft Dev Agent integrates with the xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] and supports capabilities such as: + +* Developing API specifications +* Creating and configuring applications +* Searching for assets +* Deploying and managing instances + +These features are powered by large language models (LLMs) that operate within the Salesforce Shared Trust Boundary. + +NOTE: MuleSoft Dev Agent is available on US, EU, Canada, and Japan cloud hosts. + +[[before-you-begin]] +== Before You Begin + +Before you start using MuleSoft Dev Agent, ensure that you meet the following prerequisites: + +* xref:start-acb.adoc[Set up and access the web or desktop IDE]. +* Verify that you have the xref:start-configure-permissions.adoc#permissions[required Anypoint Code Builder permissions]. +* Make sure you have the following roles to use MuleSoft Dev Agent: +** *Anypoint Code Builder Developer* (for using Dev Agent in the Cloud IDE) +** *Mule Developer Generative AI User* +* Enable Einstein in Access Management. See xref:access-management::enabling-einstein.adoc[Enabling Einstein for Anypoint Platform]. +* Ensure that your organization’s business group has Einstein generative AI enabled. + +If you don’t see the AI features in the IDE, contact your Anypoint Platform administrator. + +[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. + +[[access-dev-agent]] +== Use MuleSoft Dev Agent + +You can open MuleSoft Dev Agent from: + +* The toolbar icon +* The *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, or +* Write automatically if *Auto-approve* is enabled in settings. + +== Add Rules and Workflows + +To define reusable rules and workflows: + +. In the MuleSoft Dev Agent 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 MuleSoft Dev Agent should generate content. + For example, enforce naming conventions or ensure consistent error handling. + Rules can be created at the *Global* or *Workspace* level. +* *Workflows*: Create predefined multi-step tasks that MuleSoft Dev Agent executes automatically. + Workflows are triggered using slash commands (for example, `/workflow-name`) in the Dev Agent panel. + +[[mcp-server-support]] +== MCP Server Support + +The xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server] is integrated within Anypoint Code Builder and provides built-in tools to extend MuleSoft Dev Agent’s capabilities. +You can use these tools to generate API specifications, create and deploy integrations, manage governance rulesets, and build Agent Fabric agent networks—all directly from Anypoint Code Builder. + +Only the following tools are available within Anypoint Code Builder; they aren’t supported in other IDEs: + +* *Agent Fabric Tools* +** `configure_agent_network_yaml` – Modify agent-network YAML configurations for Agent Fabric projects. +** `create_agent_network_project` – Create and scaffold agent-network projects. +** `deploy_agent_network` – Deploy an agent network to a runtime environment. +** `publish_agent_network_assets` – Publish agent network assets to Anypoint Exchange for reuse. + +* *Governance Tools* +** `add_governance_ruleset` – Add a governance ruleset from Exchange to your project. +** `list_governance_rulesets` – List available governance rulesets. +** `validate_api_against_ruleset` – Validate your API spec against governance rulesets. + +* *API and Integration Tools* +** `generate_api_spec` – Generate or modify an API specification with MuleSoft Dev Agent. +** `mock_api_spec` – Mock an API spec to test endpoint functionality. +** `generate_mule_flow` – Create Mule flows and integration logic from natural language prompts. +** `open_project` – Open or manage an existing API or agent-network project. +** `validate_project` – Validate a project before publishing or deployment. + +* *Metadata and Topic Tools* +** `get_topics_agent_actions_metadata_instructions` – Retrieve metadata and instructions for enabling topics and agent actions from an OpenAPI spec. +** `create_and_manage_metadata` – Define or update metadata for Mule flow components. + +* *Connectivity and Validation Tools* +** `test_connection` – Validate connector configurations, such as HTTP or Salesforce connectors. + +For more information, see xref:mulesoft-mcp-server::reference-mcp-tools.adoc[MCP Server Tools]. + +=== Connecting Your Own MCP Server +If you require additional capabilities or permissions, you can connect your own MCP Server. You can: +* Configure a custom MCP Server through the Anypoint Code Builder UI. +* Install it from the Marketplace or Exchange. +* Manually configure it in your local `config.json` file. + +For setup details, see xref:mulesoft-mcp-server::getting-started.adoc#set-up-authentication[Setting up authentication for MCP Server]. + +=== Managing MCP Servers + +From the MuleSoft Dev Agent Settings panel, you can manage connected MCP Servers: + +. Open the MuleSoft Dev Agent panel in Anypoint Code Builder. +. Click *Settings* at the bottom left. +. Select the *MCP Servers* tab to view currently connected servers. +. To enable or disable the built-in MCP Server: + * Toggle the switch next to “Built-in MCP Server”. + * Confirm the action when prompted. +. To add or switch to a custom MCP Server: + * Click *Add MCP Server*. + * Provide the server URL, authentication credentials, and alias. + * Select the new server from the list as your active connection. +. To restart or delete a connected MCP Server: + * Select the server in the list. + * Click *Restart Server* to refresh the connection. + * Or click *Delete Server* and confirm removal. +. To configure auto-approve behavior for MCP actions: + * While in the MCP Servers tab, click the *Settings* button for the selected server. + * Under *Auto-approve policy*, choose *Manual approval* or *Automatic execution*. + * Save your settings. + +[NOTE] +Tool availability and behavior may vary depending on the MCP Server version and configuration. + + +[[context-files]] +== Add File Context + +You can improve the accuracy of MuleSoft Dev Agent’s outputs by providing additional input files. +Examples include requirement files (such as `requirements.txt`), configuration folders, or terminal outputs. + +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, or paste terminal input/output. +. Confirm to add the context to your current task. + +These files are used as contextual references during generation. + + +[[settings]] +== 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. + +Available settings 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. + + +== See Also + +xref:troubleshooting-generative-ai.adoc[Troubleshooting MuleSoft Dev Agent] +* xref:mulesoft-mcp-server::index.adoc[MuleSoft MCP Server Overview]