# mulesoft MuleSoft MCP Servers - Full Documentation

<!-- document id=0e26cb3f79c58277a880e48d8099490eaf48b020eb251274952afacf5feaa51c url=/mulesoft/current/en-us/mulesoft-mcp-server/getting-started.md -->

---
product: MuleSoft MCP Servers
---

# Getting Started with MuleSoft DX MCP Server

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft DX MCP Server enables AI-powered development assistants in your IDE to interact with
Anypoint Platform, helping you manage APIs, applications, and platform resources directly from your
coding environment. Install prerequisites, create a connected app with the scopes your tools
require, and register the server in the IDE so assistants can call Anypoint Platform with your
environments and identities.

> [!IMPORTANT] If you have Anypoint Code Builder or Connector Builder, MuleSoft DX MCP Server is
> already installed and configured in MuleSoft Vibes. For more information, see
> [Creating API Specs with MuleSoft Vibes](https://docs.mulesoft.com/anypoint-code-builder/vibes-api-ai-create-spec) and
> [Connector Builder Overview](https://docs.mulesoft.com/connector-builder/).

## Before You Begin

Before you install and use MuleSoft DX MCP Server, ensure you have installed the following software:

- Anypoint Extension Pack version 1.10.0 or later

- Git

- Node.js 20 or later. Download [Node.js](https://nodejs.org/en/download).

You also need permissions or access to perform these tasks:

- Organization administrator access:
  [create a connected app](https://docs.mulesoft.com/access-management/connected-apps-overview)

- [Enabling or Disabling Generative AI for Anypoint Platform](https://docs.mulesoft.com/access-management/enabling-generative-ai)
  access to: run the `generate_mule_flow` and `generate_api_spec` tools.

## Create a Connected App

Follow the steps in
[Create a Connected App That Acts on Its Own Behalf](https://docs.mulesoft.com/access-management/creating-connected-apps-dev#create-connected-app-on-its-own-behalf)
to create a connected app. Note the Client ID and Client Secret, as you need these to configure
MuleSoft DX MCP Server in your IDE.

Additionally, when prompted, add the following permission scopes. These scopes enable you to use
specific MuleSoft DX MCP Server tools.

For a connected app created in a child business group, assign the **View Organization** and **View
Connected Applications** permissions at the root organization. Assign the remaining permissions at
the organization, business group, or environment required by the tools that you use.

Refer to the [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools) for details on all
MuleSoft DX MCP Server tools. Only tools listed in these tables require specific permission scopes.

### Anypoint Code Builder

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>Use natural language prompts to develop and generate flows using Anypoint Code Builder Generative Flows.</p></td><td><p>Mule Developer Generative AI User<br><code>create:generations</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#generate-mule-flow">generate_mule_flow</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#generate-api-spec">generate_api_spec</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-mcp-server">create_MCP_server</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#generate-munit-test">generate_munit_test</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#modify-munit-test">modify_munit_test</a></p></li></ul></div></div></td></tr></tbody></table>

### Anypoint Monitoring

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View but not modify content in Anypoint Monitoring.</p></td><td><p>Monitoring Viewer<br><code>view:monitoring</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></li></ul></div></div></td></tr></tbody></table>

### API Manager

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View and modify API configurations in the specified environment.</p></td><td><p>Manage API Configuration<br><code>manage:api_configuration</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-api-instances">create_and_manage_api_instances</a></p></td></tr><tr><td><p>View, create, modify, and delete API policies in the specified environment.</p></td><td><p>Manage Policies<br><code>manage:api_policies</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#manage-api-instance-policy">manage_api_instance_policy</a></p></td></tr><tr><td><p>View API configurations in the specified environment.</p></td><td><p>View APIs Configuration<br><code>read:api_configuration</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-api-instances">list_api_instances</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li></ul></div></div></td></tr></tbody></table>

### Exchange

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><div><div><ul><li><p>View, create, and download assets within a business group.</p></li><li><p>Edit asset portal content in an existing asset version.</p></li></ul></div></div></td><td><p>Exchange Administrator<br><code>manage:exchange</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-assets">create_and_manage_assets</a></p></td></tr><tr><td><p>View, create, and download assets within a business group.</p></td><td><p>Exchange Contributor<br><code>edit:exchange</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-assets">create_and_manage_assets</a></p></td></tr><tr><td><p>Create new assets within a business group’s catalog.</p></td><td><p>Exchange Creator<br><code>create:exchange</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-and-manage-assets">create_and_manage_assets</a></p></td></tr><tr><td><p>View and download assets within a business group.</p></td><td><p>Exchange Viewer<br><code>read:exchange</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#search-asset">search_asset</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#implement-api-spec">implement_api_spec</a></p></li></ul></div></div></td></tr></tbody></table>

### General

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View organization information.</p></td><td><p>View Organization<br><code>read:organization</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li></ul></div></div></td></tr><tr><td><p>View connected applications.</p></td><td><p>View Connected Applications<br><code>read:orgconnapps</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li></ul></div></div></td></tr></tbody></table>

### Runtime Manager

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View applications in a specific environment.</p></td><td><p>Read Applications<br><code>read:applications</code></p></td><td><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></td></tr><tr><td><p>Create applications in a specific environment.</p></td><td><p>Create Applications<br><code>create:applications</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#update-mule-application">update_mule_application</a></p></li></ul></div></div></td></tr><tr><td><p>Query Runtime Fabric instances in the organization.</p></td><td><p>Read Runtime Fabrics<br><code>read:runtime_fabrics</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#list-applications">list_applications</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#deploy-mule-application">deploy_mule_application</a></p></li></ul></div></div></td></tr><tr><td><p>View CloudHub and CloudHub 2.0 network resources.</p></td><td><p>CloudHub Network Viewer<br><code>read:cloudhub_networking</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li></ul></div></div></td></tr></tbody></table>

### Usage

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tool</th></tr></thead><tbody><tr><td><p>View usage reports.</p></td><td><p>Usage Viewer<br><code>view:metering</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-platform-insights">get_platform_insights</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#get-reuse-metrics">get_reuse_metrics</a></p></li></ul></div></div></td></tr></tbody></table>

## Install MuleSoft DX MCP Server

Install MuleSoft DX MCP Server and then configure it in your IDE by adding the appropriate
configuration snippet with your connected app credentials.

To install with Node.js, run: `npm install -g mulesoft-mcp-server`.

### Configure Your IDE

You can configure Claude Desktop, Cursor, Windsurf, Zed, and other IDEs to work with the MuleSoft DX
MCP Server. After you add the configuration, verify it by checking that the server has started in
the MCP section of your IDE.

For more information about Anypoint Platform regions, see
[Control Plane Hosting Options](https://docs.mulesoft.com/hosting-home/#control-plane-hosting-options).

#### Claude Desktop

Add this snippet to `claude_desktop_config.json` where `ANYPOINT_REGION` (optional) is one of these
values: `PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "mcpServers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server", "start"\],
"env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CLIENT\_ID>", "ANYPOINT\_CLIENT\_SECRET":
"<YOUR\_CLIENT\_SECRET>", "ANYPOINT\_REGION": "<REGION\_NAME>" } } } }

Download [Claude Desktop](https://claude.com/download).

#### Cline

Add this snippet to Cline `config.json` where `ANYPOINT_REGION` (optional) is one of these values:
`PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "mcpServers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server", "start"\],
"env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CLIENT\_ID>", "ANYPOINT\_CLIENT\_SECRET":
"<YOUR\_CLIENT\_SECRET>", "ANYPOINT\_REGION": "<REGION\_NAME>" } } } }

Download [Cline](https://cline.bot/).

#### Cursor

Add this snippet to Cursor `mcp.json` where `ANYPOINT_REGION` (optional) is one of these values:
`PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "mcpServers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server", "start"\],
"env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CONNECTED\_APP\_CLIENT\_ID>", "ANYPOINT\_CLIENT\_SECRET":
"<YOUR\_CONNECTED\_APP\_CLIENT\_SECRET>", "ANYPOINT\_REGION": "<REGION\_NAME>" } } } }

Download [Cursor](https://cursor.com/).

#### Trae

Add this snippet to Trae `mcp_settings.json` or `.vscode/mcp.json` where `ANYPOINT_REGION`
(optional) is one of these values: `PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "mcpServers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server", "start"\],
"env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CONNECTED\_APP\_CLIENT\_ID>", "ANYPOINT\_CLIENT\_SECRET":
"<YOUR\_CONNECTED\_APP\_CLIENT\_SECRET>", "ANYPOINT\_REGION": "<REGION\_NAME>" } } } }

Download [Trae](https://www.trae.ai/).

#### VS Code

Add this snippet to VS Code `settings.json` or `.vscode/mcp.json` where (optional) `ANYPOINT_REGION`
is one of these values: `PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "mcp": { "servers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server",
"start"\], "env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CONNECTED\_APP\_CLIENT\_ID>",
"ANYPOINT\_CLIENT\_SECRET": "<YOUR\_CONNECTED\_APP\_CLIENT\_SECRET>", "ANYPOINT\_REGION":
"<REGION\_NAME>" } } } } }

Download [VS Code](https://code.visualstudio.com/).

#### Windsurf

Add this snippet to Windsurf `mcp_config.json` where `ANYPOINT_REGION` (optional) is one of these
values: `PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "mcpServers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server", "start"\],
"env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CONNECTED\_APP\_CLIENT\_ID>", "ANYPOINT\_CLIENT\_SECRET":
"<YOUR\_CONNECTED\_APP\_CLIENT\_SECRET>", "ANYPOINT\_REGION": "<REGION\_NAME>" } } } }

Download [Windsurf](https://windsurf.com/).

#### Zed

Add this snippet to Zed `settings.json` where `ANYPOINT_REGION` (optional) is one of these values:
`PROD_US`, `PROD_EU`, `PROD_CA`, or `PROD_JP`.

{ "context\_servers": { "mulesoft": { "command": "npx", "args": \["-y", "mulesoft-mcp-server",
"start"\], "env": { "ANYPOINT\_CLIENT\_ID": "<YOUR\_CONNECTED\_APP\_CLIENT\_ID>",
"ANYPOINT\_CLIENT\_SECRET": "<YOUR\_CONNECTED\_APP\_CLIENT\_SECRET>", "ANYPOINT\_REGION":
"<REGION\_NAME>" } } } }

Download [Zed](https://github.com/zed-industries/zed).

## See Also

- [Using MuleSoft DX MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/using-mulesoft-mcp-server)

<!-- document id=d7c035970f9355da6ca63c1a97139dd0a680775e0332036d44a909a99c7b31ce url=/mulesoft/current/en-us/mulesoft-mcp-server/getting-started-platform.md -->

---
product: MuleSoft MCP Servers
---

# Getting Started with MuleSoft Platform MCP Server

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Scan, discover, govern, and monitor APIs, agents, MCP servers, and LLMs across your entire IT
landscape from a single AI-accessible interface. MuleSoft Platform MCP Server gives AI tools
governed access to your infrastructure to accelerate production-ready AI deployment. Connect your
IDE in minutes using any MCP-compatible client.

## Create a Connected App

Create a connected app that acts on your behalf so AI clients can access Anypoint Platform. After
you create the app, copy the Client ID and Client Secret. You need these values when you configure
your IDE.

1.  In Anypoint Platform,
    [create a connected app that acts on behalf of a user](https://docs.mulesoft.com/access-management/creating-connected-apps-dev#create-connected-app).
    As part of the process, configure the app with the following settings:

    1.  Select the **Authorization Code** and **Refresh Token** grant types.

    2.  In **Redirect URIs**, enter the redirect URL for the AI client you plan to use. See
        [Configure Your IDE](#configure-your-ide) for the URL for each supported client.

    3.  Click **Add Scopes** and add these scopes:

        - Full Access (`full`)

        - Background Access (`offline_access`)

          You need these scopes to use the MCP server.

    4.  Copy the Client ID and Client Secret.

Some tools require additional permission scopes. Refer to the
[MuleSoft Platform MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform) for details on all
MuleSoft Platform MCP Server tools. Only tools listed in the following tables require specific
permission scopes.

### Exchange

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>View and download assets within a business group.</p></td><td><p>Exchange Viewer<br><code>read:exchange</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-service-facets">fetch_service_facets</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-services">fetch_services</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-agents">list_agents</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-apis">list_apis</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-llms">list_llms</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-mcp-servers">list_mcp_servers</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#search-assets-semantic">search_assets_semantic</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#search-global-assets">search_global_assets</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#search-global-content">search_global_content</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#search-portfolio-services">search_portfolio_services</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#search-repository-knowledge">search_repository_knowledge</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-agent-details">view_agent_details</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-api-version-details">view_api_version_details</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-llm-details">view_llm_details</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-mcp-server-details">view_mcp_server_details</a></p></li></ul></div></div></td></tr><tr><td><p>View, create, and download assets within a business group, including editing asset portal content in an existing asset version.</p></td><td><p>Exchange Contributor<br><code>edit:exchange</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-mcp-server-state">get_mcp_server_state</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-provision-status">get_provision_status</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-trusted-mcp-catalog">get_trusted_mcp_catalog</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#provision-mcp-server">provision_mcp_server</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#resume-provision-job">resume_provision_job</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#update-mcp-server">update_mcp_server</a></p></li></ul></div></div></td></tr></tbody></table>

### API Manager

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>View API configurations and policies in the specified environment.</p></td><td><p>API Manager Environment Viewer<br><code>read:api_configuration</code><br><code>read:api_policies</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#check-guardrail-scope-targets">check_guardrail_scope_targets</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-automated-policy-template">fetch_automated_policy_template</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-guardrail-ruleset">fetch_guardrail_ruleset</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-policy-template-form">get_policy_template_form</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-governance-strategies">list_governance_strategies</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-provider-gateways">list_provider_gateways</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#prepare-automated-policy-creation">prepare_automated_policy_creation</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#prepare-guardrail-creation">prepare_guardrail_creation</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#prepare-policy-creation">prepare_policy_creation</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-api-instance-details">view_api_instance_details</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-api-instance-policies">view_api_instance_policies</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-api-version-instances">view_api_version_instances</a></p></li></ul></div></div></td></tr><tr><td><p>View, create, modify, and delete APIs in the specified environment.</p></td><td><p>API Manager Environment Admin<br><code>manage:apis</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#apply-policy-to-instance">apply_policy_to_instance</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#create-automated-policy-strategy">create_automated_policy_strategy</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#delete-automated-policy-strategy">delete_automated_policy_strategy</a></p></li></ul></div></div></td></tr></tbody></table>

### Anypoint Monitoring

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>View but not modify content in Anypoint Monitoring.</p></td><td><p>Monitoring Viewer<br><code>view:monitoring</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-monitoring-drill-down">fetch_monitoring_drill_down</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-monitoring-instance">fetch_monitoring_instance</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-monitoring-overview">fetch_monitoring_overview</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#show-observability-performance">show_observability_performance</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-api-instance-monitoring">view_api_instance_monitoring</a></p></li></ul></div></div></td></tr></tbody></table>

### Governance

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>View reports.</p></td><td><p>Governance Viewer<br><code>view:ang_governance_profiles</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#check-policy-conformance">check_policy_conformance</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-governance-service-report">fetch_governance_service_report</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-governance-services">fetch_governance_services</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-api-version-governance-report">view_api_version_governance_report</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#view-governance-report">view_governance_report</a></p></li></ul></div></div></td></tr><tr><td><p>Manage profiles and view reports.</p></td><td><p>Governance Administrator<br><code>admin:ang_governance_profiles</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#create-guardrail">create_guardrail</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#delete-governance-strategy">delete_governance_strategy</a></p></li></ul></div></div></td></tr></tbody></table>

### Runtime Manager

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>Create applications in a specific environment.</p></td><td><p>Manage Application Data<br><code>manage:application_data</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#create-omni-gateway">create_omni_gateway</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#create-scanner">create_scanner</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-omni-gateway-target-domains">get_omni_gateway_target_domains</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-omni-gateway-usage-report">get_omni_gateway_usage_report</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-omni-gateway-environments">list_omni_gateway_environments</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-omni-gateway-targets">list_omni_gateway_targets</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-scanner-providers">list_scanner_providers</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#test-scanner-connection">test_scanner_connection</a></p></li></ul></div></div></td></tr></tbody></table>

### Cost Management

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>Use the Cost Management experience.</p></td><td><div><div><ul><li><p>API Manager: Manage Policies (<code>manage:api_policies</code>)</p></li><li><p>API Manager: View APIs Configuration (<code>read:api_configuration</code>)</p></li><li><p>API Manager: View Policies (<code>read:api_policies</code>)</p></li><li><p>Anypoint Monitoring: Monitoring Viewer (<code>view:monitoring</code>)</p></li><li><p>Exchange: Exchange Viewer (<code>read:exchange</code>)</p></li><li><p>Anypoint Code Builder: Mule Developer Generative AI User (<code>create:generations</code>) (Optional)</p></li></ul></div></div></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#create-model-wallet">create_model_wallet</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#delete-model-wallet">delete_model_wallet</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#edit-model-wallet">edit_model_wallet</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-cost-instance-timeseries">fetch_cost_instance_timeseries</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-cost-instances">fetch_cost_instances</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-cost-optimization-recommendations">fetch_cost_optimization_recommendations</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-cost-overview">fetch_cost_overview</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-model-wallet-details">fetch_model_wallet_details</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#fetch-model-wallets">fetch_model_wallets</a></p></li></ul></div></div></td></tr></tbody></table>

### General

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>To…​</th><th>Required Permission</th><th>Associated Tools</th></tr></thead><tbody><tr><td><p>View organization information.</p></td><td><p>organization_read (implicit)<br><code>read:organization</code></p></td><td><div><div><ul><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#get-business-group">get_business_group</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#list-business-groups">list_business_groups</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#select-active-business-group">select_active_business_group</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#select-active-environment">select_active_environment</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#select-active-provider">select_active_provider</a></p></li><li><p><a href="https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform#select-api-version">select_api_version</a></p></li></ul></div></div></td></tr></tbody></table>

## Configure Your IDE

Configure Claude Desktop, Claude Code, ChatGPT, Cursor, Windsurf, or VS Code to work with MuleSoft
Platform MCP Server. After you add the configuration, verify it by checking that the server has
started in the MCP section of your IDE.

> [!IMPORTANT] MuleSoft remote MCP servers currently only support manual client registration through
> app creation and do not support other client registration methods such as Dynamic Client
> Registration (DCR).

### Available Client Connections

When configuring your AI tool, use the endpoint for your control plane.

Use the `/mcp` path (Streamable HTTP). If the client does not connect, fall back to `/mcp/sse`
(Server-Sent Events), which some older clients still require.

For example, on US Cloud:

- https://us1.omni.mulesoft.com/mcp

- https://us1.omni.mulesoft.com/mcp/sse

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Control Plane</p></td><td><p>URL</p></td></tr><tr><td><p>US Cloud</p></td><td><p>https://us1.omni.mulesoft.com<br>(https://omni.mulesoft.com is an alias)</p></td></tr><tr><td><p>EU Cloud</p></td><td><p>https://eu1.omni.mulesoft.com</p></td></tr><tr><td><p>Canada Cloud</p></td><td><p>https://ca1.omni.mulesoft.com</p></td></tr><tr><td><p>Japan Cloud</p></td><td><p>https://jp1.omni.mulesoft.com</p></td></tr><tr><td><p>India Cloud</p></td><td><p>https://in1.omni.mulesoft.com</p></td></tr><tr><td><p>Australia Cloud</p></td><td><p>https://au1.omni.mulesoft.com</p></td></tr></tbody></table>

For more information about Anypoint Platform regions, see
[Control Plane Hosting Options](https://docs.mulesoft.com/hosting-home/#control-plane-hosting-options).

### Claude Desktop

In Claude Desktop:

1.  Click **Customize** > **Connectors**.

2.  Click the add (+) icon, and then click **Browse Connectors**.

3.  Search for "MuleSoft" and then add the connector.

4.  Enter the Client ID and Client Secret from your connected app.

In your connected app:

1.  Log in to Anypoint Platform, and open your connected app.

2.  In the **Redirect URLs** field, enter `https://claude.ai/api/mcp/auth_callback`.

3.  To apply changes, click **Continue**.

Download [Claude Desktop](https://claude.com/download).

### Claude Code

In your terminal, run the following command, replacing `<PORT>` with a fixed port number (for
example, `32493`):

```bash
MCP_CLIENT_SECRET=<YOUR_CLIENT_SECRET> claude mcp add \
    --transport http \
    --callback-port <PORT> \
    --client-id <YOUR_CLIENT_ID> \
    --client-secret \
    mulesoft-platform https://omni.mulesoft.com/mcp
```

Using a fixed callback port ensures the redirect URL remains consistent across sessions. Without a
fixed port, Claude Code assigns a random port for each authentication request, which causes
authorization to fail because the connected app requires an exact URL match.

In your connected app:

1.  Log in to Anypoint Platform, and open your connected app.

2.  In the **Redirect URLs** field, enter `http://localhost:<PORT>/callback`, using the same port
    number you specified in the command (for example, `http://localhost:32493/callback`).

3.  To apply changes, click **Continue**.

Install [Claude Code](https://docs.anthropic.com/en/docs/claude-code/overview).

### ChatGPT

In ChatGPT:

1.  Click **Apps** > **Settings.**

2.  Click the settings icon, click **Create App**, and configure the following:

    1.  Name the connection, and enter the **Remote Universal URL**, for example,
        `https://omni.mulesoft.com/mcp`.

3.  In **OAuth** > **Advanced settings** > **Client registration**, configure the following:

    1.  Enter the Client ID and Client Secret from your connected app.

    2.  Copy the Callback URL.

In your connected app:

1.  Log in to Anypoint Platform, and open your connected app.

2.  In the redirect URLs field, enter the Callback URL value you copied.

3.  To apply changes, click **Continue**.

Download [ChatGPT](https://chatgpt.com/download/).

### Cursor

In Cursor:

1.  Click **Settings** > **Tools and MCPs** > **Add a Custom MCP Server**.

2.  Add the following code snippet, replacing `<PORT>` with a fixed port number (for example,
    `32493`):

    ```json
    {
      "mcpServers": {
        "mulesoft-platform": {
          "command": "npx",
          "args": [
            "-y",
            "mcp-remote@latest",
            "https://omni.mulesoft.com/mcp",
            "<PORT>",
            "--static-oauth-client-info",
            "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}"
          ]
        }
      }
    }
    ```

Using a fixed port ensures the redirect URL remains consistent across sessions. Without a fixed
port, Cursor assigns a random port for each authentication request, which causes authorization to
fail because the connected app requires an exact URL match.

In your connected app:

1.  Log in to Anypoint Platform, and open your connected app.

2.  In the **Redirect URLs** field, enter `http://localhost:<PORT>/oauth/callback`, using the same
    port number you specified in the configuration (for example,
    `http://localhost:32493/oauth/callback`).

3.  To apply changes, click **Continue**.

Download [Cursor](https://cursor.com/).

### Windsurf

In Windsurf:

1.  Click **Settings** > **Cascade** > **Open MCP Registry**.

2.  Click the settings icon and in `~/.codeium/windsurf/mcp_config.json` add the following code
    snippet, replacing `<PORT>` with a fixed port number (for example, `32493`):

    ```json
    {
      "mcpServers": {
        "mulesoft-platform": {
          "command": "npx",
          "args": [
            "-y",
            "mcp-remote@latest",
            "https://omni.mulesoft.com/mcp",
            "<PORT>",
            "--static-oauth-client-info",
            "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}"
          ]
        }
      }
    }
    ```

Using a fixed port ensures the redirect URL remains consistent across sessions. Without a fixed
port, Windsurf assigns a random port for each authentication request, which causes authorization to
fail because the connected app requires an exact URL match.

In your connected app:

1.  Log in to Anypoint Platform, and open your connected app.

2.  In the **Redirect URLs** field, enter `http://localhost:<PORT>/oauth/callback`, using the same
    port number you specified in the configuration (for example,
    `http://localhost:32493/oauth/callback`).

3.  To apply changes, click **Continue**.

Download [Windsurf](https://windsurf.com/).

### VS Code

In VS Code:

1.  In your user profile, configure a custom MCP server in the `mcp.json` file. Alternatively, run
    `MCP: Add Server` in the Command Palette (Shift+Cmd+P) to add a server through a guided flow.
    Replace `<PORT>` with a fixed port number (for example, `32493`):

    ```json
    {
      "servers": {
        "mulesoft-platform": {
          "type": "stdio",
          "command": "npx",
          "args": [
            "-y",
            "mcp-remote@latest",
            "https://omni.mulesoft.com/mcp",
            "<PORT>",
            "--static-oauth-client-info",
            "{\"client_id\":\"YOUR_CLIENT_ID\",\"client_secret\":\"YOUR_CLIENT_SECRET\"}"
          ]
        }
      }
    }
    ```

Using a fixed port ensures the redirect URL remains consistent across sessions. Without a fixed
port, VS Code assigns a random port for each authentication request, which causes authorization to
fail because the connected app requires an exact URL match.

In your connected app:

1.  Log in to Anypoint Platform, and open your connected app.

2.  In the **Redirect URLs** field, enter `http://localhost:<PORT>/oauth/callback`, using the same
    port number you specified in the configuration (for example,
    `http://localhost:32493/oauth/callback`).

3.  To apply changes, click **Continue**.

4.  To run the server, click **Start**.

5.  When prompted, enter the Client ID and Client Secret from your connected app.

Download [VS Code](https://code.visualstudio.com/).

## Troubleshooting

Resolve authentication and connection issues with these troubleshooting steps.

### Authentication Failure

To resolve authentication issues, follow these troubleshooting steps.

- Try logging out of your Anypoint Platform account and logging back in.

- If you encounter an authorization error:

  - Add the correct redirect URL to your connected app.

  - Add the necessary permissions scopes to your connected app.

- If you encounter a permissions-related error when attempting to authorize, add these permission
  scopes to your connected app:

  - Full Access (`full`)

  - Background Access (`offline_access`)

- If authorization fails due to a redirect URL mismatch:

  - IDE-based clients (Claude Code, Cursor, Windsurf, VS Code) use a localhost callback URL with a
    port number. If the port changes between sessions, the redirect URL no longer matches the one
    registered in your connected app. To prevent this, configure a fixed callback port as described
    in [Configure Your IDE](#configure-your-ide). Then add the matching localhost URL to your
    connected app’s redirect URLs (for example, `http://localhost:32493/oauth/callback`).

### Connection Issues

If your MCP client can’t reach the server or fails to establish a session, verify these settings.

- Ensure your MCP client supports Streamable HTTP transport.

- Check that your client can handle OAuth authentication flows.

- Verify the MCP server URL is [https://omni.mulesoft.com/mcp](https://omni.mulesoft.com/mcp).

## See Also

- [Using MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/using-mulesoft-platform-mcp-server)

<!-- document id=60d76c67361d0b5a7e4149b6d0d17e35521c3a6100af0f32e11609439cc9803d url=/mulesoft/current/en-us/mulesoft-mcp-server/reference-mcp-tools.md -->

---
product: MuleSoft MCP Servers
---

# MuleSoft DX MCP Server Tool Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft DX MCP Server exposes tools for developing agent networks, building applications, creating
connectors, managing deployments, governing APIs, and more. Each tool accepts specific parameters so
assistants can automate tasks across Anypoint Platform APIs. Run them from your IDE to speed up
delivery, tighten governance, and surface operational insight for your integrations.

> [!NOTE] Some MuleSoft DX MCP Server tools are available only in the Anypoint Code Builder IDE or
> Connector Builder.

See [Create a Connected App](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started#create-a-connected-app) for information about which
tools require specific permission scopes.

## Command Summary

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Category</th><th>Tool</th><th>Anypoint Code Builder Only</th><th>Connector Builder Only</th><th>Required Permission Scopes</th></tr></thead><tbody><tr><td rowspan="4"><p><strong>Agent Network Development</strong></p></td><td><p><a href="#configure-agent-network-yaml">configure_agent_network_yaml</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#create-agent-network-project">create_agent_network_project</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#deploy-agent-network">deploy_agent_network</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#publish-agent-network-assets">publish_agent_network_assets</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td rowspan="16"><p><strong>Application Development</strong></p></td><td><p><a href="#create-and-manage-assets">create_and_manage_assets</a></p></td><td><p>No</p></td><td><p>No</p></td><td><div><div><ul><li><p>Exchange: Exchange Administrator (<code>manage:exchange</code>)</p></li><li><p>Exchange: Exchange Contributor (<code>edit:exchange</code>)</p></li><li><p>Exchange: Exchange Creator (<code>create:exchange</code>)</p></li></ul></div></div></td></tr><tr><td><p><a href="#create-and-manage-metadata">create_and_manage_metadata</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#create-api-spec-project">create_api_spec_project</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#create-mcp-server">create_MCP_server</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>Anypoint Code Builder: Mule Developer Generative AI User (<code>create:generations</code>)</p></td></tr><tr><td><p><a href="#create-mule-project">create_mule_project</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#generate-api-spec">generate_api_spec</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>Anypoint Code Builder: Mule Developer Generative AI User (<code>create:generations</code>)</p></td></tr><tr><td><p><a href="#generate-mule-flow">generate_mule_flow</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>Anypoint Code Builder: Mule Developer Generative AI User (<code>create:generations</code>)</p></td></tr><tr><td><p><a href="#generate-or-modify-munit-test">generate_or_modify_munit_test</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>Anypoint Code Builder: Mule Developer Generative AI User (<code>create:generations</code>)</p></td></tr><tr><td><p><a href="#get-topics-agent-actions-metadata-instructions">get_topics_agent_actions_metadata_instructions</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#implement-api-spec">implement_api_spec</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>Exchange: Exchange Viewer (<code>read:exchange</code>)</p></td></tr><tr><td><p><a href="#mock-api-spec">mock_api_spec</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#open-project">open_project</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#run-local-mule-application">run_local_mule_application</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#search-asset">search_asset</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>Exchange: Exchange Viewer (<code>read:exchange</code>)</p></td></tr><tr><td><p><a href="#test-connection">test_connection</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#validate-project">validate_project</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td rowspan="9"><p><strong>Connector Development</strong></p></td><td><p><a href="#uc-add-pagination">uc_add_pagination</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-connector-lifecycle">uc_connector_lifecycle</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-create-connector-workflow">uc_create_connector_workflow</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-generate-connector">uc_generate_connector</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-generate-tests">uc_generate_tests</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-get-test-generation-info">uc_get_test_generation_info</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-list-connection-profiles">uc_list_connection_profiles</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-manage-api-spec">uc_manage_api_spec</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td><p><a href="#uc-manage-operations">uc_manage_operations</a></p></td><td><p>No</p></td><td><p>Yes</p></td><td><p>None</p></td></tr><tr><td rowspan="7"><p><strong>DataWeave Development</strong></p></td><td><p><a href="#dataweave-create-documentation">dataweave_create_documentation</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#dataweave-create-project">dataweave_create_project</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#dataweave-create-sample-data">dataweave_create_sample_data</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#dataweave-get-module-metadata">dataweave_get_module_metadata</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#dataweave-get-project-metadata">dataweave_get_project_metadata</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#dataweave-open-project">dataweave_open_project</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#dataweave-run-script-tool">dataweave_run_script_tool</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td rowspan="5"><p><strong>Application Management</strong></p></td><td><p><a href="#create-and-manage-api-instances">create_and_manage_api_instances</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>API Manager: Manage API Configuration (<code>manage:api_configuration</code>)</p></td></tr><tr><td><p><a href="#deploy-mule-application">deploy_mule_application</a></p></td><td><p>No</p></td><td><p>No</p></td><td><div><div><ul><li><p>Exchange: Exchange Viewer (<code>read:exchange</code>)</p></li><li><p>Runtime Manager: View Connected Applications (<code>read:orgconnapps</code>)</p></li><li><p>Runtime Manager: Create Applications (<code>create:applications</code>)</p></li><li><p>Runtime Manager: Read Runtime Fabrics (<code>read:runtime_fabrics</code>)</p></li></ul></div></div></td></tr><tr><td><p><a href="#list-api-instances">list_api_instances</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>API Manager: View APIs Configuration (<code>read:api_configuration</code>)</p></td></tr><tr><td><p><a href="#list-applications">list_applications</a></p></td><td><p>No</p></td><td><p>No</p></td><td><div><div><ul><li><p>Runtime Manager: Monitoring Viewer (<code>view:monitoring</code>)</p></li><li><p>Runtime Manager: View Connected Applications (<code>read:orgconnapps</code>)</p></li><li><p>Runtime Manager: Read Applications (<code>read:applications</code>)</p></li><li><p>Runtime Manager: Read Runtime Fabrics (<code>read:runtime_fabrics</code>)</p></li></ul></div></div></td></tr><tr><td><p><a href="#update-mule-application">update_mule_application</a></p></td><td><p>No</p></td><td><p>No</p></td><td><div><div><ul><li><p>General: View Organization (<code>read:organization</code>)</p></li><li><p>Runtime Manager: View Connected Applications (<code>read:orgconnapps</code>)</p></li><li><p>Runtime Manager: Create Applications (<code>create:applications</code>)</p></li></ul></div></div></td></tr><tr><td rowspan="3"><p><strong>Governance</strong></p></td><td><p><a href="#add-governance-ruleset">add_governance_ruleset</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#list-governance-rulesets">list_governance_rulesets</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#validate-api-against-ruleset">validate_api_against_ruleset</a></p></td><td><p>Yes</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td rowspan="3"><p><strong>Policy Management</strong></p></td><td><p><a href="#get-flex-gateway-policy-example">get_flex_gateway_policy_example</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td><p><a href="#manage-api-instance-policy">manage_api_instance_policy</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>API Manager: Manage Policies (<code>manage:api_policies</code>)</p></td></tr><tr><td><p><a href="#manage-flex-gateway-policy-project">manage_flex_gateway_policy_project</a></p></td><td><p>No</p></td><td><p>No</p></td><td><p>None</p></td></tr><tr><td rowspan="2"><p><strong>Usage and Insights</strong></p></td><td><p><a href="#get-platform-insights">get_platform_insights</a></p></td><td><p>No</p></td><td><p>No</p></td><td><div><div><ul><li><p>Runtime Manager: Monitoring Viewer (<code>view:monitoring</code>)</p></li><li><p>Runtime Manager: Read Runtime Fabrics (<code>read:runtime_fabrics</code>)</p></li><li><p>Runtime Manager: CloudHub Network Viewer (<code>read:cloudhub_networking</code>)</p></li><li><p>General: Usage Viewer (<code>view:metering</code>)</p></li><li><p>General: View Organization (<code>read:organization</code>)</p></li><li><p>API Manager: View APIs Configuration (<code>read:api_configuration</code>)</p></li></ul></div></div></td></tr><tr><td><p><a href="#get-reuse-metrics">get_reuse_metrics</a></p></td><td><p>No</p></td><td><p>No</p></td><td><div><div><ul><li><p>Runtime Manager: Monitoring Viewer (<code>view:monitoring</code>)</p></li><li><p>Runtime Manager: View Connected Applications (<code>read:orgconnapps</code>)</p></li><li><p>Runtime Manager: Read Runtime Fabrics (<code>read:runtime_fabrics</code>)</p></li><li><p>Runtime Manager: CloudHub Network Viewer (<code>read:cloudhub_networking</code>)</p></li><li><p>API Manager: View APIs Configuration (<code>read:api_configuration</code>)</p></li><li><p>General: Usage Viewer (<code>view:metering</code>)</p></li></ul></div></div></td></tr></tbody></table>

## add\_governance\_ruleset

Add a governance ruleset from Anypoint Exchange to your project. Use the `search_asset` tool to find
a ruleset that matches an assetId, groupId, and version from user-provided criteria. The
`search_asset` tool uses `searchQuery='user'` criteria and `assetFilters=ruleset` to return a
ruleset meeting those criteria. Then, this tool adds the ruleset as a dependency to your project.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>assetId</code></p></td><td><p>The ID of the asset.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>groupId</code></p></td><td><p>Group ID of the asset in Anypoint Exchange.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>version</code></p></td><td><p>Version of the asset, for example, <code>1.4.0</code>.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "add_governance_ruleset",
  "arguments": {
    "assetId": "api-governance-ruleset",
    "groupId": "com.mulesoft.governance",
    "version": "1.4.0"
  }
}
```

Example response

```json
{
  "success": true,
  "assetId": "api-governance-ruleset",
  "groupId": "com.mulesoft.governance",
  "version": "1.4.0",
  "dependencyAdded": true,
  "projectPath": "/Users/developer/projects/pet-store-api",
  "message": "Governance ruleset added successfully to project"
}
```

## configure\_agent\_network\_yaml

Modifies an agent network project YAML file. The tool can replace placeholder YAML created from a
template with values generated from user prompts and guided setup (`mode='configure'`). Or, the tool
can make minor changes to a preconfigured agent network YAML file (`mode='edit'`). The LLM
determines the appropriate mode value from user prompts and guided setup.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>mode</code></p></td><td><p>The operation to perform on the agent network project YAML. Valid values are <code>configure</code> and <code>edit</code>.</p><p>For example, use <code>configure</code> to set up a custom agent network tailored to your environment, discover agent network components, or scaffold a new agent network. Use <code>edit</code> to make minor changes to a configured agent network YAML file, such as renaming an existing agent.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>prompt</code></p></td><td><p>Prompt from the user containing instructions to the agent.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request (configure mode)

```json
{
  "name": "configure_agent_network_yaml",
  "arguments": {
    "prompt": "configure this agent network with a new agent called 'api-manager'",
    "mode": "configure"
  }
}
```

Example request (edit mode)

```json
{
  "name": "configure_agent_network_yaml",
  "arguments": {
    "prompt": "remove the connection between agent1 and agent2",
    "mode": "edit"
  }
}
```

Example response

```json
{
  "instructions": [
    "1. Open the agent-network.yaml file in your project",
    "2. Locate the 'agents' section",
    "3. Add the following agent configuration:",
    "   - name: api-manager",
    "     type: llm",
    "     provider: openai",
    "     model: gpt-4",
    "4. Save the file",
    "5. Validate the YAML syntax"
  ],
  "mode": "configure",
  "yamlSnippet": {
    "agents": [
      {
        "name": "api-manager",
        "type": "llm",
        "provider": "openai",
        "model": "gpt-4"
      }
    ]
  }
}
```

## create\_agent\_network\_project

Create and scaffold an agent network project with a name and location you specify.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectName</code></p></td><td><p>Unique name of the project, also used as the name of the agent network project file.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectPath</code></p></td><td><p>Parent location of the project. The default is the parent folder of the current workspace. The project resides in a subfolder of <code>projectPath</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectDescription</code></p></td><td><p>Description of the project.</p></td><td><p>No</p></td></tr><tr><td><p><code>groupId</code></p></td><td><p>Organization or business group ID of the project.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "create_agent_network_project",
  "arguments": {
    "projectName": "my-agent-network",
    "projectPath": "/Users/developer/projects",
    "projectDescription": "A sample agent network for API management"
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "/Users/developer/projects/my-agent-network",
  "filesCreated": ["agent-network.yaml", "exchange.json", "README.md"],
  "message": "Agent network project created successfully"
}
```

## create\_and\_manage\_api\_instances

Create and configure API instances in Anypoint API Manager.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>organizationId</code></p></td><td><div><div><p>The ID of the organization where the instance resides. The default is the ID of the user’s organization from the current session.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>environmentName</code></p></td><td><div><div><p>The name of the environment where the instance resides. The default is the environment for the organization specified in <code>organizationId</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>apiInstanceId</code></p></td><td><div><div><p>Instance ID of the API.</p></div></div></td><td><p>No</p><p>Required if you’re configuring an API instance.</p></td></tr><tr><td><p><code>apiInstanceLabel</code></p></td><td><div><div><p>Label or name of the API instance.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>operation</code></p></td><td><div><div><p>Operation to perform on the API instance. Valid values are:</p></div><div><ul><li><p><code>create</code> to create an API instance.</p></li><li><p><code>configureBasicEndpointInMuleApplication</code> to configure a basic endpoint in a Mule application.</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>groupId</code></p></td><td><div><div><p>Group ID of the API asset in Anypoint Exchange.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>assetId</code></p></td><td><div><div><p>ID of the API asset in Anypoint Exchange. Value can be the API name.</p></div></div></td><td><p>No</p><p>Required to create an API instance.</p></td></tr><tr><td><p><code>assetVersion</code></p></td><td><div><div><p>Version of the API asset in Anypoint Exchange.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>runtimeEngine</code></p></td><td><div><div><p>Engine the API instance runs on. Valid value is <code>mule4</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>muleProxyType</code></p></td><td><div><div><p>Valid value is <code>basicEndpoint</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>endpointUri</code></p></td><td><div><div><p>Endpoint URI of the API instance (upstream).</p></div></div></td><td><p>No</p><p>Required if <code>muleProxyType=basicEndpoint</code>.</p></td></tr><tr><td><p><code>consumerEndpoint</code></p></td><td><div><div><p>Consumer endpoint of the API instance.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>providerId</code></p></td><td><div><div><p>Provider ID of the API instance.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request (create API instance)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_and_manage_api_instances",
  "arguments": {
    "operation": "create",
    "assetId": "customer-api",
    "assetVersion": "1.0.0",
    "apiInstanceLabel": "Customer Management API",
    "runtimeEngine": "mule4",
    "muleProxyType": "basicEndpoint",
    "endpointUri": "https://backend.example.com/api/customers",
    "consumerEndpoint": "https://api.example.com/customers"
  }
}
```

Example response

```json
{
  "success": true,
  "apiInstanceId": "12345",
  "apiInstanceLabel": "Customer Management API",
  "assetId": "customer-api",
  "assetVersion": "1.0.0",
  "endpointUri": "https://backend.example.com/api/customers",
  "consumerEndpoint": "https://api.example.com/customers",
  "status": "active",
  "message": "API instance created successfully"
}
```

## create\_and\_manage\_assets

Create, update, and delete assets in Anypoint Exchange.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>operation</code></p></td><td><div><div><p>Operation to perform on the asset. Valid values are:</p></div><div><ul><li><p><code>create</code> to create an asset.</p></li><li><p><code>update</code> to modify an existing asset.</p></li><li><p><code>delete</code> to remove an asset.</p></li></ul></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><p><code>groupId</code></p></td><td><div><div><p>Group ID of the asset in Anypoint Exchange.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>assetId</code></p></td><td><div><div><p>The ID of the asset.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>version</code></p></td><td><div><div><p>Version of the asset, for example, <code>1.4.0</code>.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required for asset creation.</p></div></div></td></tr><tr><td><p><code>organizationId</code></p></td><td><div><div><p>The ID of the org to publish the asset to.</p></div></div></td><td><div><div><p>No</p></div><div><p>Optional for asset creation.</p></div></div></td></tr><tr><td><p><code>classifier</code></p></td><td><div><div><p>The type of asset. Valid values are:</p></div><div><ul><li><p><code>raml-fragment</code></p></li><li><p><code>raml</code></p></li><li><p><code>oas</code></p></li><li><p><code>wsdl</code></p></li><li><p><code>http-api</code></p></li><li><p><code>custom</code></p></li><li><p><code>evented-api</code></p></li><li><p><code>graphql</code></p></li><li><p><code>mule-application</code></p></li><li><p><code>mule-plugin</code></p></li></ul></div></div></td><td><div><div><p>No</p></div><div><p>Required for asset creation.</p></div></div></td></tr><tr><td><p><code>name</code></p></td><td><div><div><p>The name of the asset.</p></div></div></td><td><div><div><p>No</p></div><div><ul><li><p>Required for asset creation.</p></li><li><p>Optional for asset update.</p></li></ul></div></div></td></tr><tr><td><p><code>description</code></p></td><td><div><div><p>The description of the asset to create or update.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>assetLink</code></p></td><td><div><div><p>The URL of the asset.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when creating wsdl or http assets.</p></div></div></td></tr><tr><td><p><code>apiVersion</code></p></td><td><div><div><p>The product version of API assets.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when creating raml, oas, wsdl, or http assets.</p></div></div></td></tr><tr><td><p><code>main</code></p></td><td><div><div><p>The main file of the asset.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when creating raml, raml-fragment, oas, and wsdl assets.</p></div></div></td></tr><tr><td><p><code>dependencies</code></p></td><td><div><div><p>A stringified array of dependency JSON objects, where each object consists of <code>groupId</code>, <code>assetId</code>, and <code>version</code>.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when creating api-group assets.</p></div></div></td></tr><tr><td><p><code>originalFormatVersion</code></p></td><td><div><div><p>The version of the API spec format.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required for asset creation.</p></div></div></td></tr><tr><td><p><code>metadata</code></p></td><td><div><div><p>Stringified value of a Design Center JSON object describing the asset <code>projectId</code>, <code>branchId</code>, and <code>commitId</code>. Used for asset creation.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>keywords</code></p></td><td><div><div><p>Stringified array of string values to save as the asset’s attributes. Use to find assets by keyword. Used for asset creation.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>tags</code></p></td><td><div><div><p>Stringified array of string values to save as the asset’s tags. Used for asset creation.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>projectPath</code></p></td><td><div><div><p>The asset project file or project root directory.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required for raml, raml-fragment, oas, evented-api, wsdl, mule-plugin, and mule-application asset creation.</p></div></div></td></tr><tr><td><p><code>deleteType</code></p></td><td><div><div><p>Type of asset deletion to perform. Valid values are:</p></div><div><ul><li><p><code>soft-delete</code> indicates logical deletion.</p></li><li><p><code>hard-delete</code> indicates physical deletion.</p></li></ul></div><div><p>The default value is <code>soft-delete</code>.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>contactName</code></p></td><td><div><div><p>New contact name for the asset. Used for updating the asset.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>contactEmail</code></p></td><td><div><div><p>New contact email of the asset. Used for updating the asset.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>iconFile</code></p></td><td><div><div><p>Path to the icon file (image formats such as PNG and JPG) to add to the asset. Used for updating the asset.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>assetPropertiesFilePath</code></p></td><td><div><div><p>Path to the asset properties file. File name should be <code>pom.xml</code> or have a <code>.pom</code> extension.</p></div></div></td><td><div><div><p>No</p></div><div><p>Optional for asset creation.</p></div></div></td></tr></tbody></table>

Example request (create asset)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_and_manage_assets",
  "arguments": {
    "operation": "create",
    "groupId": "com.mycompany.apis",
    "assetId": "customer-management-api",
    "version": "1.0.0",
    "classifier": "raml",
    "name": "Customer Management API",
    "description": "RESTful API for managing customer data and operations",
    "apiVersion": "v1",
    "main": "customer-api.raml",
    "originalFormatVersion": "1.0",
    "projectPath": "/Users/developer/customer-api-project",
    "keywords": "[\"customer\", \"management\", \"rest\", \"api\"]",
    "tags": "[\"v1\", \"production-ready\"]"
  }
}
```

Example request (update asset)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_and_manage_assets",
  "arguments": {
    "operation": "update",
    "groupId": "com.mycompany.apis",
    "assetId": "customer-management-api",
    "description": "Updated RESTful API for managing customer data with enhanced features",
    "contactName": "API Team",
    "contactEmail": "api-team@mycompany.com"
  }
}
```

Example response (create)

```json
{
  "success": true,
  "operation": "create",
  "groupId": "com.mycompany.apis",
  "assetId": "customer-management-api",
  "version": "1.0.0",
  "classifier": "raml",
  "name": "Customer Management API",
  "exchangeUrl": "https://anypoint.mulesoft.com/exchange/com.mycompany.apis/customer-management-api/1.0.0/",
  "status": "published",
  "message": "Asset created successfully in Anypoint Exchange"
}
```

Example response (update)

```json
{
  "success": true,
  "operation": "update",
  "groupId": "com.mycompany.apis",
  "assetId": "customer-management-api",
  "updatedFields": ["description", "contactName", "contactEmail"],
  "message": "Asset updated successfully in Anypoint Exchange"
}
```

## create\_and\_manage\_metadata

Define metadata for a flow component, attach metadata to Mule flow components, and update existing
metadata. To define metadata, provide the Mule configuration file URI and sample data or schema. To
apply metadata, specify existing metadata types. To update metadata, provide new schema or sample
data.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><div><div><p>Path of the Mule project directory where the <code>pom.xml</code> file is located.</p></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><p><code>operation</code></p></td><td><div><div><p>Task to perform. Valid values are:</p></div><div><ul><li><p><code>define</code> to create metadata.</p></li><li><p><code>attach</code> to apply metadata to flow components.</p></li><li><p><code>update</code> to update existing metadata.</p></li></ul></div></div></td><td><div><div><p>Yes</p></div></div></td></tr><tr><td><p><code>metadata</code></p></td><td><div><div><p>String value of sample data or schema JSON object. JSON original format is required (no conversion from other formats). If this metadata is for input or output, use the <code>applyMetadataOn</code> parameter.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when the operation parameter value is <code>define</code>.</p></div></div></td></tr><tr><td><p><code>dataFormat</code></p></td><td><div><div><p>The format of the metadata to process. Specify <code>JSON</code> for JSON-formatted metadata or <code>XML</code> for XML-formatted metadata.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>metadataPath</code></p></td><td><div><div><p>Path of the sample metadata or schema file. To specify if this metadata is for input or output, use the <code>applyMetadataOn</code> parameter.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when the operation parameter value is <code>define</code>.</p></div></div></td></tr><tr><td><p><code>componentNodeDocId</code></p></td><td><div><div><p>The <code>doc:id attribute</code> value of the flow component. For example, if the node is <code>&lt;ee:transform doc:name='Transform' doc:id='hdipfo' &gt;</code>, specify <code>hdipfo</code> as the <code>componentNodeDocId</code>.</p></div></div></td><td><div><div><p>No</p></div><div><ul><li><p>Required when the operation is <code>apply</code>.</p></li><li><p>Optional when the operation is <code>define</code>.</p></li></ul></div></div></td></tr><tr><td><p><code>metadataName</code></p></td><td><div><div><p>Name of the new metadata to define based on a sample data JSON, for example, <code>customer</code> if sample data is for a customer.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when the operation parameter value is <code>define</code>.</p></div></div></td></tr><tr><td><p><code>isSchema</code></p></td><td><div><div><p>Whether the metadata is a schema.</p></div></div></td><td><div><div><p>Yes</p></div><div><p>Required when the operation parameter value is <code>define</code>.</p></div></div></td></tr><tr><td><p><code>applyMetadataOn</code></p></td><td><div><div><p>Specifies whether the metadata is for the component’s input or output. If not specified, metadata is used for input.</p></div></div></td><td><div><div><p>No</p></div><div><ul><li><p>Required when the operation is <code>apply</code>.</p></li><li><p>Optional when the operation is <code>define</code>.</p></li></ul></div></div></td></tr><tr><td><p><code>existingMetadata</code></p></td><td><div><div><p>Name of existing metadata type to apply to the flow component node. To specify if this metadata is for input or output, use the <code>applyMetadataOn</code> parameter.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when the operation parameter value is <code>apply</code>.</p></div></div></td></tr><tr><td><p><code>listExistingMetadata</code></p></td><td><div><div><p>Whether to list all available metadata types in the project. Use this parameter to discover existing metadata.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr><tr><td><p><code>updateMetadata</code></p></td><td><div><div><p>Name of existing metadata type to update.</p></div></div></td><td><div><div><p>No</p></div><div><p>Required when the operation parameter value is <code>update</code>.</p></div></div></td></tr><tr><td><p><code>toolSummary</code></p></td><td><div><div><p>Description of the tool.</p></div></div></td><td><div><div><p>No</p></div></div></td></tr></tbody></table>

Example request (define metadata)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_and_manage_metadata",
  "arguments": {
    "projectPath": "/Users/developer/customer-api-project",
    "operation": "define",
    "metadataName": "CustomerData",
    "metadata": "{\"customerId\": \"CUST-001\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@example.com\", \"phone\": \"+1-555-123-4567\"}",
    "dataFormat": "JSON",
    "isSchema": false
  }
}
```

Example request (apply metadata)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_and_manage_metadata",
  "arguments": {
    "projectPath": "/Users/developer/customer-api-project",
    "operation": "apply",
    "componentNodeDocId": "transform-customer-data",
    "existingMetadata": "CustomerData",
    "applyMetadataOn": "input",
    "isSchema": false
  }
}
```

Example response (define)

```json
{
  "success": true,
  "operation": "define",
  "metadataName": "CustomerData",
  "dataFormat": "JSON",
  "metadataPath": "/Users/developer/customer-api-project/src/main/resources/metadata/CustomerData.json",
  "message": "Metadata 'CustomerData' defined successfully"
}
```

## list\_applications

Get information about all applications in the environment you specify, sorted by last update date
and time, in descending order. You can also specify an optional deployment name.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>environmentName</code></p></td><td><p>Name of the environment to list applications from.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>appName</code></p></td><td><p>An application to search for.</p></td><td><p>No</p></td></tr><tr><td><p><code>organizationId</code></p></td><td><p>ID of the organization to list applications from.</p></td><td><p>No</p></td></tr><tr><td><p><code>page</code></p></td><td><p>The page number of the result.</p></td><td><p>No</p></td></tr><tr><td><p><code>includeCpuMetrics</code></p></td><td><p>Set value to <code>true</code> to include CPU metrics when searching for an application.</p></td><td><p>No</p></td></tr><tr><td><p><code>includeHeapMetrics</code></p></td><td><p>Set value to <code>true</code> to include used and total heap metrics when searching for an application.</p></td><td><p>No</p></td></tr><tr><td><p><code>timeFrame</code></p></td><td><p>If <code>includeCpuMetrics</code> or <code>includeHeapMetrics</code> is true, this parameter contains the time frame for metrics.</p><p>Valid values are <code>5m</code>, <code>15m</code>, <code>30m</code>, <code>1h</code>, <code>3h</code>, <code>6h</code>, <code>12h</code>, <code>24h</code>, <code>3d</code>, <code>5d</code>, <code>7d</code>, <code>15d</code>, and <code>30d</code>.</p><p>The default value is <code>30m</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (basic application list)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "list_applications",
  "arguments": {
    "environmentName": "Production",
    "page": 1
  }
}
```

Example request (with metrics)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "list_applications",
  "arguments": {
    "environmentName": "Production",
    "appName": "customer-integration-app",
    "includeCpuMetrics": true,
    "includeHeapMetrics": true,
    "timeFrame": "1h"
  }
}
```

Example response

```json
{
  "success": true,
  "environmentName": "Production",
  "page": 1,
  "totalApplications": 15,
  "applications": [
    {
      "applicationId": "app-12345",
      "applicationName": "customer-integration-app",
      "status": "RUNNING",
      "runtimeVersion": "4.9.4:2e-java17",
      "lastUpdated": "2024-01-15T14:30:00Z",
      "replicas": 2,
      "vcoresUsed": 1.0,
      "memoryUsed": "1GB",
      "cpuMetrics": {
        "averageCpuUsage": 45.2,
        "maxCpuUsage": 78.5,
        "timeFrame": "1h"
      },
      "heapMetrics": {
        "usedHeapMB": 512,
        "totalHeapMB": 1024,
        "timeFrame": "1h"
      }
    },
    {
      "applicationId": "app-67890",
      "applicationName": "order-processing-app",
      "status": "RUNNING",
      "runtimeVersion": "4.9.4:2e-java17",
      "lastUpdated": "2024-01-14T09:15:00Z",
      "replicas": 1,
      "vcoresUsed": 0.5,
      "memoryUsed": "512MB"
    }
  ]
}
```

## list\_governance\_rulesets

List governance rulesets that apply to a project along with the rules that form each ruleset.
Includes rulesets added as project dependencies and centralized governance rulesets.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to the project folder. The default is the current workspace. For absolute paths, use <code>file:</code> followed by three slash characters.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_governance_rulesets",
  "arguments": {
    "projectPath": "/Users/developer/projects/pet-store-api"
  }
}
```

Example response

```json
{
  "rulesets": [
    {
      "name": "API Governance Ruleset",
      "assetId": "api-governance-ruleset",
      "groupId": "com.mulesoft.governance",
      "version": "1.4.0",
      "type": "dependency",
      "rules": [
        {
          "name": "api-title-required",
          "description": "API title is required",
          "absolutePath": "/Users/developer/.mule/rulesets/api-governance-ruleset/rules/api-title-required.js",
          "severity": "error"
        },
        {
          "name": "api-version-required",
          "description": "API version is required",
          "absolutePath": "/Users/developer/.mule/rulesets/api-governance-ruleset/rules/api-version-required.js",
          "severity": "error"
        }
      ]
    },
    {
      "name": "Centralized Security Ruleset",
      "type": "centralized",
      "rules": [
        {
          "name": "https-required",
          "description": "HTTPS is required for all endpoints",
          "absolutePath": "/Users/developer/.mule/rulesets/centralized/security/https-required.js",
          "severity": "warning"
        }
      ]
    }
  ]
}
```

## manage\_api\_instance\_policy

Apply a new policy to an API instance and update an existing policy configuration.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>organizationId</code></p></td><td><p>The ID of the organization where instances reside. Default is the ID of the user’s organization from the current session.</p></td><td><p>No</p></td></tr><tr><td><p><code>environmentName</code></p></td><td><p>The name of the environment where instances reside. Default is the environment for the organization specified in <code>organizationId</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>apiInstanceId</code></p></td><td><p>ID of the API instance.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>operation</code></p></td><td><p>Operation to perform on the API instance policy. Use <code>apply</code> to apply a new policy or <code>update</code> to update an existing policy configuration.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>policyId</code></p></td><td><p>ID of the policy to configure.</p></td><td><p>No</p><p>Required to update an existing policy configuration.</p></td></tr><tr><td><p><code>policyConfiguration</code></p></td><td><p>Configuration object for the policy.</p></td><td><p>No</p><p>Required to apply a new policy.</p></td></tr><tr><td><p><code>groupId</code></p></td><td><p>Group ID of the policy asset in Anypoint Exchange.</p></td><td><p>No</p><p>Required to apply a new policy.</p></td></tr><tr><td><p><code>assetId</code></p></td><td><p>Asset ID of the policy asset in Anypoint Exchange.</p></td><td><p>No</p><p>Required to apply a new policy.</p></td></tr><tr><td><p><code>assetVersion</code></p></td><td><p>Version of the policy asset in Anypoint Exchange.</p></td><td><p>No</p><p>Required to apply a new policy.</p></td></tr></tbody></table>

Example request (apply new policy)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "manage_api_instance_policy",
  "arguments": {
    "apiInstanceId": "12345",
    "operation": "apply",
    "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
    "assetId": "rate-limiting-sla-based",
    "assetVersion": "1.2.0",
    "policyConfiguration": "{\"rateLimits\": [{\"maximumRequests\": 100, \"timePeriodInMilliseconds\": 60000}], \"clusterizable\": true}"
  }
}
```

Example request (update existing policy)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "manage_api_instance_policy",
  "arguments": {
    "apiInstanceId": "12345",
    "operation": "update",
    "policyId": "policy-67890",
    "policyConfiguration": "{\"rateLimits\": [{\"maximumRequests\": 200, \"timePeriodInMilliseconds\": 60000}], \"clusterizable\": true}"
  }
}
```

Example response

```json
{
  "success": true,
  "operation": "apply",
  "apiInstanceId": "12345",
  "policyId": "policy-new-123",
  "policyName": "Rate Limiting - SLA Based",
  "assetId": "rate-limiting-sla-based",
  "version": "1.2.0",
  "status": "applied",
  "configuration": {
    "rateLimits": [
      {
        "maximumRequests": 100,
        "timePeriodInMilliseconds": 60000
      }
    ],
    "clusterizable": true
  },
  "message": "Policy applied successfully to API instance"
}
```

## manage\_flex\_gateway\_policy\_project

Provide instructions to the LLM on how to manage an Omni Gateway custom policy project. Instructions
include how to create the project, set up the configuration, build the project, publish a
development version of the project, and publish a release version of the project.

Prerequisites: See [Prerequisites](https://docs.mulesoft.com/pdk/latest/policies-pdk-prerequisites).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>operation</code></p></td><td><p>Operation to perform on the Omni Gateway policy project. Use <code>create</code> to create a project, <code>configure</code> to set up project configuration, <code>build</code> to compile the project, <code>publish-dev</code> to publish to development environment, or <code>publish-release</code> to publish a release version.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectPath</code></p></td><td><p>Path to the Omni Gateway policy project directory.</p></td><td><p>No</p></td></tr><tr><td><p><code>policyName</code></p></td><td><p>Name of the policy project.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "manage_flex_gateway_policy_project",
  "arguments": {
    "operation": "create",
    "projectPath": "/Users/developer/flex-policies",
    "policyName": "custom-auth-policy"
  }
}
```

Example response

```json
{
  "success": true,
  "operation": "create",
  "instructions": [
    "1. Install Rust and Cargo (if not already installed):",
    "   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh",
    "",
    "2. Install the PDK CLI:",
    "   cargo install pdk-cli",
    "",
    "3. Create a new policy project:",
    "   pdk new custom-auth-policy --path /Users/developer/flex-policies",
    "",
    "4. Navigate to the project directory:",
    "   cd /Users/developer/flex-policies/custom-auth-policy",
    "",
    "5. Edit src/lib.rs to implement your policy logic",
    "",
    "6. Update Cargo.toml with policy metadata",
    "",
    "7. Test the policy:",
    "   cargo test",
    "",
    "8. Build the policy:",
    "   pdk build"
  ],
  "projectStructure": {
    "src/lib.rs": "Main policy implementation",
    "Cargo.toml": "Project configuration and dependencies",
    "definition/gcl.yaml": "Policy definition for API Manager",
    "tests/": "Policy test files"
  },
  "nextSteps": "After creating the project, implement your custom authentication logic in src/lib.rs and define the policy schema in definition/gcl.yaml"
}
```

## mock\_api\_spec

Test an endpoint’s functionality by making a request through a mocking service. Specify the
endpoint, method, and payload sent to the endpoint as body content. If you don’t specify body
content, then the tool looks for examples in the endpoint information in the API spec.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>endpointUrl</code></p></td><td><p>URL of the endpoint.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>method</code></p></td><td><p>HTTP method to create the request to the mocking service.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>id</code></p></td><td><p>Random, agent-generated UUID number that identifies the request to the mocking service.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>headers</code></p></td><td><p>Delimited string of headers sent to the endpoint. The delimiter character is \n. For example, <code>Authorization: token\nOrigin: localhost</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>Body content sent to the endpoint as a string. Make sure to consider the endpoint’s expected media type.</p></td><td><p>No</p></td></tr><tr><td><p><code>projectPath</code></p></td><td><p>Path to the project folder. The default is the current workspace. For absolute paths, use <code>file:</code> followed by three slash characters.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (GET)

```json
{
  "name": "mock_api_spec",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "method": "GET",
    "endpointUrl": "https://api.example.com/pets",
    "projectPath": "/Users/developer/projects/pet-store-api",
    "headers": "Authorization: Bearer token123\nAccept: application/json"
  }
}
```

Example request (POST)

```json
{
  "name": "mock_api_spec",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "method": "POST",
    "endpointUrl": "https://api.example.com/pets",
    "projectPath": "/Users/developer/projects/pet-store-api",
    "headers": "Authorization: Bearer token123\nContent-Type: application/json",
    "payload": "{\"name\": \"Fluffy\", \"category\": \"cat\", \"status\": \"available\"}"
  }
}
```

Example response

```json
{
  "success": true,
  "requestId": "550e8400-e29b-41d4-a716-446655440000",
  "statusCode": 200,
  "responseHeaders": {
    "Content-Type": "application/json",
    "X-Request-ID": "550e8400-e29b-41d4-a716-446655440000"
  },
  "responseBody": "{\"pets\": [{\"id\": \"1\", \"name\": \"Fluffy\", \"category\": \"cat\", \"status\": \"available\"}, {\"id\": \"2\", \"name\": \"Buddy\", \"category\": \"dog\", \"status\": \"available\"}]}",
  "responseTime": 45,
  "message": "Mock request completed successfully"
}
```

## open\_project

Open a project. For example, an API spec or an agent network project.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to the project folder. The default is the current workspace. For absolute paths, use <code>file:</code> followed by three slash characters. For example, <code>file:///Users/myUser/workspace/</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>newWindow</code></p></td><td><p>Whether the project opens in a new VS Code window (true) or not (false). The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>addToWorkspace</code></p></td><td><p>Whether the project opens in a new folder in the workspace (true) or not (false). If true, then <code>newWindow=false</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (open in current window)

```json
{
  "name": "open_project",
  "arguments": {
    "projectPath": "file:///Users/developer/projects/pet-store-api",
    "newWindow": false,
    "addToWorkspace": false
  }
}
```

Example request (add to workspace)

```json
{
  "name": "open_project",
  "arguments": {
    "projectPath": "file:///Users/developer/projects/customer-api",
    "newWindow": false,
    "addToWorkspace": true
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "file:///Users/developer/projects/pet-store-api",
  "openedInNewWindow": false,
  "addedToWorkspace": false,
  "message": "Project opened successfully in current window"
}
```

## publish\_agent\_network\_assets

Publish agent network assets to Anypoint Exchange for reuse. Specify the location, asset version,
and optional organization or business group.

Prerequisite: The agent network project must contain a valid `exchange.json` file.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to the agent network project to publish.</p></td><td><p>No</p></td></tr><tr><td><p><code>assetVersion</code></p></td><td><p>Semantic version for the asset (such as <code>1.0.0</code>).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>groupId</code></p></td><td><p>Organization/business group ID (falls back to project configuration).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "publish_agent_network_assets",
  "arguments": {
    "projectPath": "/Users/developer/projects/my-agent-network",
    "assetVersion": "1.0.0",
    "groupId": "com.example.organization"
  }
}
```

Example response

```json
{
  "success": true,
  "assetId": "my-agent-network",
  "groupId": "com.example.organization",
  "version": "1.0.0",
  "exchangeUrl": "https://anypoint.mulesoft.com/exchange/com.example.organization/my-agent-network/1.0.0/",
  "message": "Agent network assets published successfully to Exchange"
}
```

## run\_local\_mule\_application

Run application locally in Mule runtime. This tool handles the full local deployment workflow:

- If needed, it builds the project.

- If needed, it downloads runtime.

- It starts the application locally.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to the Mule project directory to run locally.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>javaHome</code></p></td><td><p>Get JAVA_HOME from JDK from <code>\"AnypointCodeBuilder\"</code> (grep for exact name) installation if it exists. Installation is usually located in the user’s home directory. If the installation doesn’t exist, get the user’s <code>java_home</code>. If multiple JDKs exist, choose the latest one that matches <code>javaSpecificationVersions</code> in <code>mule-artifacts.json</code>. If the JDK version doesn’t match any of the versions in <code>mule-artifacts.json</code>, return 'No JAVA_HOME found. Don’t retry.'.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "run_local_mule_application",
  "arguments": {
    "projectPath": "/Users/developer/customer-integration-app",
    "javaHome": "/Users/developer/.anypoint/AnypointCodeBuilder/jdk-17.0.9+9"
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "/Users/developer/customer-integration-app",
  "javaHome": "/Users/developer/.anypoint/AnypointCodeBuilder/jdk-17.0.9+9",
  "runtimeVersion": "4.9.4-2e",
  "runtimePath": "/Users/developer/.mule/runtimes/mule-enterprise-standalone-4.9.4",
  "deploymentStatus": "starting",
  "applicationUrl": "http://localhost:8081",
  "pid": 12345,
  "logFile": "/Users/developer/.mule/logs/mule_ee.log",
  "message": "Mule application is starting locally. Check logs for deployment status."
}
```

## search\_asset

Search for an asset in Anypoint Exchange by name or other specified parameters. Returns the first
asset that matches the input criteria.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>searchQuery</code></p></td><td><div><div><p>The query with criteria for the search. To specify multiple values, use comma-separated values as a single string. Parameter must include at least one value.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>assetFilters</code></p></td><td><div><div><p>Show results that match the asset type filters.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>statuses</code></p></td><td><div><div><p>Show results that match the status. Valid values are <code>deprecated</code>, <code>development</code>, and <code>published</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>organizationId</code></p></td><td><div><div><p>The ID of the organization you want to search. The default value is the ID of the user’s organization from the current session.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>sharedWithMe</code></p></td><td><div><div><p>Include shared assets in the results.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>sortCriteria</code></p></td><td><div><div><p>Sort search results.</p></div><div><p>Valid values are <code>name</code> or <code>last_modified_date</code>. Defaults to <code>last_modified_date</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>ascending</code></p></td><td><div><div><p>Sort results in ascending order.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>maxResults</code></p></td><td><div><div><p>The maximum number of assets to return in the result set. Range is between 1-10. Parameter must include at least one value.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>exchangeScope</code></p></td><td><div><div><p>Determines the scope of an asset search in Exchange. Set the appropriate scope:</p></div><div><ul><li><p>For MuleSoft provided assets: <code>exchangeScope: public</code></p></li><li><p>For private assets (default): <code>exchangeScope: private</code></p></li></ul></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "search_asset",
  "arguments": {
    "searchQuery": "customer API",
    "assetFilters": ["raml", "oas"],
    "statuses": ["published"],
    "maxResults": 5,
    "sortCriteria": "name",
    "ascending": true
  }
}
```

Example response

```json
{
  "success": true,
  "searchQuery": "customer API",
  "totalResults": 3,
  "maxResults": 5,
  "assets": [
    {
      "groupId": "com.mycompany.apis",
      "assetId": "customer-management-api",
      "version": "1.0.0",
      "name": "Customer Management API",
      "type": "raml",
      "status": "published",
      "description": "RESTful API for managing customer data and operations",
      "exchangeUrl": "https://anypoint.mulesoft.com/exchange/com.mycompany.apis/customer-management-api/1.0.0/",
      "lastModified": "2024-01-15T10:30:00Z",
      "createdBy": "developer@mycompany.com"
    },
    {
      "groupId": "com.example.apis",
      "assetId": "customer-data-api",
      "version": "2.1.0",
      "name": "Customer Data API",
      "type": "oas",
      "status": "published",
      "description": "OpenAPI specification for customer data services",
      "exchangeUrl": "https://anypoint.mulesoft.com/exchange/com.example.apis/customer-data-api/2.1.0/",
      "lastModified": "2024-01-12T14:20:00Z",
      "createdBy": "api-team@example.com"
    }
  ]
}
```

## test\_connection

Test a connector configuration for a Mule project. For example, test connectivity for an HTTP
listener connection.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>configurationUri</code></p></td><td><p>Fully qualified URI of the Mule configuration XML file that contains the connector configuration. A valid value starts with <code>file:///</code> followed by the absolute path.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>configurationName</code></p></td><td><p>Value of the name attribute of the connection configuration component in the Mule configuration XML. XPath expressions aren’t supported.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "test_connection",
  "arguments": {
    "configurationUri": "file:///Users/developer/customer-integration-app/src/main/mule/global.xml",
    "configurationName": "HTTP_Listener_config"
  }
}
```

Example response

```json
{
  "success": true,
  "configurationName": "HTTP_Listener_config",
  "connectionTest": "PASSED",
  "testDuration": 1250,
  "message": "Connection test successful",
  "details": {
    "host": "0.0.0.0",
    "port": 8081,
    "protocol": "HTTP",
    "status": "Available"
  }
}
```

## create\_api\_spec\_project

Create and scaffold an API spec or fragment project. You can specify the project name, location, and
spec language (RAML or OAS).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectName</code></p></td><td><div><div><p>Name of the API spec project.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>projectLocation</code></p></td><td><div><div><p>Directory path in which to create the project.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>specLanguage</code></p></td><td><div><div><p>Specification language for the API project. Valid values are:</p></div><div><ul><li><p><code>RAML</code> for RESTful API Modeling Language</p></li><li><p><code>OAS</code> for OpenAPI specification</p></li></ul></div></div></td><td><p>Yes</p></td></tr></tbody></table>

Example request (OAS 3.0)

```json
{
  "name": "create_api_spec_project",
  "arguments": {
    "projectName": "Pet Store API",
    "projectPath": "/Users/developer/projects",
    "language": "oas",
    "languageVersion": "3.0",
    "format": "yaml",
    "isApiEnabledForTopicsAndActions": true
  }
}
```

Example request (RAML 1.0)

```json
{
  "name": "create_api_spec_project",
  "arguments": {
    "projectName": "User Management API",
    "projectPath": "/Users/developer/projects",
    "language": "raml",
    "languageVersion": "1.0",
    "format": "yaml"
  }
}
```

Example request (RAML Fragment)

```json
{
  "name": "create_api_spec_project",
  "arguments": {
    "projectName": "Common Traits",
    "projectPath": "/Users/developer/projects",
    "language": "raml-fragment",
    "languageVersion": "1.0",
    "fragmentType": "trait",
    "format": "yaml"
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "/Users/developer/projects/pet-store-api",
  "filesCreated": ["pet-store-api.yaml", "exchange.json", "README.md"],
  "specType": "oas",
  "specVersion": "3.0",
  "message": "API spec project created successfully"
}
```

## create\_mule\_project

Create a new Mule project without flow generation. This tool focuses only on the project structure
setup with optional parameters.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Directory to create the project in. Default is the current workspace.</p></td><td><p>No</p></td></tr><tr><td><p><code>projectName</code></p></td><td><p>Name for the project. Default is a generated name.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_mule_project",
  "arguments": {
    "projectPath": "/Users/developer/projects",
    "projectName": "customer-integration-app"
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "/Users/developer/projects/customer-integration-app",
  "projectName": "customer-integration-app",
  "filesCreated": [
    "pom.xml",
    "src/main/mule/app.xml",
    "src/main/resources/application.properties",
    "src/test/munit/test-suite.xml"
  ],
  "message": "Mule project created successfully"
}
```

## create\_MCP\_server

Create a MuleSoft MCP server. This tool handles requests for creating MCP servers using Anypoint
Connector for MCP (MCP Connector).

Prerequisite: Install [MCP Connector](https://docs.mulesoft.com/mcp-connector/latest/).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path location of the Mule project folder.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectXmlPath</code></p></td><td><p>Path to the Mule project XML file.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>originalPrompt</code></p></td><td><p>The original user input without modifications. Use this for requests to create MCP servers.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "create_mcp_server",
  "arguments": {
    "projectPath": "/Users/developer/mcp-server-project",
    "projectXmlPath": "/Users/developer/mcp-server-project/src/main/mule/app.xml",
    "originalPrompt": "Create an MCP server that provides weather data integration capabilities"
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "/Users/developer/mcp-server-project",
  "mcpServerCreated": true,
  "connectorAdded": true,
  "configurationFiles": [
    "src/main/mule/mcp-server-config.xml",
    "src/main/resources/mcp-server.properties"
  ],
  "message": "MCP server created successfully with MCP Connector integration"
}
```

## dataweave\_create\_documentation

Generates DataWeave documentation using the proper syntax and returns the content for manual
insertion into the project.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>documentation</code></p></td><td><p>Detailed description of what the function does.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>parameters</code></p></td><td><p>Any parameters applicable to the function.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>example</code></p></td><td><p>An example of how to use the function.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_create_documentation",
  "arguments": {
    "documentation": "Calculates the total price including tax for a list of items. This function takes an array of items with price and quantity, applies the tax rate, and returns the total amount.",
    "parameters": [
      {
        "name": "items",
        "typeExpression": "Array<{price: Number, quantity: Number}>",
        "documentation": "Array of items containing price per unit and quantity for each item"
      },
      {
        "name": "taxRate",
        "typeExpression": "Number",
        "documentation": "Tax rate as a decimal (e.g., 0.08 for 8% tax)"
      }
    ],
    "example": {
      "documentation": "Calculate total with tax for shopping cart items",
      "code": "calculateTotalWithTax([{price: 10.50, quantity: 2}, {price: 25.00, quantity: 1}], 0.08)",
      "output": "46.44"
    }
  }
}
```

Example response

```json
{
  "success": true,
  "documentation": "/**\n * Calculates the total price including tax for a list of items. This function takes an array of items with price and quantity, applies the tax rate, and returns the total amount.\n *\n * @param items Array of items containing price per unit and quantity for each item\n * @param taxRate Tax rate as a decimal (e.g., 0.08 for 8% tax)\n * @return Number The total amount including tax\n *\n * @example Calculate total with tax for shopping cart items\n * calculateTotalWithTax([{price: 10.50, quantity: 2}, {price: 25.00, quantity: 1}], 0.08)\n * // Returns: 46.44\n */",
  "message": "DataWeave documentation generated successfully"
}
```

## dataweave\_create\_project

Creates a new DataWeave project, returns the URL of the created project, and prompts to open the
project.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>groupId</code></p></td><td><p>The group ID of the project.</p></td><td><p>No</p></td></tr><tr><td><p><code>projectName</code></p></td><td><p>The project name.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>url</code></p></td><td><p>The URL location where you want to create the new project. The default, if not specified, is <code>{USER_HOME}/dw-projects/</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_create_project",
  "arguments": {
    "groupId": "com.mycompany.dataweave",
    "projectName": "customer-data-transformer",
    "url": "file:///Users/developer/dataweave-projects/"
  }
}
```

Example response

```json
{
  "success": true,
  "projectUrl": "file:///Users/developer/dataweave-projects/customer-data-transformer",
  "projectName": "customer-data-transformer",
  "groupId": "com.mycompany.dataweave",
  "filesCreated": [
    "pom.xml",
    "src/main/dw/transform.dwl",
    "src/test/dw/transformTest.dwl",
    "README.md"
  ],
  "message": "DataWeave project created successfully. Would you like to open the project?"
}
```

## dataweave\_create\_sample\_data

Create DataWeave input sample data for a given DataWeave transformation file and return the path
where it was created. For example, use this tool to create sample data for a variable if a preview
fails with `There is no variable named 'variableName'`.

Prerequisite: Create the DataWeave script file before running `dataweave_create_sample_data`. For
information about DataWeave scripts, see
[DataWeave Scripts](https://docs.mulesoft.com/dataweave/latest/dataweave-language-introduction)

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL of the DataWeave transformation file to create sample input for. The file must be in the format of <code>file:://path</code>. For example, <code>file:///home/mdeachaval/test.dwl</code>. By default, uses the currently open file.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The content of the sample input.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>extension</code></p></td><td><p>The file extension for the sample content file type. For example <code>json</code> for a JSON file or <code>xml</code> for an XML file. The default value is <code>json</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>name</code></p></td><td><p>The name of the input to generate, such as <code>payload</code>. The default value is <code>payload</code>.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_create_sample_data",
  "arguments": {
    "url": "file:///Users/developer/my-dataweave-project/src/main/dw/customer-transform.dwl",
    "content": "{\n  \"customerId\": \"CUST-001\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"address\": {\n    \"street\": \"123 Main St\",\n    \"city\": \"Anytown\",\n    \"state\": \"CA\",\n    \"zipCode\": \"12345\"\n  },\n  \"orders\": [\n    {\n      \"orderId\": \"ORD-001\",\n      \"amount\": 99.99,\n      \"status\": \"completed\"\n    }\n  ]\n}",
    "extension": "json",
    "name": "payload"
  }
}
```

Example response

```json
{
  "success": true,
  "sampleDataPath": "file:///Users/developer/my-dataweave-project/src/test/resources/sample_data/json/payload.json",
  "fileName": "payload.json",
  "extension": "json",
  "variableName": "payload",
  "message": "Sample data created successfully for variable 'payload'"
}
```

## dataweave\_get\_module\_metadata

Returns the list of all functions available in a DataWeave module, with documentation for each
function, the input parameter types, and the output types. It includes the list of labels for each
function to use when searching.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL of the project in the format <code>file://&lt;path&gt;</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>moduleUrl</code></p></td><td><p>The URL of the DataWeave module file in the format <code>file://&lt;path&gt;.dwl</code> or <code>jar://&lt;path&gt;.dwl</code> to search documentation for. Use the <code>dataweave_get_project_metadata</code> tool to get the URL of a given module.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_get_module_metadata",
  "arguments": {
    "url": "file:///Users/developer/my-dataweave-project",
    "moduleUrl": "file:///Users/developer/my-dataweave-project/src/main/dw/utils/StringUtils.dwl"
  }
}
```

Example response

```json
{
  "success": true,
  "moduleUrl": "file:///Users/developer/my-dataweave-project/src/main/dw/utils/StringUtils.dwl",
  "moduleName": "StringUtils",
  "functions": [
    {
      "name": "capitalize",
      "documentation": "Capitalizes the first letter of each word in a string",
      "inputParameters": [
        {
          "name": "text",
          "type": "String",
          "description": "The input string to capitalize"
        }
      ],
      "outputType": "String",
      "labels": ["string", "text", "format", "capitalize"],
      "signature": "capitalize(text: String): String",
      "example": {
        "input": "capitalize(\"hello world\")",
        "output": "\"Hello World\""
      }
    },
    {
      "name": "removeWhitespace",
      "documentation": "Removes all whitespace characters from a string",
      "inputParameters": [
        {
          "name": "input",
          "type": "String",
          "description": "The string to remove whitespace from"
        }
      ],
      "outputType": "String",
      "labels": ["string", "whitespace", "clean", "trim"],
      "signature": "removeWhitespace(input: String): String",
      "example": {
        "input": "removeWhitespace(\"  hello   world  \")",
        "output": "\"helloworld\""
      }
    },
    {
      "name": "splitAndFilter",
      "documentation": "Splits a string by delimiter and filters out empty values",
      "inputParameters": [
        {
          "name": "text",
          "type": "String",
          "description": "The string to split"
        },
        {
          "name": "delimiter",
          "type": "String",
          "description": "The delimiter to split by"
        }
      ],
      "outputType": "Array<String>",
      "labels": ["string", "split", "array", "filter"],
      "signature": "splitAndFilter(text: String, delimiter: String): Array<String>",
      "example": {
        "input": "splitAndFilter(\"a,,b,c,\", \",\")",
        "output": "[\"a\", \"b\", \"c\"]"
      }
    }
  ],
  "variables": [
    {
      "name": "DEFAULT_DELIMITER",
      "type": "String",
      "value": "\",\"",
      "documentation": "Default delimiter used for string operations"
    }
  ],
  "namespaces": [
    {
      "prefix": "str",
      "uri": "dw::core::Strings"
    }
  ],
  "types": [
    {
      "name": "ProcessingOptions",
      "type": "Object",
      "properties": [
        {
          "name": "caseSensitive",
          "type": "Boolean",
          "optional": true
        },
        {
          "name": "trimWhitespace",
          "type": "Boolean",
          "optional": true
        }
      ]
    }
  ]
}
```

## dataweave\_get\_project\_metadata

Returns the metadata of a DataWeave project (including the list of source folders and test folders)
that defines where to create the files. The tool output includes the list of available modules with
their URL, and all the functions, variables, namespaces, and types. The output also includes the
list of all the data formats supported by the project. Call this tool before generating any code.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL of the project in the format <code>file://&lt;path&gt;</code>.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_get_project_metadata",
  "arguments": {
    "url": "file:///Users/developer/my-dataweave-project"
  }
}
```

Example response

```json
{
  "success": true,
  "projectUrl": "file:///Users/developer/my-dataweave-project",
  "sourceDirectories": ["src/main/dw", "src/main/resources"],
  "testDirectories": ["src/test/dw", "src/test/resources"],
  "modules": [
    {
      "name": "dw::core::Arrays",
      "url": "jar://dw-core-modules-2.4.0-20211109.jar!/dw/core/Arrays.dwl",
      "functions": [
        {
          "name": "join",
          "signature": "join(Array<T>, String): String"
        },
        {
          "name": "reduce",
          "signature": "reduce(Array<T>, (item: T, accumulator: R) -> R): R -> R"
        }
      ]
    },
    {
      "name": "StringUtils",
      "url": "file:///Users/developer/my-dataweave-project/src/main/dw/utils/StringUtils.dwl",
      "functions": [
        {
          "name": "capitalize",
          "signature": "capitalize(String): String"
        }
      ]
    }
  ],
  "supportedFormats": ["json", "xml", "csv", "yaml", "java", "multipart"],
  "variables": [
    {
      "name": "PROJECT_VERSION",
      "type": "String",
      "value": "1.0.0"
    }
  ],
  "types": [
    {
      "name": "Customer",
      "definition": "{customerId: String, name: String, email: String}"
    }
  ]
}
```

## dataweave\_open\_project

Opens a project from a given URL, either in the current window or in a new window.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL of the project to open, in the format <code>file://&lt;path&gt;</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>newWindow</code></p></td><td><p>Whether to open the file in a new window (<code>true</code>) or not (<code>false</code>). The tool always prompts the user.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_open_project",
  "arguments": {
    "url": "file:///Users/developer/my-dataweave-project",
    "newWindow": false
  }
}
```

Example response

```json
{
  "success": true,
  "projectUrl": "file:///Users/developer/my-dataweave-project",
  "openedInNewWindow": false,
  "message": "DataWeave project opened successfully in current window"
}
```

## dataweave\_run\_script\_tool

Runs a DataWeave transformation using the sample data as input context and displays the output. Use
to validate a script output. If the tool fails with missing input, create sample data using
`dataweave_create_sample_data` tool.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>url</code></p></td><td><p>The URL of the file to run the preview. The file must be in the format of <code>file:://path</code>. For example, <code>file:///home/mdeachaval/test.dwl</code>. By default, uses the currently open file.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>content</code></p></td><td><p>The content of the script to execute.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "tool_name": "dataweave_run_script_tool",
  "arguments": {
    "url": "file:///Users/developer/my-dataweave-project/src/main/dw/customer-transform.dwl",
    "content": "%dw 2.0\noutput application/json\n---\n{\n  fullName: payload.firstName ++ \" \" ++ payload.lastName,\n  contact: {\n    email: payload.email,\n    phone: payload.phoneNumber\n  },\n  customerType: if (payload.orders sizeOf > 5) \"premium\" else \"standard\"\n}"
  }
}
```

Example response

```json
{
  "success": true,
  "scriptUrl": "file:///Users/developer/my-dataweave-project/src/main/dw/customer-transform.dwl",
  "output": "{\n  \"fullName\": \"John Doe\",\n  \"contact\": {\n    \"email\": \"john.doe@example.com\",\n    \"phone\": \"+1-555-123-4567\"\n  },\n  \"customerType\": \"standard\"\n}",
  "executionTime": 45,
  "outputMimeType": "application/json",
  "message": "DataWeave script executed successfully"
}
```

## deploy\_agent\_network

Deploy an agent network instance to a runtime environment. Specify the project path, target
environment, deployment target, and Managed Omni Gateway configuration for deployment.

Prerequisites:

- Managed Omni Gateway

- A business group

- A valid `exchange.json` file in the agent network project

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to the agent network project to deploy.</p></td><td><p>No</p></td></tr><tr><td><p><code>environmentName</code></p></td><td><p>Target environment name (prompts for selection if not provided).</p></td><td><p>No</p></td></tr><tr><td><p><code>privateSpaceName</code></p></td><td><p>Private space name (prompts for selection if not provided).</p></td><td><p>No</p></td></tr><tr><td><p><code>ingressGatewayName</code></p></td><td><p>Ingress gateway name (prompts for selection if not provided).</p></td><td><p>No</p></td></tr><tr><td><p><code>egressGatewayName</code></p></td><td><p>Egress gateway name (prompts for selection if not provided).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "deploy_agent_network",
  "arguments": {
    "projectPath": "/Users/developer/projects/my-agent-network"
  }
}
```

Example response

```json
{
  "success": true,
  "deploymentId": "deployment-12345",
  "projectPath": "/Users/developer/projects/my-agent-network",
  "environment": "production",
  "status": "deployed",
  "deploymentUrl": "https://agent-network.example.com",
  "deploymentTime": "2024-01-15T10:30:00Z",
  "message": "Agent network deployed successfully"
}
```

## deploy\_mule\_application

Deploy your application to CloudHub 2.0 or Runtime Fabric and run it. You can deploy from a local
project or Anypoint Exchange asset. This tool supports security, high availability, and performance
optimization deployment options.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to Maven project root directory.</p></td><td><p>No</p></td></tr><tr><td><p><code>appName</code></p></td><td><p>The name of the application to deploy.</p></td><td><p>No</p></td></tr><tr><td><p><code>environmentName</code></p></td><td><p>Name of the environment to deploy the app to.</p></td><td><p>No</p></td></tr><tr><td><p><code>deploymentTargetName</code></p></td><td><p>Name of the deployment target.</p></td><td><p>No</p></td></tr><tr><td><p><code>runtimeVersion</code></p></td><td><p>Runtime version to use.</p></td><td><p>No</p></td></tr><tr><td><p><code>groupId</code></p></td><td><p>Group ID of the asset in Anypoint Exchange.</p></td><td><p>No</p></td></tr><tr><td><p><code>artifactId</code></p></td><td><p>Artifact ID of the asset in Anypoint Exchange.</p></td><td><p>No</p></td></tr><tr><td><p><code>version</code></p></td><td><p>Version of the asset or application.</p></td><td><p>No</p></td></tr><tr><td><p><code>secure</code></p></td><td><p>Whether to enable enhanced security features. The default is <code>false</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>highAvailability</code></p></td><td><p>Whether to enable high availability features. The default is <code>false</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>performanceOptimization</code></p></td><td><p>Whether to enable performance optimization features. The default is <code>false</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>minimumReplicas</code></p></td><td><p>Minimum number of replicas if high availability or performance optimization is enabled. Minimum is 1.</p></td><td><p>No</p></td></tr><tr><td><p><code>organizationId</code></p></td><td><p>The ID of the organization to deploy the application to.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (local project deployment)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "deploy_mule_application",
  "arguments": {
    "projectPath": "/Users/developer/customer-integration-app",
    "appName": "customer-integration-prod",
    "environmentName": "Production",
    "deploymentTargetName": "CloudHub 2.0",
    "runtimeVersion": "4.9.4:2e-java17",
    "highAvailability": true,
    "performanceOptimization": true,
    "minimumReplicas": 2,
    "secure": true
  }
}
```

Example request (Exchange asset deployment)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "deploy_mule_application",
  "arguments": {
    "groupId": "com.mycompany.apps",
    "artifactId": "customer-integration-app",
    "version": "1.0.0",
    "appName": "customer-integration-staging",
    "environmentName": "Staging",
    "deploymentTargetName": "CloudHub 2.0",
    "runtimeVersion": "4.9.4:2e-java17"
  }
}
```

Example response

```json
{
  "success": true,
  "deploymentId": "d7f4c8b2-9e1a-4f5b-8c3d-2a6b9e4f7c1a",
  "appName": "customer-integration-prod",
  "environmentName": "Production",
  "deploymentTargetName": "CloudHub 2.0",
  "runtimeVersion": "4.9.4:2e-java17",
  "status": "deploying",
  "applicationUrl": "https://customer-integration-prod.us-e2.cloudhub.io",
  "replicas": 2,
  "features": {
    "highAvailability": true,
    "performanceOptimization": true,
    "secure": true
  },
  "estimatedDeploymentTime": "5-8 minutes",
  "message": "Application deployment initiated successfully"
}
```

## generate\_api\_spec

Generate, modify, or enhance an API spec using AI.

Prerequisites:

1.  Log in to Anypoint Code Builder with your Anypoint Platform credentials.

2.  Enable Einstein in Access Management.

    See
    [Enabling or Disabling Generative AI for Anypoint Platform](https://docs.mulesoft.com/access-management/enabling-generative-ai).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>language</code></p></td><td><div><div><p>Language of the API specification to generate. Valid values are:</p></div><div><ul><li><p><code>oas</code> for OpenAPI specifications</p></li><li><p><code>raml</code> for RAML specifications</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>languageVersion</code></p></td><td><div><div><ul><li><p>If <code>language=oas</code>, valid value is <code>3.0</code>.</p></li><li><p>If <code>language=raml</code>, valid value is <code>1.0</code>.</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>specSyntax</code></p></td><td><div><div><p>Syntax of the generated API spec.</p></div><div><ul><li><p>If <code>language=oas</code> or <code>oas-components</code>, valid values are <code>json</code> and <code>yaml</code>.</p></li><li><p>If <code>language=raml</code> or <code>raml-fragments</code>, valid value is <code>raml</code>.</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>projectType</code></p></td><td><div><div><p>Valid value is <code>API_SPEC</code>.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>naturalLanguagePrompt</code></p></td><td><div><div><p>Input to the Large Language Model (LLM).</p></div></div></td><td><p>Yes</p></td></tr></tbody></table>

Example request (OAS)

```json
{
  "name": "generate_api_spec",
  "arguments": {
    "naturalLanguagePrompt": "Create a REST API for a pet store with endpoints to list pets, get pet by ID, create a new pet, update a pet, and delete a pet. Include proper error responses.",
    "language": "OAS",
    "languageVersion": "3.0",
    "projectType": "API_SPEC",
    "specSyntax": "yaml"
  }
}
```

Example request (RAML)

```json
{
  "name": "generate_api_spec",
  "arguments": {
    "naturalLanguagePrompt": "Create a RAML 1.0 API for user management with authentication endpoints and user CRUD operations.",
    "language": "RAML",
    "languageVersion": "1.0",
    "projectType": "API_SPEC",
    "specSyntax": "RAML"
  }
}
```

Example response

```json
{
  "success": true,
  "specContent": "openapi: 3.0.0\ninfo:\n  title: Pet Store API\n  version: 1.0.0\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      responses:\n        '200':\n          description: Successful response\n    post:\n      summary: Create a new pet\n      requestBody:\n        required: true\n        content:\n          application/json:\n            schema:\n              type: object\n              properties:\n                name:\n                  type: string\n                category:\n                  type: string\n  /pets/{id}:\n    get:\n      summary: Get pet by ID\n      parameters:\n        - name: id\n          in: path\n          required: true\n          schema:\n            type: string\n      responses:\n        '200':\n          description: Successful response\n        '404':\n          description: Pet not found",
  "message": "API spec generated successfully"
}
```

## generate\_mule\_flow

Generate, modify, or enhance Mule flows. Use this tool for any request involving flow changes,
including Java method calls, logging, Salesforce operations, adding connectors, transformations, or
any flow modifications.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path to the existing Mule project directory.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectXmlPath</code></p></td><td><p>Path to the existing Mule project XML file.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>originalUserPrompt</code></p></td><td><p>The original user query without any modifications. Use for requests such as updating flows, adding Java methods, logging, Salesforce operations, connectors, or any flow changes.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "generate_mule_flow",
  "arguments": {
    "projectPath": "/Users/developer/customer-integration-app",
    "projectXmlPath": "/Users/developer/customer-integration-app/src/main/mule/app.xml",
    "originalUserPrompt": "Add a flow that receives customer data via HTTP POST, validates the email format, transforms the data to match our internal schema, and saves it to Salesforce. Include error handling for validation failures."
  }
}
```

Example response

```json
{
  "success": true,
  "projectPath": "/Users/developer/customer-integration-app",
  "flowsGenerated": [
    {
      "name": "customer-data-processing-flow",
      "description": "Processes incoming customer data with validation and Salesforce integration",
      "components": [
        "HTTP Listener",
        "Email Validator",
        "Transform Message",
        "Salesforce Create",
        "Error Handler"
      ]
    }
  ],
  "connectorsAdded": ["Salesforce Connector"],
  "configurationsCreated": ["HTTP Listener Config", "Salesforce Config"],
  "xmlUpdated": "/Users/developer/customer-integration-app/src/main/mule/app.xml",
  "message": "Mule flow generated successfully with customer data processing capabilities"
}
```

## generate\_or\_modify\_munit\_test

Generate, modify, or fix MUnit tests for Mule flows. Provide the flow XML, test scenario
description, and dependencies for accurate test generation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectSource</code></p></td><td><div><div><p>The Mule flow definition, in XML format, for which an MUnit test needs to be generated. Do not include the namespace declaration. Only send the complete flow definition. Required for generating, modifying or fixing an MUnit test.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>munitFileName</code></p></td><td><div><div><p>The file name of the MUnit test. Generate the file name from the source file name in the format <code>&lt;mule-configuration-file-name&gt;-test-suite.xml</code>.</p></div></div></td><td><p>Yes for generating an MUnit test</p></td></tr><tr><td><p><code>prompt</code></p></td><td><div><div><p>A prompt that explains the validation of the test case, for example, "Verify the flow returns a 400 error when an invalid payload is received."</p></div></div></td><td><p>Yes for generating, modifying or fixing an MUnit test</p></td></tr><tr><td><p><code>minRuntimeVersion</code></p></td><td><div><div><p>The minimum runtime version required for the flow.</p></div></div></td><td><p>Yes for generating an MUnit test</p></td></tr><tr><td><p><code>dependencies</code></p></td><td><div><div><p>A JSON object containing flow dependencies referenced by the main flow. The object must include <code>flowDependencies</code>: An array of flow dependency objects that contain the <code>source</code> (the source of the dependency) and`name` (the name of the dependency) properties.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>existingMunit</code></p></td><td><div><div><p>The XML source of the existing MUnit test case that needs to be modified, including the <code>&lt;munit:test&gt;</code> element and all nested components, such as mocks, variables, and assertions.</p></div></div></td><td><p>Yes for modifying or fixing an MUnit test.</p></td></tr></tbody></table>

Example request (generate)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "generate_munit_test",
  "arguments": {
    "projectSource": "<flow name=\"customer-api-flow\" doc:id=\"abc123\">\n  <http:listener doc:name=\"Listener\" doc:id=\"def456\" config-ref=\"HTTP_Listener_config\" path=\"/customers/{customerId}\" allowedMethods=\"GET\"/>\n  <logger level=\"INFO\" doc:name=\"Log Request\" doc:id=\"ghi789\" message=\"Processing request for customer: #[attributes.uriParams.customerId]\"/>\n  <flow-ref doc:name=\"validate-customer-id\" doc:id=\"jkl012\" name=\"validate-customer-id\"/>\n  <db:select doc:name=\"Get Customer\" doc:id=\"mno345\" config-ref=\"Database_Config\">\n    <db:sql><![CDATA[SELECT * FROM customers WHERE id = :customerId]]></db:sql>\n    <db:input-parameters><![CDATA[#[{customerId: attributes.uriParams.customerId}]]]></db:input-parameters>\n  </db:select>\n  <choice doc:name=\"Choice\" doc:id=\"pqr678\">\n    <when expression=\"#[sizeOf(payload) > 0]\">\n      <ee:transform doc:name=\"Transform Customer\" doc:id=\"stu901\">\n        <ee:message>\n          <ee:set-payload><![CDATA[%dw 2.0\noutput application/json\n---\n{\n  id: payload[0].id,\n  name: payload[0].name,\n  email: payload[0].email,\n  status: \"active\"\n}]]></ee:set-payload>\n        </ee:message>\n      </ee:transform>\n    </when>\n    <otherwise>\n      <set-payload value='#[{\"error\": \"Customer not found\"}]' doc:name=\"Customer Not Found\" doc:id=\"vwx234\"/>\n      <set-variable value=\"404\" doc:name=\"Set Status\" doc:id=\"yz567\" variableName=\"httpStatus\"/>\n    </otherwise>\n  </choice>\n</flow>",
    "munitFileName": "customer-api-test-suite.xml",
    "prompt": "Generate a successful test case that verifies the flow returns customer data when a valid customer ID is provided. The test should mock the database response and validate the JSON transformation output.",
    "minMuleVersion": "4.5.0",
    "dependencies": {
      "flowDependencies": [
        {
          "source": "<sub-flow name=\"validate-customer-id\" doc:id=\"validate123\">\n  <validation:is-not-empty doc:name=\"Validate ID Not Empty\" doc:id=\"val456\" value=\"#[attributes.uriParams.customerId]\" message=\"Customer ID is required\"/>\n  <validation:matches-regex doc:name=\"Validate ID Format\" doc:id=\"val789\" value=\"#[attributes.uriParams.customerId]\" regex=\"^[0-9]+$\" message=\"Customer ID must be numeric\"/>\n</sub-flow>",
          "name": "validate-customer-id"
        }
      ]
    }
  }
}
```

Example response (generate)

```json
{
  "success": true,
  "message": "MUnit test case generated successfully",
  "details": {
    "testCaseName": "customer-api-flow-successful-retrieval",
    "munitFileName": "customer-api-test-suite.xml",
    "testFilePath": "src/test/munit/customer-api-test-suite.xml",
    "generatedTestCase": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<mule xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n     xmlns:munit=\"http://www.mulesoft.org/schema/mule/munit\"\n     xmlns:munit-tools=\"http://www.mulesoft.org/schema/mule/munit-tools\"\n     xmlns:db=\"http://www.mulesoft.org/schema/mule/db\"\n     xmlns=\"http://www.mulesoft.org/schema/mule/core\"\n     xsi:schemaLocation=\"http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd\n                         http://www.mulesoft.org/schema/mule/munit http://www.mulesoft.org/schema/mule/munit/current/mule-munit.xsd\n                         http://www.mulesoft.org/schema/mule/munit-tools http://www.mulesoft.org/schema/mule/munit-tools/current/mule-munit-tools.xsd\n                         http://www.mulesoft.org/schema/mule/db http://www.mulesoft.org/schema/mule/db/current/mule-db.xsd\">\n\n  <munit:config name=\"customer-api-test-suite.xml\"/>\n\n  <munit:test name=\"customer-api-flow-successful-retrieval\" description=\"Verify the flow returns customer data when a valid customer ID is provided\">\n    <!-- Test Setup -->\n    <munit:behavior>\n      <set-variable variableName=\"testCustomerId\" value=\"12345\"/>\n      <munit-tools:mock-when doc:name=\"Mock Database Response\" processor=\"db:select\">\n        <munit-tools:with-attributes>\n          <munit-tools:with-attribute whereValue=\"mno345\" attributeName=\"doc:id\"/>\n        </munit-tools:with-attributes>\n        <munit-tools:then-return>\n          <munit-tools:payload value='#[[{\"id\": 12345, \"name\": \"John Doe\", \"email\": \"john.doe@example.com\"}]]'/>\n        </munit-tools:then-return>\n      </munit-tools:mock-when>\n    </munit:behavior>\n\n    <!-- Test Execution -->\n    <munit:execution>\n      <flow-ref name=\"customer-api-flow\"/>\n    </munit:execution>\n\n    <!-- Test Verification -->\n    <munit:validation>\n      <munit-tools:assert-that doc:name=\"Assert Payload is Not Empty\" expression=\"#[payload]\" is=\"#[MunitTools::notNullValue()]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer ID\" actual=\"#[payload.id]\" expected=\"#[12345]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Name\" actual=\"#[payload.name]\" expected=\"#[\\\"John Doe\\\"]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Email\" actual=\"#[payload.email]\" expected=\"#[\\\"john.doe@example.com\\\"]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Status\" actual=\"#[payload.status]\" expected=\"#[\\\"active\\\"]\"/>\n    </munit:validation>\n  </munit:test>\n\n</mule>",
    "mockComponents": [
      {
        "component": "db:select",
        "docId": "mno345",
        "mockType": "database_response",
        "description": "Mocks database query response for customer retrieval"
      }
    ],
    "assertions": [
      {
        "type": "not_null",
        "target": "payload",
        "description": "Verifies response payload is not null"
      },
      {
        "type": "equals",
        "target": "payload.id",
        "expected": "12345",
        "description": "Validates customer ID in response"
      },
      {
        "type": "equals",
        "target": "payload.name",
        "expected": "John Doe",
        "description": "Validates customer name in response"
      },
      {
        "type": "equals",
        "target": "payload.email",
        "expected": "john.doe@example.com",
        "description": "Validates customer email in response"
      },
      {
        "type": "equals",
        "target": "payload.status",
        "expected": "active",
        "description": "Validates customer status in response"
      }
    ],
    "testScenario": "successful_retrieval",
    "nextSteps": [
      "Append this test case to the MUnit test file",
      "Generate additional test cases for error scenarios",
      "Run the test to verify it passes",
      "Add more assertions if needed for complete coverage"
    ]
  }
}
```

Example request (modify)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "modify_munit_test",
  "arguments": {
    "projectSource": "<flow name=\"customer-api-flow\" doc:id=\"abc123\">\n  <http:listener doc:name=\"Listener\" doc:id=\"def456\" config-ref=\"HTTP_Listener_config\" path=\"/customers/{customerId}\" allowedMethods=\"GET\"/>\n  <logger level=\"INFO\" doc:name=\"Log Request\" doc:id=\"ghi789\" message=\"Processing request for customer: #[attributes.uriParams.customerId]\"/>\n  <flow-ref doc:name=\"validate-customer-id\" doc:id=\"jkl012\" name=\"validate-customer-id\"/>\n  <db:select doc:name=\"Get Customer\" doc:id=\"mno345\" config-ref=\"Database_Config\">\n    <db:sql><![CDATA[SELECT * FROM customers WHERE id = :customerId AND status = 'ACTIVE']]></db:sql>\n    <db:input-parameters><![CDATA[#[{customerId: attributes.uriParams.customerId}]]]></db:input-parameters>\n  </db:select>\n  <choice doc:name=\"Choice\" doc:id=\"pqr678\">\n    <when expression=\"#[sizeOf(payload) > 0]\">\n      <ee:transform doc:name=\"Transform Customer\" doc:id=\"stu901\">\n        <ee:message>\n          <ee:set-payload><![CDATA[%dw 2.0\noutput application/json\n---\n{\n  customerId: payload[0].id,\n  customerName: payload[0].name,\n  emailAddress: payload[0].email,\n  accountStatus: \"active\",\n  lastUpdated: now()\n}]]></ee:set-payload>\n        </ee:message>\n      </ee:transform>\n    </when>\n    <otherwise>\n      <set-payload value='#[{\"error\": \"Customer not found or inactive\", \"code\": \"CUSTOMER_NOT_FOUND\"}]' doc:name=\"Customer Not Found\" doc:id=\"vwx234\"/>\n      <set-variable value=\"404\" doc:name=\"Set Status\" doc:id=\"yz567\" variableName=\"httpStatus\"/>\n    </otherwise>\n  </choice>\n</flow>",
    "prompt": "The existing test is failing because the flow was updated to include a status filter in the database query and the response structure changed. Update the test to use the new field names (customerId instead of id, customerName instead of name, emailAddress instead of email) and add the lastUpdated field validation. Also update the mock to include the status field in the database response.",
    "dependencies": {
      "flowDependencies": [
        {
          "source": "<sub-flow name=\"validate-customer-id\" doc:id=\"validate123\">\n  <validation:is-not-empty doc:name=\"Validate ID Not Empty\" doc:id=\"val456\" value=\"#[attributes.uriParams.customerId]\" message=\"Customer ID is required\"/>\n  <validation:matches-regex doc:name=\"Validate ID Format\" doc:id=\"val789\" value=\"#[attributes.uriParams.customerId]\" regex=\"^[0-9]+$\" message=\"Customer ID must be numeric\"/>\n</sub-flow>",
          "name": "validate-customer-id"
        }
      ]
    },
    "existingMunit": "<munit:test name=\"customer-api-flow-successful-retrieval\" description=\"Verify the flow returns customer data when a valid customer ID is provided\">\n    <munit:behavior>\n      <set-variable variableName=\"testCustomerId\" value=\"12345\"/>\n      <munit-tools:mock-when doc:name=\"Mock Database Response\" processor=\"db:select\">\n        <munit-tools:with-attributes>\n          <munit-tools:with-attribute whereValue=\"mno345\" attributeName=\"doc:id\"/>\n        </munit-tools:with-attributes>\n        <munit-tools:then-return>\n          <munit-tools:payload value='#[[{\"id\": 12345, \"name\": \"John Doe\", \"email\": \"john.doe@example.com\"}]]'/>\n        </munit-tools:then-return>\n      </munit-tools:mock-when>\n    </munit:behavior>\n    <munit:execution>\n      <flow-ref name=\"customer-api-flow\"/>\n    </munit:execution>\n    <munit:validation>\n      <munit-tools:assert-that doc:name=\"Assert Payload is Not Empty\" expression=\"#[payload]\" is=\"#[MunitTools::notNullValue()]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer ID\" actual=\"#[payload.id]\" expected=\"#[12345]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Name\" actual=\"#[payload.name]\" expected=\"#[\\\"John Doe\\\"]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Email\" actual=\"#[payload.email]\" expected=\"#[\\\"john.doe@example.com\\\"]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Status\" actual=\"#[payload.status]\" expected=\"#[\\\"active\\\"]\"/>\n    </munit:validation>\n  </munit:test>"
  }
}
```

Example response (modify)

```json
{
  "success": true,
  "message": "MUnit test case modified successfully",
  "details": {
    "testCaseName": "customer-api-flow-successful-retrieval",
    "modificationType": "field_mapping_update",
    "changesApplied": [
      "Updated database mock to include status field",
      "Changed assertion field names to match new response structure",
      "Added validation for lastUpdated field",
      "Updated mock data to reflect active status requirement"
    ],
    "modifiedTestCase": "<munit:test name=\"customer-api-flow-successful-retrieval\" description=\"Verify the flow returns customer data when a valid customer ID is provided\">\n    <munit:behavior>\n      <set-variable variableName=\"testCustomerId\" value=\"12345\"/>\n      <munit-tools:mock-when doc:name=\"Mock Database Response\" processor=\"db:select\">\n        <munit-tools:with-attributes>\n          <munit-tools:with-attribute whereValue=\"mno345\" attributeName=\"doc:id\"/>\n        </munit-tools:with-attributes>\n        <munit-tools:then-return>\n          <munit-tools:payload value='#[[{\"id\": 12345, \"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"status\": \"ACTIVE\"}]]'/>\n        </munit-tools:then-return>\n      </munit-tools:mock-when>\n    </munit:behavior>\n    <munit:execution>\n      <flow-ref name=\"customer-api-flow\"/>\n    </munit:execution>\n    <munit:validation>\n      <munit-tools:assert-that doc:name=\"Assert Payload is Not Empty\" expression=\"#[payload]\" is=\"#[MunitTools::notNullValue()]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer ID\" actual=\"#[payload.customerId]\" expected=\"#[12345]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Name\" actual=\"#[payload.customerName]\" expected=\"#[\\\"John Doe\\\"]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Customer Email\" actual=\"#[payload.emailAddress]\" expected=\"#[\\\"john.doe@example.com\\\"]\"/>\n      <munit-tools:assert-equals doc:name=\"Assert Account Status\" actual=\"#[payload.accountStatus]\" expected=\"#[\\\"active\\\"]\"/>\n      <munit-tools:assert-that doc:name=\"Assert Last Updated Exists\" expression=\"#[payload.lastUpdated]\" is=\"#[MunitTools::notNullValue()]\"/>\n      <munit-tools:assert-that doc:name=\"Assert Last Updated is DateTime\" expression=\"#[payload.lastUpdated]\" is=\"#[MunitTools::instanceOf(DateTime)]\"/>\n    </munit:validation>\n  </munit:test>",
    "beforeAfterComparison": {
      "mockChanges": {
        "before": "Mock returned: {\"id\": 12345, \"name\": \"John Doe\", \"email\": \"john.doe@example.com\"}",
        "after": "Mock returns: {\"id\": 12345, \"name\": \"John Doe\", \"email\": \"john.doe@example.com\", \"status\": \"ACTIVE\"}"
      },
      "assertionChanges": [
        {
          "before": "payload.id",
          "after": "payload.customerId",
          "reason": "Field renamed in flow transformation"
        },
        {
          "before": "payload.name",
          "after": "payload.customerName",
          "reason": "Field renamed in flow transformation"
        },
        {
          "before": "payload.email",
          "after": "payload.emailAddress",
          "reason": "Field renamed in flow transformation"
        },
        {
          "added": "payload.lastUpdated validation",
          "reason": "New field added to flow output"
        }
      ]
    },
    "testExecutionReady": true,
    "nextSteps": [
      "Replace the existing test case in the MUnit file with this modified version",
      "Run the test to verify it passes with the updated flow",
      "Consider adding additional test cases for inactive customer scenarios",
      "Verify all related test cases are updated for consistency"
    ]
  }
}
```

## get\_flex\_gateway\_policy\_example

Get an Omni Gateway policy example to help you configure your Rust source code. Use this tool to get
example policies that manipulate a request’s header and body, make HTTP and gRPC calls to external
services, share data between requests and responses, reject requests, perform sleep operations, and
use PDK libraries.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>feature</code></p></td><td><div><div><p>The type of policy feature to generate an example for. Valid values are:</p></div><div><ul><li><p><code>authentication</code> to propagate authentication information to other policies.</p></li><li><p><code>body_manipulation</code> to read or update request/response body.</p></li><li><p><code>body_stream</code> to read request/response body by chunks.</p></li><li><p><code>cache</code> to use the cache library to share data across workers.</p></li><li><p><code>contracts</code> to authenticate and authorize against the management plane.</p></li><li><p><code>control_flow</code> to stop the request flow and generate a custom response.</p></li><li><p><code>cors</code> to use the Cross-Origin Resource Sharing library.</p></li><li><p><code>dataweave</code> to define and evaluate custom DataWeave expressions.</p></li><li><p><code>grpc</code> to make a gRPC call to an external service.</p></li><li><p><code>header_manipulation</code> to perform CRUD operations for request/response headers.</p></li><li><p><code>http_call</code> to make an HTTP call to an external service.</p></li><li><p><code>ip_filter</code> to allow or block requests based on IP addresses and CIDR ranges.</p></li><li><p><code>jwt</code> to parse and validate JSON Web Tokens.</p></li><li><p><code>jwt_generate</code> to generate JSON Web Tokens.</p></li><li><p><code>json_validator</code> to validate JSON payloads.</p></li><li><p><code>lock</code> to synchronize workers.</p></li><li><p><code>logger</code> to print custom messages.</p></li><li><p><code>metadata</code> to access metadata of the policy, API, and environment.</p></li><li><p><code>oauth2_token_introspection</code> to validate OAuth2 tokens.</p></li><li><p><code>outbound</code> to define an outbound policy.</p></li><li><p><code>policy_violation</code> to mark requests as violations in monitoring traffic.</p></li><li><p><code>rate_limiting</code> to allow or block requests based on rate limits.</p></li><li><p><code>request_data</code> to share data between requests and responses.</p></li><li><p><code>spike_control</code> to limit requests by queuing or rejecting traffic that exceeds a sliding-window rate limit.</p></li><li><p><code>stop_iteration</code> to enable processing of headers and body in the same request/response state.</p></li><li><p><code>timer</code> to perform sleep operations.</p></li><li><p><code>unit_testing</code> to generate unit tests for your custom policy.</p></li><li><p><code>worker_variable</code> to share data across requests of a single worker.</p></li><li><p><code>xml_validator</code> to validate XML payloads.</p></li></ul></div></div></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "get_flex_gateway_policy_example",
  "arguments": {
    "feature": "header_manipulation"
  }
}
```

Example response

```json
{
  "success": true,
  "feature": "header_manipulation",
  "exampleCode": [
    "use pdk::api::*;",
    "use pdk::logger::info;",
    "",
    "#[entrypoint]",
    "async fn configure(launcher: Launcher) -> Result<(), LaunchError> {",
    "    let filter = on_request(|request| {",
    "        // Add custom header to request",
    "        request.headers_mut().insert(",
    "            \"X-Custom-Header\",",
    "            \"custom-value\".parse().unwrap()",
    "        );",
    "        ",
    "        // Log the operation",
    "        info!(\"Added custom header to request\");",
    "        ",
    "        Ok(request)",
    "    });",
    "    ",
    "    launcher.launch(filter).await",
    "}",
    "",
    "#[cfg(test)]",
    "mod tests {",
    "    use super::*;",
    "    use pdk::test::*;",
    "    ",
    "    #[tokio::test]",
    "    async fn test_header_manipulation() {",
    "        let request = TestRequestBuilder::new()",
    "            .method(\"GET\")",
    "            .uri(\"/api/test\")",
    "            .build();",
    "            ",
    "        let response = execute_policy(request).await.unwrap();",
    "        ",
    "        assert!(response.headers().contains_key(\"X-Custom-Header\"));",
    "        assert_eq!(",
    "            response.headers()[\"X-Custom-Header\"],",
    "            \"custom-value\"",
    "        );",
    "    }",
    "}"
  ],
  "description": "Example Rust policy for manipulating request headers using the Omni Gateway Policy Development Kit (PDK)",
  "dependencies": [
    "pdk = { version = \"0.1.0\" }",
    "tokio = { version = \"1.0\", features = [\"full\"] }"
  ],
  "explanation": "This example demonstrates how to add custom headers to incoming requests using the PDK API. The policy uses the on_request filter to intercept requests and modify headers before they reach the backend service."
}
```

## get\_platform\_insights

See how your organization leverages Anypoint Platform through usage and operational insights. These
include:

- Usage trends for apps, such as flow count, message counts, and data throughput by business group
  and environment. Usage trends are for the current month. If it’s early in the month, you get usage
  for the last full month.

- API and app call volume across consumers for the last 7 days.

- API and app performance metrics such as errors and latency for the last 7 days.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>entityName</code></p></td><td><div><div><p>Name of the application or API.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>entityType</code></p></td><td><div><div><p>Type of entity to get insights for. Use <code>application</code> for Mule applications or <code>api</code> for APIs.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>includeFlows</code></p></td><td><div><div><p>Whether to include app usage trends for flows. The default value is <code>false</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>includeMessages</code></p></td><td><div><div><p>Whether to include app usage trends for messages. The default value is <code>false</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>includeDataThroughput</code></p></td><td><div><div><p>Whether to include app usage trends for data throughput. The default value is <code>false</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>includeErrorCount</code></p></td><td><div><div><p>Whether to include error counts from apps and APIs. The default value is <code>false</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>includeCallVolume</code></p></td><td><div><div><p>Whether to include call volume from apps and APIs. The default value is <code>false</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>includeLatency</code></p></td><td><div><div><p>Whether to include P99 latency in the response time. The default value is <code>false</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>latencyPercentile</code></p></td><td><div><div><p>If <code>includeLatency=true</code>, this parameter specifies which percentile to use for latency measurements. Valid values are:</p></div><div><ul><li><p><code>P99</code> for 99th percentile</p></li><li><p><code>P95</code> for 95th percentile</p></li><li><p><code>P90</code> for 90th percentile</p></li><li><p><code>P75</code> for 75th percentile</p></li></ul></div><div><p>The default value is <code>P99</code>.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request (organization overview)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "get_platform_insights",
  "arguments": {
    "includeFlows": true,
    "includeMessages": true,
    "includeDataThroughput": true,
    "includeCallVolume": true,
    "includeLatency": true,
    "latencyPercentile": "P95"
  }
}
```

Example request (specific application)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "get_platform_insights",
  "arguments": {
    "entityName": "customer-integration-app",
    "entityType": "application",
    "includeErrorCount": true,
    "includeCallVolume": true,
    "includeLatency": true
  }
}
```

Example response

```json
{
  "success": true,
  "timeRange": {
    "usageTrends": "2024-01-01 to 2024-01-31",
    "performanceMetrics": "2024-01-24 to 2024-01-31"
  },
  "usageTrends": {
    "flows": {
      "totalFlows": 245,
      "activeFlows": 198,
      "flowsById": [
        {
          "businessGroup": "Sales",
          "environment": "Production",
          "flowCount": 45
        },
        {
          "businessGroup": "Marketing",
          "environment": "Production",
          "flowCount": 32
        }
      ]
    },
    "messages": {
      "totalMessages": 1250000,
      "messagesByBusinessGroup": [
        {
          "businessGroup": "Sales",
          "messageCount": 650000
        },
        {
          "businessGroup": "Marketing",
          "messageCount": 400000
        }
      ]
    },
    "dataThroughput": {
      "totalGB": 125.5,
      "throughputByEnvironment": [
        {
          "environment": "Production",
          "throughputGB": 98.2
        },
        {
          "environment": "Staging",
          "throughputGB": 27.3
        }
      ]
    }
  },
  "performanceMetrics": {
    "callVolume": {
      "totalCalls": 875000,
      "dailyAverage": 125000,
      "topConsumers": [
        {
          "consumerName": "Mobile App",
          "calls": 325000
        },
        {
          "consumerName": "Web Portal",
          "calls": 250000
        }
      ]
    },
    "latency": {
      "percentile": "P95",
      "averageLatencyMs": 145,
      "latencyByApp": [
        {
          "appName": "customer-integration-app",
          "p95LatencyMs": 89
        }
      ]
    },
    "errors": {
      "totalErrors": 1250,
      "errorRate": 0.14,
      "errorsByType": [
        {
          "errorType": "Timeout",
          "count": 450
        },
        {
          "errorType": "Connection",
          "count": 320
        }
      ]
    }
  }
}
```

## get\_reuse\_metrics

Get visibility into assets reuse across your organization. Drive efficiency, consistency, and cost
savings by reducing duplication. Includes sandbox and production environments. Metrics are a
year-to-date snapshot.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>includeReuseMetrics</code></p></td><td><p>Whether the output includes reuse metrics for applications. Default is false.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "get_reuse_metrics",
  "arguments": {
    "includeReuseMetrics": true
  }
}
```

Example response

```json
{
  "success": true,
  "reportingPeriod": "2024 Year-to-Date",
  "summary": {
    "totalAssets": 156,
    "reusedAssets": 89,
    "reuseRate": "57%",
    "costSavingsEstimate": "$45,000"
  },
  "reuseMetrics": {
    "byAssetType": [
      {
        "assetType": "mule-application",
        "totalAssets": 45,
        "reusedAssets": 28,
        "reuseRate": "62%",
        "avgReusesPerAsset": 3.2
      },
      {
        "assetType": "raml",
        "totalAssets": 32,
        "reusedAssets": 25,
        "reuseRate": "78%",
        "avgReusesPerAsset": 4.1
      },
      {
        "assetType": "connector",
        "totalAssets": 18,
        "reusedAssets": 15,
        "reuseRate": "83%",
        "avgReusesPerAsset": 5.7
      }
    ],
    "byBusinessGroup": [
      {
        "businessGroup": "Sales",
        "assetsCreated": 34,
        "assetsReused": 67,
        "reuseRatio": 1.97
      },
      {
        "businessGroup": "Marketing",
        "assetsCreated": 28,
        "assetsReused": 45,
        "reuseRatio": 1.61
      }
    ],
    "topReusedAssets": [
      {
        "assetName": "Customer API",
        "assetType": "raml",
        "reuseCount": 12,
        "lastReused": "2024-01-28"
      },
      {
        "assetName": "HTTP Basic Auth Policy",
        "assetType": "policy",
        "reuseCount": 8,
        "lastReused": "2024-01-30"
      }
    ]
  },
  "environments": ["Production", "Staging", "Development"],
  "recommendations": [
    "Consider promoting 'Payment Processing Flow' template to Exchange for wider reuse",
    "Customer API shows high reuse - consider creating additional variants",
    "15 assets have not been reused - review for consolidation opportunities"
  ]
}
```

## get\_topics\_agent\_actions\_metadata\_instructions

Get metadata and instructions for enabling topics and agent actions from an OpenAI spec. Topics are
bundles of actions and sets of instructions agents use to complete tasks. Actions are tasks that the
agent can do, and instructions help the agent understand how to use actions.

Available only in Anypoint Code Builder.

This tool has no parameters.

Example request

```json
{
  "name": "get_topics_agent_actions_metadata_instructions",
  "arguments": {}
}
```

Example response

```json
{
  "topics": [
    {
      "id": "api-management",
      "name": "API Management",
      "description": "Topics related to API management operations",
      "actions": [
        {
          "id": "create-api",
          "name": "Create API",
          "description": "Create a new API specification",
          "instructions": "Use this action to create a new API specification. Provide the API name, version, and specification format."
        }
      ],
      "instructions": "Use these actions to manage APIs in your organization."
    }
  ],
  "metadata": {
    "version": "1.0.0",
    "lastUpdated": "2024-01-15T10:30:00Z"
  }
}
```

## implement\_api\_spec

Use APIkit flows to implement an API specification in a new integration project. You can implement a
specification from a local project or an Anypoint Exchange asset.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>mode</code></p></td><td><p>Determines the operation type. To implement API specs in a local workspace, use <code>local_scaffolding</code> mode. For APIs published to Anypoint Exchange, use <code>exchange_api_scaffolding</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectName</code></p></td><td><p>The name for the integration project. Also used as the project folder name.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectPath</code></p></td><td><p>[<code>local_scaffolding</code> mode] The absolute path to the local API project to scaffold. The API project must contain a valid exchange.json and classifier.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>projectLocation</code></p></td><td><p>The path where the project folder is located. The default is the current workspace.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>groupId</code></p></td><td><p>[<code>exchange_api_scaffolding</code> mode] The group ID of the API specification in Anypoint Exchange.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>assetId</code></p></td><td><p>[<code>exchange_api_scaffolding</code> mode] The asset ID of the API specification in Anypoint Exchange.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>version</code></p></td><td><p>[<code>exchange_api_scaffolding</code> mode] The version of the API specification, for example '1.4.0'.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>classifier</code></p></td><td><p>[<code>exchange_api_scaffolding</code> mode] The classifier of the API specification. Fetched from Anypoint Exchange if not provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>type</code></p></td><td><p>[<code>exchange_api_scaffolding</code> mode] The type or packaging of the API specification. Fetched from Anypoint Exchange if not provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>main</code></p></td><td><p>[<code>exchange_api_scaffolding</code> mode] The main file of the API specification. Fetched from Anypoint Exchange if not provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>runtimeVersion</code></p></td><td><p>The runtime version to use. Uses the workspace configuration or the latest version available if not specified.</p></td><td><p>No</p></td></tr><tr><td><p><code>jdkVersion</code></p></td><td><p>The JDK version to use. Uses the workspace configuration or the latest available if not specified.</p></td><td><p>No</p></td></tr><tr><td><p><code>mavenGroupId</code></p></td><td><p>The Maven group ID for the project. Defaults to the group ID of the API specification or workspace setting.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "implement_api_spec",
  "arguments": {
    "groupId": "com.acme.apis",
    "assetId": "customer-management-api",
    "version": "1.2.0",
    "projectName": "customer-management-implementation",
    "projectLocation": "/Users/developer/mule-projects",
    "classifier": "raml",
    "type": "zip",
    "main": "api.raml",
    "runtimeVersion": "4.6.0",
    "jdkVersion": "17",
    "mavenGroupId": "com.acme.implementations"
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Mule project successfully scaffolded from API specification",
  "details": {
    "projectPath": "/Users/developer/mule-projects/customer-management-implementation",
    "apiSpecification": {
      "groupId": "com.acme.apis",
      "assetId": "customer-management-api",
      "version": "1.2.0",
      "classifier": "raml",
      "mainFile": "api.raml"
    },
    "projectConfiguration": {
      "name": "customer-management-implementation",
      "runtimeVersion": "4.6.0",
      "jdkVersion": "17",
      "mavenGroupId": "com.acme.implementations",
      "artifactId": "customer-management-implementation"
    },
    "generatedFiles": [
      "pom.xml",
      "mule-artifact.json",
      "src/main/mule/implementation.xml",
      "src/main/resources/api/api.raml",
      "src/main/resources/application.yaml",
      "src/test/munit/implementation-test-suite.xml"
    ],
    "endpoints": [
      {
        "method": "GET",
        "path": "/customers",
        "description": "Get all customers"
      },
      {
        "method": "POST",
        "path": "/customers",
        "description": "Create a new customer"
      },
      {
        "method": "GET",
        "path": "/customers/{customerId}",
        "description": "Get customer by ID"
      },
      {
        "method": "PUT",
        "path": "/customers/{customerId}",
        "description": "Update customer"
      },
      {
        "method": "DELETE",
        "path": "/customers/{customerId}",
        "description": "Delete customer"
      }
    ],
    "nextSteps": [
      "Open the project in your workspace using the open_project tool",
      "Implement business logic for each endpoint",
      "Configure database connections if needed",
      "Add error handling and validation",
      "Test the implementation using MUnit"
    ]
  }
}
```

## list\_api\_instances

Get information for instances in an environment. You can also filter by an instance ID or label and
include applied or available policies. Use the `page` parameter to paginate results.

Prompt tip: To get information for all instances, revise results using the `page` parameter.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>organizationId</code></p></td><td><p>ID of the organization where instances reside. Default is the ID of the default organization.</p></td><td><p>No</p></td></tr><tr><td><p><code>environmentName</code></p></td><td><p>Name of the environment where instances reside. Default is the name of the default environment for the organization specified in <code>organizationId</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>apiInstanceId</code></p></td><td><p>Instance ID of the API.</p></td><td><p>No</p><p>Required if <code>includeAvailablePolicies=true</code>.</p></td></tr><tr><td><p><code>apiInstanceLabel</code></p></td><td><p>Label or name of the API instance.</p></td><td><p>No</p></td></tr><tr><td><p><code>page</code></p></td><td><p>Page number of the results. Each page contains information for up to 10 instances.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>includeAppliedPolicies</code></p></td><td><p>Whether to include applied policies in results.</p></td><td><p>No</p></td></tr><tr><td><p><code>includeAvailablePolicies</code></p></td><td><p>Whether to include available policies in results. Requires <code>apiInstanceId</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (list all instances)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "list_api_instances",
  "arguments": {
    "environmentName": "Production",
    "page": 1,
    "includeAppliedPolicies": true
  }
}
```

Example request (specific instance with available policies)

```json
{
  "server_name": "https://www.npmjs.com/package/@mulesoft/mcp-server",
  "tool_name": "list_api_instances",
  "arguments": {
    "environmentName": "Production",
    "apiInstanceId": "12345",
    "page": 1,
    "includeAppliedPolicies": true,
    "includeAvailablePolicies": true
  }
}
```

Example response

```json
{
  "success": true,
  "environmentName": "Production",
  "page": 1,
  "totalPages": 3,
  "totalInstances": 25,
  "instances": [
    {
      "apiInstanceId": "12345",
      "apiInstanceLabel": "Customer Management API",
      "assetId": "customer-api",
      "assetVersion": "1.0.0",
      "groupId": "com.mycompany.apis",
      "runtimeEngine": "mule4",
      "endpointUri": "https://backend.example.com/api/customers",
      "consumerEndpoint": "https://api.example.com/customers",
      "status": "active",
      "appliedPolicies": [
        {
          "policyId": "rate-limiting-001",
          "policyName": "Rate Limiting",
          "version": "1.2.0",
          "status": "applied"
        },
        {
          "policyId": "basic-auth-002",
          "policyName": "HTTP Basic Authentication",
          "version": "1.0.0",
          "status": "applied"
        }
      ],
      "availablePolicies": [
        {
          "policyName": "OAuth 2.0 Access Token Enforcement",
          "assetId": "oauth-2-access-token-enforcement",
          "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
          "version": "3.2.2",
          "description": "Validates OAuth 2.0 access tokens"
        }
      ]
    },
    {
      "apiInstanceId": "67890",
      "apiInstanceLabel": "Product Catalog API",
      "assetId": "product-api",
      "assetVersion": "2.1.0",
      "groupId": "com.mycompany.apis",
      "runtimeEngine": "mule4",
      "endpointUri": "https://backend.example.com/api/products",
      "consumerEndpoint": "https://api.example.com/products",
      "status": "active",
      "appliedPolicies": []
    }
  ]
}
```

## uc\_add\_pagination

Add pagination support to a specific CCM operation. Takes the operation file path and pagination
configuration parameters and creates a paginated operation module.

Available only in Connector Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>operationFilePath</code></p></td><td><div><div><p>Path (URI) to an operation file inside the CCM operations directory.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>type</code></p></td><td><div><div><p>Pagination strategy to apply. Valid values are:</p></div><div><ul><li><p><code>offset</code></p></li><li><p><code>cursor</code></p></li><li><p><code>page</code></p></li><li><p><code>timestamp</code></p></li><li><p><code>custom</code></p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>itemsField</code></p></td><td><div><div><p>Path to the array of items in the response, for example, <code>data.items</code> or <code>results</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>offsetParam</code></p></td><td><div><div><p>Name of the offset parameter, for example, <code>offset</code> or <code>skip</code>.</p></div></div></td><td><p>Required when <code>type='offset'</code>.</p></td></tr><tr><td><p><code>initialOffsetValue</code></p></td><td><div><div><p>Starting offset value (typically <code>0</code>).</p></div></div></td><td><p>Required when <code>type='offset'</code>.</p></td></tr><tr><td><p><code>pageNumberParam</code></p></td><td><div><div><p>Name of the page number parameter, for example, <code>page</code> or <code>pageNumber</code>.</p></div></div></td><td><p>Required when <code>type='page'</code>.</p></td></tr><tr><td><p><code>initialPageNumber</code></p></td><td><div><div><p>Starting page number (typically <code>0</code> or <code>1</code>).</p></div></div></td><td><p>Required when <code>type='page'</code>.</p></td></tr><tr><td><p><code>timestampParam</code></p></td><td><div><div><p>Name of the timestamp parameter, for example, <code>since</code> or <code>after</code>.</p></div></div></td><td><p>Required when <code>type='timestamp'</code>.</p></td></tr><tr><td><p><code>cursorParam</code></p></td><td><div><div><p>Name of the cursor parameter, for example, <code>cursor</code> or <code>nextToken</code>.</p></div></div></td><td><p>Required when <code>type='cursor'</code>.</p></td></tr><tr><td><p><code>referenceType</code></p></td><td><div><div><p>Type of reference used for cursor pagination. Valid values are:</p></div><div><ul><li><p><code>marker</code> for a simple marker or token value</p></li><li><p><code>uri</code> for a URI containing the next page reference</p></li></ul></div></div></td><td><p>Required when <code>type='cursor'</code>.</p></td></tr><tr><td><p><code>referenceExpression</code></p></td><td><div><div><p>Path expression to extract the next cursor value from the response, for example, <code>pagination.nextCursor</code>.</p></div></div></td><td><p>Required when <code>type='cursor'</code>.</p></td></tr><tr><td><p><code>projectRootPath</code></p></td><td><div><div><p>Absolute path to the connector project directory. Defaults to the workspace root folder.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "uc_add_pagination",
  "arguments": {
    "operationFilePath": "/Users/you/workspace/stripe-connector/operations/list-customers.yaml",
    "type": "cursor",
    "cursorParam": "starting_after",
    "referenceType": "marker",
    "referenceExpression": "data[-1].id",
    "itemsField": "data"
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Pagination added to operation."
}
```

## uc\_connector\_lifecycle

Manage connector lifecycle operations. Use `type='build'` to build the connector project using the
extension’s bundled Maven (`mvn install`). Use `type='publish'` to publish the connector to Anypoint
Exchange (`mvn deploy`). For publish, the tool automatically determines execution mode: granular
mode if all required configuration is available (executes publish directly), or workflow mode if
`organizationId` or `repositoryId` is missing (returns a workflow plan to collect configuration).

Available only in Connector Builder.

> [!NOTE] This tool was previously named `uc_publish_connector`. The renamed tool also supports the
> `build` action.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>type</code></p></td><td><div><div><p>Lifecycle action to perform. Valid values are:</p></div><div><ul><li><p><code>build</code> to compile and package the connector project</p></li><li><p><code>publish</code> to deploy the connector to Anypoint Exchange</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>cleanBeforeBuild</code></p></td><td><div><div><p>Whether to run <code>clean</code> before <code>install</code>. Used when <code>type='build'</code>. Defaults to the corresponding VS Code setting.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>workflowCustomization</code></p></td><td><div><div><p>Specific workflow customizations, preferences, or requirements for the publish process. Used when <code>type='publish'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>organizationId</code></p></td><td><div><div><p>Anypoint Exchange organization ID. If not provided, the tool checks the POM file. If missing there too, workflow mode is triggered. Used when <code>type='publish'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>repositoryId</code></p></td><td><div><div><p>Private Exchange repository ID. Same fallback behavior as <code>organizationId</code>. Used when <code>type='publish'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>profiles</code></p></td><td><div><div><p>Maven profiles to activate for deployment. Defaults to <code>['private-exchange-deploy']</code>. Used when <code>type='publish'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>projectRootPath</code></p></td><td><div><div><p>Absolute path to the connector project directory. Defaults to the workspace root folder.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "uc_connector_lifecycle",
  "arguments": {
    "type": "publish",
    "organizationId": "abc123",
    "repositoryId": "xyz789"
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Connector published to Anypoint Exchange."
}
```

## uc\_create\_connector\_workflow

Create a complete LinkWeave connector end-to-end with guided workflow planning. Supports two flows:
generating an API spec from documentation, or using an existing API spec file. Returns a detailed
workflow plan with numbered steps to execute sequentially.

Available only in Connector Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>workflowCustomization</code></p></td><td><div><div><p>Any specific workflow customizations, preferences, or requirements for the connector-creation process.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>flow</code></p></td><td><div><div><p>Flow selection. Valid values are:</p></div><div><ul><li><p><code>generate-spec</code> to generate an API spec from documentation</p></li><li><p><code>existing-spec</code> if the user has an existing API spec file</p></li><li><p><code>auto-detect</code> to determine automatically</p></li></ul></div></div></td><td><p>No</p></td></tr><tr><td><p><code>existingApiSpec</code></p></td><td><div><div><p>Absolute path to existing API spec file (OpenAPI/Swagger YAML or JSON) if using <code>existing-spec</code> flow.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Execution mode. Valid values are:</p></div><div><ul><li><p><code>standard</code> (default) runs interactively with user confirmation steps.</p></li><li><p><code>connectorless</code> runs autonomously and only pauses to collect credentials.</p></li></ul></div></div></td><td><p>No</p></td></tr><tr><td><p><code>platform</code></p></td><td><div><div><p>Name of the SaaS platform, for example, <code>Stripe</code> or <code>ServiceNow</code>. Pre-populates the workflow when provided.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>useCases</code></p></td><td><div><div><p>List of integration use cases, for example, <code>Sync customer data</code>. Pre-populates the workflow when provided.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>documentation</code></p></td><td><div><div><p>List of API documentation URLs. Pre-populates the workflow when provided.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request (generate spec flow)

```json
{
  "name": "uc_create_connector_workflow",
  "arguments": {
    "flow": "generate-spec",
    "workflowCustomization": "I want to create a connector for Salesforce CRM with focus on lead and opportunity management. Include authentication setup and error handling best practices."
  }
}
```

Example request (existing spec flow)

```json
{
  "name": "uc_create_connector_workflow",
  "arguments": {
    "flow": "existing-spec",
    "existingApiSpec": "/Users/developer/apis/salesforce-leads-api.yaml",
    "workflowCustomization": "Use this Salesforce API spec to generate a connector with enhanced lead management capabilities."
  }
}
```

Example response

```json
{
  "success": true,
  "flow": "generate-spec",
  "workflowPlan": [
    {
      "step": 1,
      "title": "Gather API Documentation",
      "description": "Collect official API documentation URLs and identify key use cases",
      "tool": "uc_manage_api_spec",
      "estimatedTime": "5-10 minutes"
    },
    {
      "step": 2,
      "title": "Generate API Specification",
      "description": "Create OpenAPI 3.0 specification from documentation and use cases",
      "tool": "uc_manage_api_spec",
      "estimatedTime": "10-15 minutes"
    },
    {
      "step": 3,
      "title": "Generate Connector Project",
      "description": "Create LinkWeave connector project with CCM and Anypoint phases",
      "tool": "uc_generate_connector",
      "estimatedTime": "15-20 minutes"
    },
    {
      "step": 4,
      "title": "Test and Validate",
      "description": "Test connector functionality and validate against use cases",
      "tool": "test_connection",
      "estimatedTime": "10-15 minutes"
    }
  ],
  "totalEstimatedTime": "40-60 minutes",
  "nextSteps": "Begin with step 1 by providing the platform name, use cases, and documentation URLs to the uc_manage_api_spec tool.",
  "customizations": [
    "Focus on lead and opportunity management endpoints",
    "Include OAuth 2.0 authentication configuration",
    "Implement comprehensive error handling",
    "Add retry logic for rate limiting"
  ]
}
```

## uc\_generate\_connector

Generate a complete LinkWeave connector from an API spec. Supports flexible multi-phase generation
including scaffolding, CCM (Canonical Connectivity Model), Anypoint Connector, and Flow Connector.
All endpoints from the API spec are used. Can execute phases individually or in combination.

Available only in Connector Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>apiSpec</code></p></td><td><div><div><p>Absolute path to the API spec file (OpenAPI/Swagger YAML or JSON).</p></div></div></td><td><p>No</p><p>Required for <code>ccm</code> phase.</p></td></tr><tr><td><p><code>projectName</code></p></td><td><div><div><p>Name for the connector project.</p></div></div></td><td><p>No</p><p>Required for <code>ccm</code> phase.</p></td></tr><tr><td><p><code>description</code></p></td><td><div><div><p>Description for the connector project.</p></div></div></td><td><p>No</p><p>Required for <code>ccm</code> phase.</p></td></tr><tr><td><p><code>phases</code></p></td><td><div><div><p>Array of phases to execute - any combination of <code>ccm</code>, <code>anypoint</code>, and <code>flow</code>. Phases execute in order. Valid values are:</p></div><div><ul><li><p><code>ccm</code> for Canonical Connectivity Model</p></li><li><p><code>anypoint</code> for Anypoint Connector module</p></li><li><p><code>flow</code> for Flow Connector module</p></li></ul></div></div></td><td><p>No</p></td></tr><tr><td><p><code>projectRootPath</code></p></td><td><div><div><p>Absolute path to the directory where the connector project should be created (for the <code>ccm</code> phase) or found (for the <code>anypoint</code> or <code>flow</code> phases). Defaults to the workspace root folder.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "uc_generate_connector",
  "arguments": {
    "apiSpec": "/Users/developer/apis/salesforce-api.yaml",
    "projectName": "Salesforce Integration Connector",
    "description": "Custom connector for Salesforce CRM integration with enhanced features.",
    "phases": ["ccm", "anypoint", "flow"]
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Connector generated successfully.",
  "projectPath": "/Users/you/workspace/stripe-connector",
  "phasesExecuted": ["ccm", "anypoint", "flow"]
}
```

## uc\_generate\_tests

Generate tests for connector modules. Each requested module is configured to use either a mock
connection (no auth) or a real connection (requires a `profileId`). At least one module must be
included. Always call `uc_get_test_generation_info` first to determine which modules are available
and whether tests already exist.

Available only in Connector Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>modulesConfig</code></p></td><td><div><div><p>Array of modules to test. Skipped modules are omitted from this array. At least one module is required.</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>modulesConfig[].moduleType</code></p></td><td><div><div><p>Module type to test. Valid values are:</p></div><div><ul><li><p><code>CCM</code> for the connectivity model</p></li><li><p><code>ACM</code> for the Anypoint Connector module</p></li><li><p><code>FCM</code> for the Flow Connector module</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>modulesConfig[].useMock</code></p></td><td><div><div><p>Whether to use a mock connection. Set to <code>true</code> for a mock connection (no auth required) or <code>false</code> for a real backend connection (requires <code>profileId</code>).</p></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>profileId</code></p></td><td><div><div><p>Connection profile ID returned by <code>uc_list_connection_profiles</code>.</p></div></div></td><td><p>Required when any module has <code>useMock=false</code>.</p></td></tr><tr><td><p><code>forceOverwrite</code></p></td><td><div><div><p>Whether to overwrite existing test files. Set to <code>true</code> only after the user explicitly confirms overwriting. Defaults to <code>false</code>.</p></div></div></td><td><p>Required when existing tests are present.</p></td></tr></tbody></table>

Example request

```json
{
  "name": "uc_generate_tests",
  "arguments": {
    "modulesConfig": [
      { "moduleType": "CCM", "useMock": true },
      { "moduleType": "ACM", "useMock": false }
    ],
    "profileId": "dev-stripe",
    "forceOverwrite": false
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Tests generated for CCM and ACM modules."
}
```

## uc\_get\_test\_generation\_info

Get information before generating tests. Returns the list of available connector modules (CCM, ACM,
FCM) and reports whether tests already exist for each. Always call this tool before
`uc_generate_tests` so you can determine which modules to test and whether existing test files would
be overwritten.

Available only in Connector Builder.

This tool takes no parameters.

Example request

```json
{
  "name": "uc_get_test_generation_info",
  "arguments": {}
}
```

Example response

```json
{
  "availableModules": ["CCM", "ACM", "FCM"],
  "testsExist": false
}
```

## uc\_list\_connection\_profiles

List all available connection profiles with their IDs, names, authentication types, and
descriptions. Use this tool to discover which profiles are available for executing operations or
generating tests against a real backend. The profile ID returned by this tool is required for the
`execute` type in `uc_manage_operations` and for real-connection test generation in
`uc_generate_tests`.

Available only in Connector Builder.

This tool takes no parameters.

Example request

```json
{
  "name": "uc_list_connection_profiles",
  "arguments": {}
}
```

Example response

```json
{
  "profiles": [
    {
      "id": "dev-stripe",
      "name": "Stripe Developer",
      "authenticationType": "BEARER",
      "description": "Stripe API developer credentials"
    }
  ]
}
```

## uc\_manage\_api\_spec

Manage API spec operations. Use `type='generate'` (default) to perform API research and produce both
an `api-reference.md` artifact and a complete OpenAPI 3.0 YAML spec. Use `type='research'` to
perform API research only, producing a comprehensive `api-reference.md` with entity dependency
graphs, CRUD endpoint catalogs, and field-level detail. Use `type='validate'` to validate an
existing OpenAPI spec against a live API by executing real HTTP requests, comparing responses
against expected schemas, auto-fixing mismatches, and generating a validation report. If no
parameters are used, the agent prompts for input.

Available only in Connector Builder.

> [!NOTE] This tool was previously named `uc_generate_api_spec`. The renamed tool also supports the
> `research` and `validate` modes.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>type</code></p></td><td><div><div><p>Type of operation. Valid values are:</p></div><div><ul><li><p><code>generate</code> (default): Performs API research and generates an OpenAPI YAML spec.</p></li><li><p><code>research</code>: Performs API research only and produces an <code>api-reference.md</code> artifact.</p></li><li><p><code>validate</code>: Validates an OpenAPI spec against a live API and generates a validation report.</p></li></ul></div></div></td><td><p>No</p></td></tr><tr><td><p><code>platform</code></p></td><td><div><div><p>Name of the SaaS platform or service, for example, <code>Salesforce</code>, <code>ServiceNow</code>, <code>PayPal</code>, or <code>Stripe</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>useCases</code></p></td><td><div><div><p>List of integration use cases, ordered by priority. Each use case describes a specific integration scenario, for example, <code>Sync customer data</code> or <code>Process invoices</code>. If specified, a minimum of one is required.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>documentation</code></p></td><td><div><div><p>List of official API documentation URLs. Must be valid URLs starting with <code>http://</code> or <code>https://</code>, for example, <code>https://developers.stripe.com/api</code>. If specified, a minimum of one is required.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>additionalRequirements</code></p></td><td><div><div><p>Any additional requirements, constraints, or preferences for the API spec, for example, specific authentication methods, rate limiting considerations, and version preferences.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>mode</code></p></td><td><div><div><p>Execution mode. Valid values are:</p></div><div><ul><li><p><code>standard</code> (default): Runs interactively.</p></li><li><p><code>connectorless</code>: Runs autonomously with minimal user interaction.</p></li></ul></div></div></td><td><p>No</p></td></tr><tr><td><p><code>specPath</code></p></td><td><div><div><p>Path to the OpenAPI YAML spec file to validate. Used when <code>type='validate'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>apiReferencePath</code></p></td><td><div><div><p>Path to the <code>api-reference.md</code> file containing entity details, dependency graphs, and request/response schemas. Used when <code>type='validate'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>baseUrl</code></p></td><td><div><div><p>API base URL override. If not provided, extracted from the OpenAPI spec or <code>api-reference.md</code>. Used when <code>type='validate'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>authHeader</code></p></td><td><div><div><p>Authorization header value, for example, <code>Bearer &lt;token&gt;</code>. If not provided, the tool prompts for credentials. Used when <code>type='validate'</code>.</p></div></div></td><td><p>No</p></td></tr><tr><td><p><code>operationFilter</code></p></td><td><div><div><p>List of specific operation IDs to validate. If empty, validates all operations. Used when <code>type='validate'</code>.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "uc_manage_api_spec",
  "arguments": {
    "type": "generate",
    "platform": "Stripe",
    "useCases": ["Sync customers into our CRM", "Create a charge and issue a refund"],
    "documentation": [
      "https://docs.stripe.com/api",
      "https://docs.stripe.com/api/customers",
      "https://docs.stripe.com/api/charges",
      "https://docs.stripe.com/api/refunds"
    ],
    "additionalRequirements": "OpenAPI 3.0 YAML. Use bearer token auth (Authorization: Bearer <apiKey>). Include common error responses (400/401/403/404/409/429/500). Model pagination where applicable."
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Generated api-reference.md and OpenAPI 3.0 spec from documentation and use cases.",
  "platform": "Stripe",
  "apiReferencePath": "/Users/you/workspace/stripe-spec/api-reference.md",
  "openApiYamlPath": "/Users/you/workspace/stripe-spec/openapi.yaml"
}
```

## uc\_manage\_operations

Manage connector operations. Use `type='list'` to enumerate available operations, `type='get'` to
retrieve one operation’s input and output schemas, or `type='execute'` to run an operation against a
connection profile. To execute an operation, first call `uc_list_connection_profiles` to retrieve a
profile ID.

Available only in Connector Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>type</code></p></td><td><div><div><p>Action to perform. Valid values are:</p></div><div><ul><li><p><code>list</code> to list all operations</p></li><li><p><code>get</code> to get details for one operation</p></li><li><p><code>execute</code> to run an operation with a connection profile</p></li></ul></div></div></td><td><p>Yes</p></td></tr><tr><td><p><code>operationName</code></p></td><td><div><div><p>Operation name or ID.</p></div></div></td><td><p>Required when <code>type='get'</code> or <code>type='execute'</code>.</p></td></tr><tr><td><p><code>profileId</code></p></td><td><div><div><p>Connection profile ID returned by <code>uc_list_connection_profiles</code>.</p></div></div></td><td><p>Required when <code>type='execute'</code>.</p></td></tr><tr><td><p><code>input</code></p></td><td><div><div><p>Operation input parameters as a JSON object. Use <code>type='get'</code> first to discover the expected schema.</p></div></div></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "uc_manage_operations",
  "arguments": {
    "type": "execute",
    "operationName": "getCustomer",
    "profileId": "dev-stripe",
    "input": { "id": "cus_123" }
  }
}
```

Example response

```json
{
  "success": true,
  "response": {
    "id": "cus_123",
    "name": "Acme Corp",
    "email": "billing@acme.example"
  }
}
```

## update\_mule\_application

Update a Mule application deployed to CloudHub 2.0 or Runtime Fabric. Update runtime version,
configuration, and other application settings.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>applicationId</code></p></td><td><p>The ID of the application to update with the latest Mule runtime patch release.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>environmentId</code></p></td><td><p>The ID of the environment where the application is deployed.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organizationId</code></p></td><td><p>The ID of the organization where the application is deployed.</p></td><td><p>No</p></td></tr><tr><td><p><code>runtimeVersion</code></p></td><td><p>Mule runtime version to use. For example, <code>4.9.4:2e-java17</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>hasPersistentObjectStore</code></p></td><td><p>Whether to enable persistent object store. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>replicaSize</code></p></td><td><p>Replica size for CloudHub 2.0 applications. Express size in vCores or instance type size.</p></td><td><p>No</p></td></tr><tr><td><p><code>cpuReserved</code></p></td><td><p>Reserved vCPUs for the application. For example, 1.</p></td><td><p>No</p></td></tr><tr><td><p><code>cpuLimit</code></p></td><td><p>Maximum vCPUs for the application. For example, 2.</p></td><td><p>No</p></td></tr><tr><td><p><code>memory</code></p></td><td><p>Memory allocation for the allocation in GB. For example, 1.</p></td><td><p>No</p></td></tr><tr><td><p><code>replicas</code></p></td><td><p>Number of replicas.</p></td><td><p>No</p></td></tr><tr><td><p><code>minReplicas</code></p></td><td><p>If <code>hasHighAvailability=true</code> or <code>hasPerformanceOptimization=true</code>, this value is the minimum number of replicas.</p></td><td><p>No</p></td></tr><tr><td><p><code>maxReplicas</code></p></td><td><p>If <code>hasHighAvailability=true</code> or <code>hasPerformanceOptimization=true</code>, this value is the maximum number of replicas.</p></td><td><p>No</p></td></tr><tr><td><p><code>hasAutoscaling</code></p></td><td><p>Whether to enable autoscaling. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>hasTracing</code></p></td><td><p>Whether to enable application tracing. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>enforceDeployingReplicasAcrossNodes</code></p></td><td><p>Whether to enforce deploying replicas across nodes (Runtime Fabric only). The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>deploymentModel</code></p></td><td><p>The deployment strategy for application updates. Use <code>rolling</code> for zero-downtime rolling updates or <code>recreate</code> to stop and restart all instances.</p></td><td><p>No</p></td></tr><tr><td><p><code>hasClustering</code></p></td><td><p>Whether to enable clustering for the application. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>stopApplication</code></p></td><td><p>Whether to stop the application. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>startApplication</code></p></td><td><p>Whether to start the application. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>hasHighAvailability</code></p></td><td><p>Whether to enable high availability for the application. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>hasPerformanceOptimization</code></p></td><td><p>Whether to enable performance optimization. The default is false.</p></td><td><p>No</p></td></tr><tr><td><p><code>isSecure</code></p></td><td><p>Whether to enable advanced security features. The default is false.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "update_mule_application",
  "arguments": {
    "applicationId": "3f2d8b1a-0f2e-4f6c-9e44-6f3b2c1a9c10",
    "environmentId": "b7c9f6f2-1f8d-4c2e-a7b0-3d6c9a1b2e34",
    "runtimeVersion": "4.9.4:2e-java17",
    "replicaSize": "0.5",
    "replicas": 2,
    "hasAutoscaling": true,
    "minReplicas": 2,
    "maxReplicas": 4,
    "hasTracing": true,
    "deploymentModel": "rolling"
  }
}
```

Example response

```json
{
  "success": true,
  "message": "Application update initiated.",
  "applicationId": "3f2d8b1a-0f2e-4f6c-9e44-6f3b2c1a9c10",
  "environmentId": "b7c9f6f2-1f8d-4c2e-a7b0-3d6c9a1b2e34",
  "deploymentModel": "rolling",
  "status": "updating"
}
```

## validate\_api\_against\_ruleset

Validate an API specification in your project against governance rulesets or rules that you specify.
If you specify all rulesets, the tool uses an empty `rules` parameter to validate all rulesets.
Similarly, if you specify no ruleset, the tool uses an empty `rules` parameter. To find rules or
rulesets that you specify, this tool calls the `list_governance_rulesets` tool.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path where the project folder is located. The default is the current workspace. For absolute paths, use <code>file:</code> followed by three slash characters.</p></td><td><p>No</p></td></tr><tr><td><p><code>rules</code></p></td><td><p>Array of API rules to validate. If empty, the tool validates all rulesets in <code>projectPath</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>syncCentralizedRulesets</code></p></td><td><p>Whether the tool syncs centralized rulesets before validating the API specification. The default value is true.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (validate all rulesets)

```json
{
  "name": "validate_api_against_ruleset",
  "arguments": {
    "projectPath": "/Users/developer/projects/pet-store-api",
    "rules": [],
    "syncCentralizedRulesets": true
  }
}
```

Example request (validate specific rules)

```json
{
  "name": "validate_api_against_ruleset",
  "arguments": {
    "projectPath": "/Users/developer/projects/pet-store-api",
    "rules": [
      {
        "name": "api-title-required",
        "rulePath": "/Users/developer/.mule/rulesets/api-governance-ruleset/rules/api-title-required.js"
      },
      {
        "name": "api-version-required",
        "rulePath": "/Users/developer/.mule/rulesets/api-governance-ruleset/rules/api-version-required.js"
      }
    ],
    "syncCentralizedRulesets": true
  }
}
```

Example response

```json
{
  "validationResults": {
    "totalRules": 2,
    "passed": 1,
    "failed": 1,
    "warnings": 0
  },
  "results": [
    {
      "ruleName": "api-title-required",
      "status": "passed",
      "message": "API title is present"
    },
    {
      "ruleName": "api-version-required",
      "status": "failed",
      "message": "API version is missing",
      "severity": "error",
      "location": {
        "file": "pet-store-api.yaml",
        "line": 2,
        "column": 5
      }
    }
  ],
  "summary": "Validation completed with 1 error"
}
```

## validate\_project

Validate the current project. For example, an API spec or an agent network project. This tool
doesn’t validate against API Governance rulesets. To validate against those rulesets, use the
`validate_api_against_ruleset` tool.

Available only in Anypoint Code Builder.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td><p><code>projectPath</code></p></td><td><p>Path where the project folder is located. The default is the current workspace. For absolute paths, use <code>file:</code> followed by three slash characters, for example, <code>file:///Users/myUser/workspace/</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "validate_project",
  "arguments": {
    "projectPath": "/Users/developer/projects/pet-store-api"
  }
}
```

Example response

```json
{
  "success": true,
  "projectType": "api-spec",
  "validationResults": {
    "syntaxValid": true,
    "structureValid": true,
    "errors": [],
    "warnings": [
      {
        "message": "Missing description for endpoint /pets",
        "location": {
          "file": "pet-store-api.yaml",
          "line": 15
        }
      }
    ]
  },
  "message": "Project validation completed successfully"
}
```

## See Also

- [Using MuleSoft DX MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/using-mulesoft-mcp-server)

<!-- document id=9511539665a16c2d53cbbc6bba1d4ed4afc46f17bb8dd6e3c85a0861f5b4693b url=/mulesoft/current/en-us/mulesoft-mcp-server/index.md -->

---
product: MuleSoft MCP Servers
---

# MuleSoft MCP Servers Overview

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft MCP Servers implement the Model Context Protocol (MCP) so AI assistants in your IDE can
work with MuleSoft products and services. MuleSoft DX MCP Server supports API design, application
deployment, and asset management. MuleSoft Platform MCP Server supports service discovery, policy
enforcement, and traffic monitoring across your organization.

## MuleSoft DX MCP Server

MuleSoft DX MCP Server provides structured, permission-scoped access to Anypoint Platform from AI
assistants in your IDE to help you design, build, publish, deploy, and secure MuleSoft assets by
turning natural-language goals into production-ready actions.

Typical lifecycle areas you address with MuleSoft DX MCP Server include:

- API specification development

- Application creation and configuration

- Agent network creation

- Asset publication in Exchange

- Instance deployment and management to CloudHub 2.0 and Runtime Fabric

- Application security

For more information, see [Getting Started with MuleSoft DX MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started).

## MuleSoft Platform MCP Server

MuleSoft Platform MCP Server provides governed access to your entire IT landscape, including APIs,
agents, MCP servers, and LLMs, to accelerate production-ready AI at scale. It helps you scan,
discover, govern, and monitor services across the infrastructure you already run.

Typical platform areas you address with MuleSoft Platform MCP Server include:

- Service scanning across agentic platforms

- Discovery of APIs, agents, MCP servers, and LLMs in one place

- Policy enforcement for PII detection, semantic routing, and token controls

- Monitoring of traffic, cost, and performance across services

For more information, see
[Getting Started with MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started-platform).

<!-- document id=0d734ddfa4a6efd9733dd74c82d4b78e5c414b33d47b3810da9a45136c0dfc97 url=/mulesoft/current/en-us/mulesoft-mcp-server/mulesoft-mcp-server-release-notes.md -->

---
product: MuleSoft MCP Servers
---

# MuleSoft MCP Servers Release Notes

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft MCP Servers implement the Model Context Protocol (MCP) so AI assistants in your IDE can
work with MuleSoft products and services. MuleSoft DX MCP Server supports API design, application
deployment, and asset management. MuleSoft Platform MCP Server supports service discovery, policy
enforcement, and traffic monitoring across your organization.

## October 14, 2026

### What’s New

The following new tools and updates are available in MuleSoft Platform MCP Server.

- Policy Management

  - New tool: `apply_universal_policy`. Apply a canonical policy to one or more API instances across
    supported gateway providers.

  - New tool: `edit_applied_policy`. Edit the configuration of an applied policy on an API instance.

  - New tool: `get_policy_operation_status`. Check the status of an asynchronous policy operation.

  - New tool: `list_instance_policy_operations`. List asynchronous policy operations for an external
    gateway API instance.

  - New tool: `list_universal_policies`. List the canonical policy templates available to an
    organization.

  - New tool: `remove_applied_policy`. Permanently remove an applied policy from a MuleSoft or
    external gateway API instance.

  - New tool: `toggle_applied_policy`. Enable or disable an applied policy on a MuleSoft or external
    gateway API instance.

  - Tool update: `apply_policy_to_instance`, `get_policy_template_form`, and
    `prepare_policy_creation` now support policy management for external gateway providers.

For tool parameter details, see
[MuleSoft Platform MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform).

## August 31, 2026

### What’s New

The following new tools and updates are available in MuleSoft Platform MCP Server.

- Search and Discovery

  - New tool: `get_asset_lineage`. Get instance-rooted lineage, including design-time and runtime
    relationships, for an agent, MCP server, or API from the Context Catalog.

  - New tool: `get_data_asset_classification`. Get a data asset’s source-to-column hierarchy,
    classifications, descriptions, glossary terms, and PII state.

- Cost Management

  - New tool: `create_model_wallet`. Create a model wallet with budget allocation for a specific LLM
    model.

  - New tool: `delete_model_wallet`. Delete a model wallet.

  - New tool: `edit_model_wallet`. Edit an existing model wallet configuration.

  - New tool: `fetch_model_wallet_details`. Fetch model wallet details for a given wallet ID and
    environment.

  - New tool: `fetch_model_wallets`. Fetch the list of model wallets for an environment.

  - Tool update: `fetch_cost_instances`, `fetch_cost_instance_timeseries`,
    `fetch_cost_optimization_recommendations`, and `fetch_cost_overview`.

- Secrets Management

  - New tool: `check_secret`. Verify that a secret exists and retrieve its non-sensitive metadata
    without exposing secret material.

  - New tool: `describe_vault_auth_schema`. Discover supported vault providers and the credential
    fields required to onboard or edit a vault integration.

  - New tool: `edit_integration`. Modify an existing vault integration’s configuration with
    automatic credential validation and connectivity testing.

  - New tool: `list_integration_secrets`. List all secret references discovered by a specific vault
    integration.

  - New tool: `onboard_vault`. Register a new external vault provider integration with credential
    validation and live connectivity testing.

  - New tool: `search_secrets`. Search for secrets by name across all secret groups in an
    environment.

  - New tool: `test_integration_connection`. Validate vault connectivity and credential permissions
    before or after creating an integration.

For tool parameter details, see
[MuleSoft Platform MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform).

## June 2, 2026

### What’s New

- New tool: `uc_get_test_generation_info`. Get information about which connector modules (CCM, ACM,
  FCM) are available and whether tests already exist before generating tests.

- New tool: `uc_generate_tests`. Generate tests for connector modules using either mock or real
  connections.

- Tool rename: `uc_generate_api_spec` is renamed to `uc_manage_api_spec`. The renamed tool also
  supports research-only and validation modes.

- Tool rename: `uc_publish_connector` is renamed to `uc_connector_lifecycle`. The renamed tool
  supports both `build` and `publish` actions.

- Tool update: `uc_generate_connector`. The `phases` parameter now accepts `flow` to generate a Flow
  Connector module in addition to the existing `ccm` and `anypoint` phases.

For tool parameter details, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## May 28, 2026

### What’s New

- Introducing MuleSoft Platform MCP Server

  Get governed access to your entire IT landscape, including APIs, agents, MCP servers, and LLMs,
  and accelerate production-ready AI at scale. With remote access, use MuleSoft Platform MCP Server
  to scan, discover, govern, and monitor services across the infrastructure you already run. Typical
  platform areas you can address include:

  - Service scanning across agentic platforms

  - Discovery of APIs, agents, MCP servers, and LLMs in one place

  - Policy enforcement for PII detection, semantic routing, and token controls

  - Monitoring of traffic, cost, and performance across services

For more information, see
[Getting Started with MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started-platform)

- With the addition of MuleSoft Platform MCP Server, MuleSoft MCP Server is renamed to MuleSoft DX
  MCP Server. This is a non-breaking change and only cosmetically affects the UI and documentation.
  There are no changes to tool names.

## March 16, 2026

### What’s New

- Tool update: `get_flex_gateway_policy_example`. You can now generate examples for these policy
  features.

  - `ip_filter`: Allow or block requests based on IP addresses and CIDR ranges

  - `jwt_generate`: Generate JSON Web Tokens

  - `oauth2_token_introspection`: Validate OAuth2 tokens

  - `rate_limiting`: Allow or block requests based on rate limits

  - `data_storage`: Store and retrieve data using the Data Storage Library

- Installation namespace change: When installing MuleSoft MCP Server in your IDE, the installation
  command is now `npm install -g mulesoft-mcp-server`. Previously, it used `mulesoft/mcp-server`.

## March 6, 2026

### What’s New

- New tool: `uc_add_pagination`. Add pagination support to a specific operation.

- New tool: `uc_list_connection_profiles`. List all available connection profiles with their IDs,
  names, authentication types, and descriptions.

- New tool: `uc_manage_operations`. Manage connector operations.

- New tool: `uc_publish_connector`. Publish a connector to Anypoint Exchange.

For tool parameter details, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## February 17, 2026

Tool update: `search_asset`. Use the new `exchangeScope` parameter to set the search scope for
either private or public assets. Additionally, the `search_asset` tool responses now use
standardized relevance scores.

## February 6, 2026

### What’s New

- Tool update: `implement_api_spec`. Use APIkit flows to implement an API specification in a new
  integration project. You can implement a specification from a local asset or an Anypoint Exchange
  asset.

- New tool: `generate_or_modify_munit_test`. Generate, modify, or fix MUnit tests for Mule flows.
  Provide the flow XML, test scenario description, and dependencies for accurate test generation.
  Previously generating and modifying MUnit tests were different tools.

For tool parameter details, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## January 15, 2026

### What’s New

- New tool: `implement_api_spec`. Use APIkit flows to implement an API specification in a new
  integration project. You can implement a specification from an Anypoint Exchange asset.

- New tool: `generate_munit_test`. Generate MUnit test cases for Mule flows, one test scenario at a
  time, with support for mocks, assertions, and dependencies.

- New tool: `modify_munit_test`. Modify or fix an existing MUnit test case, including updating
  assertions, mocks, payloads, and test logic.

For tool parameter details, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## November 20, 2025

### What’s New

You can now use the MuleSoft MCP Server to build connectors with Connector Builder. These new MCP
tools are available for use in Connector Builder.

- `uc_create_connector_workflow`

- `uc_generate_api_spec`

- `uc_generate_connector`

For more information, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools) and
[Generate Base Connectivity with MCP Tools](https://docs.mulesoft.com/connector-builder/base-connectivity#generate-base-connectivity-with-mcp-tools).

## October 3, 2025

### What’s New

Build Agent Fabric agent networks, manage governance rulesets, and more with new tools. All tools
are available in MuleSoft MCP Server in Anypoint Code Builder; they aren’t available for use in
other IDEs.

- Tools to create, edit, publish, and deploy agent networks for Agent Fabric solutions.

- Tools to list, add, and validate governance rulesets.

- Tools to open, mock, and validate API specs.

- Tool to get metadata and instructions for enabling topics and agent actions from an OpenAI spec.

For more information, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## August 11, 2025

### What’s New

- New tool: `create_and_manage_metadata`. Define metadata for a flow component, attach metadata to
  Mule flow components, and update existing metadata. To define metadata, provide the Mule
  configuration file URI and sample data or schema. To apply metadata, specify existing metadata
  types. To update metadata, provide new schema or sample data.

- New tool: `test_connection`. Test a connector configuration for a Mule project. For example, test
  connectivity for a HTTP listener connection.

For more information, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## July 17, 2025

### What’s New

- App Development

  - New tool: `create_api_spec`. Use AI to create an API specification. You must enable Agentforce
    in [Access Management](https://docs.mulesoft.com/access-management/).

  - New tool: `create_api_spec_project`. Create and scaffold an API specification or fragment
    project. You can specify the project name, location, and language (RAML, OAS, and so on).

  - New tool: `create_MCP_server`. Create a MuleSoft MCP server. This tool uses Anypoint Connector
    for MCP (MCP Connector) to handle requests for creating MCP servers.

  - New tool: `create_mule_project`. Create an integration project.

  - New tool: `generate_mule_flow`. Use AI to create a flow.

  - New tool: `run_local_mule_application`. Deploy and run your app locally.

  - New tool: `search_asset`. Search for an asset in an organization and Anypoint Exchange. Returns
    the first asset in your organization that matches input criteria. If the tool doesn’t find any
    assets in your organization, then the tool returns assets in Anypoint Exchange that exactly or
    partially match `searchQuery`.

- App Management

  - New tool: `create_and_manage_api_instances`. Create and configure API instances in Anypoint API
    Manager.

  - New tool: `list_api_instances`. Get information for instances in an environment. You can also
    filter by an instance ID or label and include applied or available policies. The tool paginates
    results using the page parameter. Prompt tip: To get information for all instances, revise the
    results by using the page parameter.

  - New tool: `list_applications`. Get information about all apps in the environment that you
    specify. You can also specify an optional deployment name. Results are sorted by last update
    date and time, in descending order.

  - New tool: `update_mule_application`. Update a Mule app deployed to CloudHub 2.0 or Anypoint
    Runtime Fabric. Update the runtime version, configuration, and other app settings.

- Policy Management

  - New tool: `manage_api_instance_policy`. Apply a new policy to an API instance and update an
    existing policy configuration.

  - New tool: `manage_flex_gateway_policy_project`. Provide instructions to the LLM on how to manage
    an Anypoint Omni Gateway custom policy project. Instructions include how to create the project,
    set up the configuration, and build the project. The instructions also include how to publish a
    development version of the project and publish a release version of the project. See
    [Prerequisites for Omni Gateway Policy Development Kit (PDK)](https://docs.mulesoft.com/pdk/latest/policies-pdk-prerequisites).

  - New tool: `get_flex_gateway_policy_example`. Get an Anypoint Omni Gateway policy example to help
    you configure your Rust source code. You can get example policies that manipulate a request’s
    header and body, make HTTP calls to external services, share data between requests and
    responses, reject requests, and perform sleep operations.

- Usage and Insights

  - New tool: `get_platform_insights`. See how your organization uses Anypoint Platform through
    operational insights. Insights include:

    - Usage trends for apps, such as flow count, message counts, and data throughput by business
      group and environment. Usage trends are for the current month. If it’s early in the month, you
      get usage for the last full month.

    - API and app call volume across consumers for the last 7 days.

    - API and app performance metrics such as errors and latency for the last 7 days.

  - New tool: `get_reuse_metrics`. Get visibility into how you reuse assets across your
    organization. Drive efficiency, consistency, and cost savings by reducing duplication. Includes
    sandbox and production environments. Metrics are a year-to-date snapshot.

For more information, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools)

## June 3, 2025

### What’s New

- App Development

  - New tool: `create_mule_project`. Create an integration project.

  - New tool: `generate_mule_flow`. Use AI to create a flow.

  - New tool: `run_local_mule_application`. Deploy and run your app locally.

  - New tool: `search_asset`. Find an Anypoint Exchange asset by name or other parameters that you
    specify. Returns the first asset that matches the input criteria.

  - New tool: `create_and_manage_assets`. Create an asset in Anypoint Exchange, update some Anypoint
    Exchange asset properties without republishing the asset, and delete an asset in Anypoint
    Exchange. Asset properties are the asset name, description, icon, contact name, and contact
    email.

- App Management

  - New tool: `deploy_mule_application`. Deploy your app to CloudHub 2.0 or Anypoint Runtime Fabric
    and run it. You can deploy from a local project or Anypoint Exchange asset. This tool supports
    security, high availability, and performance optimizations for deployments.

  - New tool: `list_applications`. Get information about all apps in the environment that you
    specify. You can also specify an optional deployment name. Results are sorted by last update
    date and time, in descending order.

For more information, see [MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools)

## See Also

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=eb9c66c8bfe1e03febfbb94fb0c411761e2c76f978f23db9bdb410c1ef0d07fa url=/mulesoft/current/en-us/mulesoft-mcp-server/reference-mcp-tools-platform.md -->

---
product: MuleSoft MCP Servers
---

# MuleSoft Platform MCP Server Tool Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft Platform MCP Server exposes tools for managing APIs, agents, LLMs, MCP servers, governance
strategies, policies, gateways, observability, and cost optimization across Anypoint Platform. Each
tool accepts specific input parameters so assistants can search the portfolio, inspect resources,
and apply changes on your behalf. Use these tools from your IDE or another MCP client to automate
platform administration and surface operational insight.

See [Get Started with MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started-platform) for setup and
authentication, including the Connected App scopes that map to each permission tier.

## Command Summary

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Category</th><th>Tool</th><th>Required Permission Scopes</th></tr></thead><tbody><tr><td rowspan="2"><p><strong>Authentication</strong></p></td><td><p><a href="#login">login</a></p></td><td><p>None</p></td></tr><tr><td><p><a href="#logout">logout</a></p></td><td><p>None</p></td></tr><tr><td rowspan="5"><p><strong>Business Group &amp; Org</strong></p></td><td><p><a href="#get-business-group">get_business_group</a></p></td><td><p>read:organization</p></td></tr><tr><td><p><a href="#list-business-groups">list_business_groups</a></p></td><td><p>read:organization</p></td></tr><tr><td><p><a href="#select-active-business-group">select_active_business_group</a></p></td><td><p>read:organization</p></td></tr><tr><td><p><a href="#select-active-environment">select_active_environment</a></p></td><td><p>read:organization</p></td></tr><tr><td><p><a href="#select-active-provider">select_active_provider</a></p></td><td><p>read:organization</p></td></tr><tr><td rowspan="8"><p><strong>API Management</strong></p></td><td><p><a href="#list-apis">list_apis</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#select-api-version">select_api_version</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#list-provider-gateways">list_provider_gateways</a></p></td><td><p>read:organization, read:managedgateways</p></td></tr><tr><td><p><a href="#view-api-instance-details">view_api_instance_details</a></p></td><td><p>read:exchange, read:api_configuration</p></td></tr><tr><td><p><a href="#view-api-instance-monitoring">view_api_instance_monitoring</a></p></td><td><p>view:monitoring, read:api_configuration</p></td></tr><tr><td><p><a href="#view-api-instance-policies">view_api_instance_policies</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#view-api-version-details">view_api_version_details</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#view-api-version-instances">view_api_version_instances</a></p></td><td><p>read:exchange, read:api_configuration</p></td></tr><tr><td rowspan="15"><p><strong>Policy Management</strong></p></td><td><p><a href="#apply-policy-to-instance">apply_policy_to_instance</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies, manage:api_policies</p></td></tr><tr><td><p><a href="#apply-universal-policy">apply_universal_policy</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies, manage:api_policies</p></td></tr><tr><td><p><a href="#create-automated-policy-strategy">create_automated_policy_strategy</a></p></td><td><p>read:api_configuration, read:api_policies, manage:api_policies, read:exchange</p></td></tr><tr><td><p><a href="#delete-automated-policy-strategy">delete_automated_policy_strategy</a></p></td><td><p>read:api_configuration, read:api_policies, manage:api_policies, read:exchange</p></td></tr><tr><td><p><a href="#edit-applied-policy">edit_applied_policy</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies, manage:api_policies</p></td></tr><tr><td><p><a href="#fetch-automated-policy-template">fetch_automated_policy_template</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#get-policy-operation-status">get_policy_operation_status</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#get-policy-template-form">get_policy_template_form</a></p></td><td><p>read:exchange, read:api_policies</p></td></tr><tr><td><p><a href="#list-governance-strategies">list_governance_strategies</a></p></td><td><p>view:ang_governance_profiles, read:exchange, read:api_policies</p></td></tr><tr><td><p><a href="#list-instance-policy-operations">list_instance_policy_operations</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#list-universal-policies">list_universal_policies</a></p></td><td><p>read:exchange, read:api_policies</p></td></tr><tr><td><p><a href="#prepare-automated-policy-creation">prepare_automated_policy_creation</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#prepare-policy-creation">prepare_policy_creation</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#remove-applied-policy">remove_applied_policy</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies, manage:api_policies</p></td></tr><tr><td><p><a href="#toggle-applied-policy">toggle_applied_policy</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies, manage:api_policies</p></td></tr><tr><td rowspan="10"><p><strong>Governance</strong></p></td><td><p><a href="#check-guardrail-scope-targets">check_guardrail_scope_targets</a></p></td><td><p>read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#check-policy-conformance">check_policy_conformance</a></p></td><td><p>read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#create-guardrail">create_guardrail</a></p></td><td><p>admin:ang_governance_profiles</p></td></tr><tr><td><p><a href="#delete-governance-strategy">delete_governance_strategy</a></p></td><td><p>admin:ang_governance_profiles, manage:exchange (when deleting customized ruleset asset versions)</p></td></tr><tr><td><p><a href="#fetch-governance-service-report">fetch_governance_service_report</a></p></td><td><p>None</p></td></tr><tr><td><p><a href="#fetch-governance-services">fetch_governance_services</a></p></td><td><p>None</p></td></tr><tr><td><p><a href="#fetch-guardrail-ruleset">fetch_guardrail_ruleset</a></p></td><td><p>read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#prepare-guardrail-creation">prepare_guardrail_creation</a></p></td><td><p>read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#view-api-version-governance-report">view_api_version_governance_report</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#view-governance-report">view_governance_report</a></p></td><td><p>None</p></td></tr><tr><td rowspan="4"><p><strong>Monitoring &amp; Observability</strong></p></td><td><p><a href="#fetch-monitoring-drill-down">fetch_monitoring_drill_down</a></p></td><td><p>view:monitoring, read:api_configuration; read:applications, read:servers (when querying those resource types)</p></td></tr><tr><td><p><a href="#fetch-monitoring-instance">fetch_monitoring_instance</a></p></td><td><p>view:monitoring, read:api_configuration; read:applications, read:servers (when querying those resource types)</p></td></tr><tr><td><p><a href="#fetch-monitoring-overview">fetch_monitoring_overview</a></p></td><td><p>view:monitoring, read:api_configuration; read:applications, read:servers (when querying those resource types)</p></td></tr><tr><td><p><a href="#show-observability-performance">show_observability_performance</a></p></td><td><p>view:monitoring, read:api_configuration; read:applications, read:servers (when querying those resource types)</p></td></tr><tr><td rowspan="9"><p><strong>Search &amp; Discovery</strong></p></td><td><p><a href="#fetch-service-facets">fetch_service_facets</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#fetch-services">fetch_services</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#get-asset-lineage">get_asset_lineage</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#get-data-asset-classification">get_data_asset_classification</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#search-assets-semantic">search_assets_semantic</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#search-global-assets">search_global_assets</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#search-global-content">search_global_content</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#search-portfolio-services">search_portfolio_services</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#search-repository-knowledge">search_repository_knowledge</a></p></td><td><p>None</p></td></tr><tr><td rowspan="8"><p><strong>MCP Servers</strong></p></td><td><p><a href="#get-mcp-server-state">get_mcp_server_state</a></p></td><td><p>read:exchange, read:api_configuration</p></td></tr><tr><td><p><a href="#get-provision-status">get_provision_status</a></p></td><td><p>None</p></td></tr><tr><td><p><a href="#get-trusted-mcp-catalog">get_trusted_mcp_catalog</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#list-mcp-servers">list_mcp_servers</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#provision-mcp-server">provision_mcp_server</a></p></td><td><p>edit:exchange, read:organization, view:access_controls, manage:api_configuration, manage:api_policies, read:servers, manage:api_proxies</p></td></tr><tr><td><p><a href="#resume-provision-job">resume_provision_job</a></p></td><td><p>edit:exchange</p></td></tr><tr><td><p><a href="#update-mcp-server">update_mcp_server</a></p></td><td><p>edit:exchange, read:organization, view:access_controls, manage:api_configuration, manage:api_policies, read:servers, manage:api_proxies</p></td></tr><tr><td><p><a href="#view-mcp-server-details">view_mcp_server_details</a></p></td><td><p>read:exchange, read:api_configuration</p></td></tr><tr><td rowspan="2"><p><strong>Agents</strong></p></td><td><p><a href="#list-agents">list_agents</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#view-agent-details">view_agent_details</a></p></td><td><p>read:exchange, read:api_configuration (when enriching deployed API-instance details)</p></td></tr><tr><td rowspan="2"><p><strong>LLMs</strong></p></td><td><p><a href="#list-llms">list_llms</a></p></td><td><p>read:exchange</p></td></tr><tr><td><p><a href="#view-llm-details">view_llm_details</a></p></td><td><p>read:exchange, read:api_configuration</p></td></tr><tr><td rowspan="9"><p><strong>Cost Management</strong></p></td><td><p><a href="#create-model-wallet">create_model_wallet</a></p></td><td><p>create:apis, read:api_configuration, manage:api_configuration, manage:api_policies</p></td></tr><tr><td><p><a href="#delete-model-wallet">delete_model_wallet</a></p></td><td><p>create:apis, read:api_configuration, manage:api_configuration, manage:api_policies</p></td></tr><tr><td><p><a href="#edit-model-wallet">edit_model_wallet</a></p></td><td><p>create:apis, read:api_configuration, manage:api_configuration, manage:api_policies</p></td></tr><tr><td><p><a href="#fetch-model-wallet-details">fetch_model_wallet_details</a></p></td><td><p>create:apis, read:api_configuration, manage:api_configuration, manage:api_policies</p></td></tr><tr><td><p><a href="#fetch-model-wallets">fetch_model_wallets</a></p></td><td><p>create:apis, read:api_configuration, manage:api_configuration, manage:api_policies</p></td></tr><tr><td><p><a href="#fetch-cost-instance-timeseries">fetch_cost_instance_timeseries</a></p></td><td><p>view:monitoring, read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#fetch-cost-instances">fetch_cost_instances</a></p></td><td><p>view:monitoring, read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#fetch-cost-optimization-recommendations">fetch_cost_optimization_recommendations</a></p></td><td><p>view:monitoring, read:exchange, read:api_configuration, read:api_policies</p></td></tr><tr><td><p><a href="#fetch-cost-overview">fetch_cost_overview</a></p></td><td><p>view:monitoring, read:api_configuration</p></td></tr><tr><td rowspan="5"><p><strong>Omni Gateway</strong></p></td><td><p><a href="#create-omni-gateway">create_omni_gateway</a></p></td><td><p>read:organization, read:managedgateways, manage:managedgateways</p></td></tr><tr><td><p><a href="#get-omni-gateway-target-domains">get_omni_gateway_target_domains</a></p></td><td><p>None</p></td></tr><tr><td><p><a href="#get-omni-gateway-usage-report">get_omni_gateway_usage_report</a></p></td><td><p>read:organization, read:managedgateways</p></td></tr><tr><td><p><a href="#list-omni-gateway-environments">list_omni_gateway_environments</a></p></td><td><p>read:organization</p></td></tr><tr><td><p><a href="#list-omni-gateway-targets">list_omni_gateway_targets</a></p></td><td><p>read:organization, read:managedgateways</p></td></tr><tr><td rowspan="3"><p><strong>Scanners</strong></p></td><td><p><a href="#create-scanner">create_scanner</a></p></td><td><p>manage:exchange</p></td></tr><tr><td><p><a href="#list-scanner-providers">list_scanner_providers</a></p></td><td><p>manage:exchange</p></td></tr><tr><td><p><a href="#test-scanner-connection">test_scanner_connection</a></p></td><td><p>manage:exchange</p></td></tr><tr><td rowspan="7"><p><strong>Secrets Manager</strong></p></td><td><p><a href="#check-secret">check_secret</a></p></td><td><p>read:secrets_metadata</p></td></tr><tr><td><p><a href="#describe-vault-auth-schema">describe_vault_auth_schema</a></p></td><td><p>manage:vault_integrations</p></td></tr><tr><td><p><a href="#edit-integration">edit_integration</a></p></td><td><p>read:vault_integrations, manage:vault_integrations</p></td></tr><tr><td><p><a href="#list-integration-secrets">list_integration_secrets</a></p></td><td><p>read:vault_integrations, read:secrets_metadata</p></td></tr><tr><td><p><a href="#onboard-vault">onboard_vault</a></p></td><td><p>manage:vault_integrations</p></td></tr><tr><td><p><a href="#search-secrets">search_secrets</a></p></td><td><p>read:secrets_metadata</p></td></tr><tr><td><p><a href="#test-integration-connection">test_integration_connection</a></p></td><td><p>read:vault_integrations, manage:vault_integrations</p></td></tr></tbody></table>

## apply\_policy\_to\_instance

Apply the selected policy to a single target asset instance using the provided configuration data.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Numeric target instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset</code></p></td><td><p>Exchange coordinates: <code>group_id</code>, <code>asset_id</code>, and <code>asset_version</code> (object). Required for external provider writes.</p></td><td><p>No</p></td></tr><tr><td><p><code>configuration_data</code></p></td><td><p>Full template-conforming configuration (object).</p></td><td><p>No</p></td></tr><tr><td><p><code>disabled</code></p></td><td><p>Disabled (boolean).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string). Required for MuleSoft. Omit for the external Universal API.</p></td><td><p>No</p></td></tr><tr><td><p><code>gateway_id</code></p></td><td><p>Unused on the external Universal API path (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>injection_point</code></p></td><td><p>Injection point (string). Defaults from the template when omitted.</p></td><td><p>No</p></td></tr><tr><td><p><code>label</code></p></td><td><p>Display label (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>order</code></p></td><td><p>Order (integer).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>pointcut_data</code></p></td><td><p>Pointcut data (object).</p></td><td><p>No</p></td></tr><tr><td><p><code>policy_template_id</code></p></td><td><p>Selected template ID (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>kong</code>, <code>apigee</code>, or <code>azure</code> for the external path (string). Omit for MuleSoft.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "apply_policy_to_instance",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "provider": "kong",
    "asset": {
      "group_id": "<group_id>",
      "asset_id": "<asset_id>",
      "asset_version": "<version>"
    },
    "configuration_data": {}
  }
}
```

Example response

```json
{
  "tool": "apply_policy_to_instance",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "status": "success",
  "httpStatus": 202,
  "request": { "groupId": "<group_id>", "assetId": "<asset_id>", "assetVersion": "<version>" },
  "result": { "id": "<operation_id>" },
  "via": "apim_universal",
  "operationStatus": "accepted"
}
```

## apply\_universal\_policy

Apply an open (canonical) policy to one or more API instances across any provider in a single call.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>configuration</code></p></td><td><p>Configuration values that conform to the selected <code>configurationSchema</code> (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_ids</code></p></td><td><p>One or more API instance IDs. Instances can span providers (list of strings).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID. (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>policy_name</code></p></td><td><p>Canonical template name returned by <code>list_universal_policies</code> (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "apply_universal_policy",
  "arguments": {
    "policy_name": "rate-limiting",
    "instance_ids": ["12345", "67890"],
    "configuration": {}
  }
}
```

Example response

```json
{
  "status": "accepted",
  "organizationId": "<organization_id>",
  "policyName": "rate-limiting",
  "instanceIds": ["12345", "67890"],
  "operationId": "<operation_id>",
  "message": "The apply was accepted and is running asynchronously."
}
```

## check\_guardrail\_scope\_targets

Preview APIs matched by a guardrail scope filter.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>scope_filter</code></p></td><td><p>Scope filter (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "check_guardrail_scope_targets",
  "arguments": {
    "scope_filter": "apis:*"
  }
}
```

Example response

```json
{
  "scopeFilter": "apis:*",
  "matchedCount": 47,
  "matches": [
    { "assetId": "orders-api", "assetVersion": "2.1.0", "name": "Orders API" },
    { "assetId": "payments-api", "assetVersion": "1.4.2", "name": "Payments API" },
    { "assetId": "customers-api", "assetVersion": "3.0.1", "name": "Customers API" }
  ],
  "truncated": true
}
```

## check\_policy\_conformance

Convert the selected policy application payload to JSON-LD and print it in backend logs.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>API instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>configuration_data</code></p></td><td><p>Configuration data (PolicyConfigurationData or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>disabled</code></p></td><td><p>Disabled (boolean or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>group_id</code></p></td><td><p>Group ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>order</code></p></td><td><p>Order (integer or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>pointcut_data</code></p></td><td><p>Pointcut data (PolicyPointcutData or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>policy_template_id</code></p></td><td><p>Policy template ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "check_policy_conformance",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "api_instance_id": "<api_instance_id>"
  }
}
```

Example response

```json
{
  "apiInstanceId": "16834521",
  "policyTemplateId": "client-id-enforcement",
  "conformant": true,
  "violations": [],
  "jsonLd": {
    "@context": "https://anypoint.mulesoft.com/governance/policy/v1",
    "@type": "PolicyApplication",
    "policy": "client-id-enforcement",
    "target": "16834521"
  }
}
```

## check\_secret

Verify that a secret exists and retrieve its non-sensitive metadata without exposing secret
material.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Target Anypoint environment ID. Required unless <code>environment_name</code> is provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Human-readable environment name. Provide this <strong>or</strong> <code>environment_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>secret_group_name</code></p></td><td><p>Human-readable name of the secret group (as returned by <code>list_secret_refs</code> in <code>secretGroupName</code>). Pair with <code>secret_name</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>secret_name</code></p></td><td><p>Human-readable name of the secret. Pair with <code>secret_group_name</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>secret_group_id</code></p></td><td><p>ID of the secret group. Pair with <code>secret_id</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>secret_id</code></p></td><td><p>ID of the secret. Pair with <code>secret_group_id</code>.</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] You must provide either (`secret_group_name` and\`secret\_name\`) or (`secret_group_id`
> and `secret_id`), not both. You must also provide either `environment_id` or `environment_name`.

Example request

```json
{
  "name": "check_secret",
  "arguments": {
    "environment_name": "Production",
    "secret_group_name": "My Group",
    "secret_name": "my-api-key"
  }
}
```

Example response (exists)

```json
{
  "tool": "check_secret",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "environmentName": "Production",
  "exists": true,
  "name": "my-api-key",
  "type": "sharedSecret",
  "expirationDate": "2027-01-01",
  "lastModified": "2026-08-01T10:00:00Z"
}
```

Example response (not found)

```json
{
  "tool": "check_secret",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "exists": false,
  "error": "Secret 'my-api-key' not found in group 'My Group'."
}
```

## create\_automated\_policy\_strategy

Create a new automated-policy governance strategy from wizard inputs.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>allow_duplicated</code></p></td><td><p>Allow duplicated (boolean).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_configuration</code></p></td><td><p>Automated policy configuration (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_endpoint_type_groups</code></p></td><td><p>Automated policy endpoint type groups (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_endpoint_type_mode</code></p></td><td><p>Automated policy endpoint type mode (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_environment_id</code></p></td><td><p>Automated policy environment ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_id</code></p></td><td><p>Automated policy ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_runtime</code></p></td><td><p>Automated policy runtime (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_runtime_range_from</code></p></td><td><p>Automated policy runtime range from (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>automated_policy_runtime_range_to</code></p></td><td><p>Automated policy runtime range to (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>description</code></p></td><td><p>Description (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>scope_filter</code></p></td><td><p>Scope filter (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "create_automated_policy_strategy",
  "arguments": {
    "organization_id": "<organization_id>",
    "name": "Auto-apply rate limiting"
  }
}
```

Example response

```json
{
  "strategyId": "strat_a91f2c4d",
  "strategyType": "automated-policy",
  "name": "Auto-apply rate limiting",
  "status": "active",
  "createdDate": "2026-05-07T14:32:18.412Z"
}
```

## create\_guardrail

Create a new guardrail strategy from wizard inputs.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>description</code></p></td><td><p>Description (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>governance_target_type</code></p></td><td><p>Governance target type (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>position</code></p></td><td><p>Position (integer or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>rules</code></p></td><td><p>Rules (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>rulesets</code></p></td><td><p>Rulesets (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>schedule_config</code></p></td><td><p>Schedule config (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>scope_condition_mode</code></p></td><td><p>Scope condition mode (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>scope_conditions</code></p></td><td><p>Scope conditions (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>scope_filter</code></p></td><td><p>Scope filter (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>strategy_status</code></p></td><td><p>Strategy status (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>strategy_type</code></p></td><td><p>Strategy type (string).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "create_guardrail",
  "arguments": {
    "description": "",
    "governance_target_type": "service-assets",
    "name": "<name>"
  }
}
```

Example response

```json
{
  "guardrailId": "gr_72bd1e3a",
  "name": "PII redaction in OpenAPI specs",
  "governanceTargetType": "service-assets",
  "scopeFilter": "apis:*",
  "rulesets": ["openapi-best-practices", "pii-redaction"],
  "status": "active",
  "createdDate": "2026-05-07T14:32:18.412Z"
}
```

## create\_model\_wallet

Create a model wallet with budget allocation for a specific LLM model. Configures token budgets with
a defined cadence and required JWT claims for access control.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>amount</code></p></td><td><p>Token amount allocated for the wallet budget.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>cadence</code></p></td><td><p>Budget replenishment period (for example, <code>weekly</code>, <code>monthly</code>).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>claims</code></p></td><td><p>Required JWT claims that must match for budget grants (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID to scope the wallet.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>model_id</code></p></td><td><p>Model ID to associate with the wallet budget.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to scope the wallet.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>wallet_id</code></p></td><td><p>Wallet name or ID.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "create_model_wallet",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "wallet_id": "orders-team-wallet",
    "model_id": "<model_id>",
    "amount": 3,
    "cadence": "weekly",
    "claims": ["claim_abc123"]
  }
}
```

Example response

```json
{
  "walletId": "orders-team-wallet",
  "organizationId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
  "modelId": "claude-opus-4-7",
  "budget": {
    "amount": 3,
    "cadence": "weekly",
    "claims": ["claim_abc123"]
  },
  "status": "active",
  "createdDate": "2026-05-07T14:32:18.412Z"
}
```

## create\_omni\_gateway

Launch the managed gateway creation wizard for the active MuleSoft provider. When fully configured,
creates the gateway in Anypoint Platform.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Environment name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_type</code></p></td><td><p>Environment type (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>governance_override_warnings</code></p></td><td><p>Governance override warnings (boolean).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>payload</code></p></td><td><p>Payload (FlexGatewayCreatePayload or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>target_type</code></p></td><td><p>Target type (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "create_omni_gateway",
  "arguments": {
    "environment_id": "<environment_id>",
    "environment_name": "<environment_name>",
    "environment_type": "<environment_type>"
  }
}
```

Example response

```json
{
  "gatewayId": "fg_8c4e92a1",
  "name": "prod-omni-gateway",
  "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
  "targetType": "cloudhub2",
  "status": "creating",
  "ingressDomains": ["prod-omni-gateway.us-e1.cloudhub.io"],
  "createdDate": "2026-05-07T14:32:18.412Z"
}
```

## create\_scanner

Launch the scanner creation wizard to configure and create a new agent scanner. The wizard will
guide you through provider selection, authentication, and configuration. On success, returns the
created scanner details including scannerId. Pass organization\_id when calling this tool. Call
WITHOUT name/provider to display the interactive wizard.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>auth_fields</code></p></td><td><p>Auth fields (ScannerAuthFields or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>auth_fields_alias</code></p></td><td><p>Auth fields alias (ScannerAuthFields or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>auth_method</code></p></td><td><p>Auth method (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>auth_method_alias</code></p></td><td><p>Auth method alias (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>description</code></p></td><td><p>Description (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>filters</code></p></td><td><p>Filters (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>notifications</code></p></td><td><p>Notifications (ScannerNotifications or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>owner_id</code></p></td><td><p>Owner ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Provider (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>schedule</code></p></td><td><p>Schedule (ScannerSchedule or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "create_scanner",
  "arguments": {
    "auth_fields": {},
    "auth_fields_alias": {},
    "auth_method": "<auth_method>"
  }
}
```

Example response

```json
{
  "scannerId": "sc_3d7a4f81",
  "name": "vertex-prod-scanner",
  "provider": "google-vertex",
  "authMethod": "service-account",
  "status": "active",
  "schedule": { "frequency": "daily", "hour": 2 },
  "createdDate": "2026-05-07T14:32:18.412Z"
}
```

## delete\_automated\_policy\_strategy

Delete one automated-policy governance strategy by strategy ID.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>strategy_id</code></p></td><td><p>Strategy ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "delete_automated_policy_strategy",
  "arguments": {
    "strategy_id": "<strategy_id>"
  }
}
```

Example response

```json
{
  "strategyId": "strat_a91f2c4d",
  "deleted": true
}
```

## delete\_governance\_strategy

Delete one governance strategy by strategy id.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>strategy_id</code></p></td><td><p>Strategy ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "delete_governance_strategy",
  "arguments": {
    "strategy_id": "<strategy_id>"
  }
}
```

Example response

```json
{
  "strategyId": "gs_5e2f9a18",
  "deleted": true
}
```

## delete\_model\_wallet

Delete a model wallet.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID to scope the query.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>wallet_id</code></p></td><td><p>Wallet ID.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>wallet_name</code></p></td><td><p>Wallet name.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "delete_model_wallet",
  "arguments": {
    "wallet_name": "orders-team-wallet",
    "wallet_id": "<wallet_id>",
    "environment_id": "<environment_id>"
  }
}
```

Example response

```json
{
  "walletId": "wlt_4f8a91d2",
  "walletName": "orders-team-wallet",
  "deleted": true
}
```

## describe\_vault\_auth\_schema

Discover supported vault providers and the credential fields required to onboard or edit a vault
integration.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization UUID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Vault provider to describe (<code>aws_secrets_manager</code>, <code>azure_key_vault</code>, <code>hashicorp_vault</code>). Omit along with <code>auth_method</code> to list all supported combinations.</p></td><td><p>No</p></td></tr><tr><td><p><code>auth_method</code></p></td><td><p>Authentication method to describe (for example, <code>azure_sp_secret</code>). Must be paired with <code>provider</code>; omit both to list all combinations.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (list all)

```json
{
  "name": "describe_vault_auth_schema",
  "arguments": {}
}
```

Example response (list mode)

```json
{
  "tool": "describe_vault_auth_schema",
  "organizationId": "org-uuid",
  "authMethods": [
    {
      "provider": "azure_key_vault",
      "authMethod": "azure_sp_secret",
      "enabled": true
    },
    {
      "provider": "aws_secrets_manager",
      "authMethod": "aws_static",
      "enabled": true
    }
  ],
  "message": "Choose a provider + authMethod, then call describe_vault_auth_schema again with both to see the exact fields required."
}
```

Example request (specific combination)

```json
{
  "name": "describe_vault_auth_schema",
  "arguments": {
    "provider": "azure_key_vault",
    "auth_method": "azure_sp_secret"
  }
}
```

Example response (detail mode)

```json
{
  "tool": "describe_vault_auth_schema",
  "organizationId": "org-uuid",
  "schema": {
    "provider": "azure_key_vault",
    "authMethod": "azure_sp_secret",
    "rawSecrets": [
      {
        "key": "azure.spSecret.clientSecret",
        "label": "Client Secret",
        "required": true,
        "type": "password"
      }
    ],
    "connectionConfig": [
      {
        "key": "azure.spSecret.clientId",
        "label": "Client ID",
        "required": true,
        "type": "text"
      },
      {
        "key": "azure.spSecret.tenantId",
        "label": "Tenant ID",
        "required": true,
        "type": "text"
      }
    ]
  }
}
```

## edit\_applied\_policy

Edit the configuration of an already-applied policy on one API instance.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Numeric target instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset</code></p></td><td><p>Exchange coordinates: <code>group_id</code>, <code>asset_id</code>, and <code>asset_version</code> (object). Required for external provider writes.</p></td><td><p>No</p></td></tr><tr><td><p><code>configuration_data</code></p></td><td><p>Full template-conforming configuration (object).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string). Required for MuleSoft. Omit for the external Universal API.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>policy_id</code></p></td><td><p>Policy ID from <code>view_api_instance_policies</code> (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>kong</code>, <code>apigee</code>, or <code>azure</code> for the external path (string). Omit for MuleSoft.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "edit_applied_policy",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "policy_id": "<policy_id>",
    "provider": "kong",
    "asset": {
      "group_id": "<group_id>",
      "asset_id": "<asset_id>",
      "asset_version": "<version>"
    },
    "configuration_data": {}
  }
}
```

Example response

```json
{
  "tool": "edit_applied_policy",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "policyId": "<policy_id>",
  "status": "success",
  "result": { "id": "<operation_id>" },
  "via": "apim_universal"
}
```

## edit\_integration

Modify an existing vault integration’s configuration. Validates edited credentials and performs a
connectivity test before saving.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Target environment ID. Required unless <code>environment_name</code> is provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Human-readable environment name. Provide this or <code>environment_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>integration_name</code></p></td><td><p>Human-readable name of the vault integration. Provide this or <code>integration_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>integration_id</code></p></td><td><p>UUID of the vault integration. Provide this or <code>integration_name</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>description</code></p></td><td><p>New description (max 512 characters).</p></td><td><p>No</p></td></tr><tr><td><p><code>sync_enabled</code></p></td><td><p>Enable or disable automatic sync (reference-based integrations only).</p></td><td><p>No</p></td></tr><tr><td><p><code>raw_secrets</code></p></td><td><p>Updated credential values (managed integrations only).</p></td><td><p>No</p></td></tr><tr><td><p><code>connection_config</code></p></td><td><p>Updated non-secret configuration (managed integrations only).</p></td><td><p>No</p></td></tr><tr><td><p><code>credential_refs</code></p></td><td><p>Updated credential references (reference-based integrations only).</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] You must provide either `integration_name` or `integration_id`. You must also provide
> either `environment_id` or `environment_name`.

Example request

```json
{
  "name": "edit_integration",
  "arguments": {
    "environment_name": "Production",
    "integration_name": "My Azure Vault",
    "description": "Updated description",
    "raw_secrets": {
      "azure.spSecret.clientSecret": "new-secret-value"
    }
  }
}
```

Example response

```json
{
  "tool": "edit_integration",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "environmentName": "Production",
  "changedFields": ["description", "rawSecrets"],
  "integration": {
    "id": "integration-uuid",
    "name": "My Azure Vault",
    "description": "Updated description",
    "provider": "azure_key_vault",
    "authMethod": "azure_sp_secret",
    "managed": true,
    "version": 2,
    "vaultUrl": "https://my-vault.vault.azure.net"
  }
}
```

## edit\_model\_wallet

Edit an existing model wallet configuration. Updates wallet properties such as the client name for a
given wallet and environment.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID to scope the query.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>wallet_id</code></p></td><td><p>Wallet name or ID.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "edit_model_wallet",
  "arguments": {
    "wallet_id": "orders-team-wallet",
    "environment_id": "<environment_id>"
  }
}
```

Example response

```json
{
  "walletId": "orders-team-wallet",
  "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
  "name": "orders-team-wallet-v2",
  "status": "active",
  "updatedDate": "2026-05-07T14:32:18.412Z"
}
```

## fetch\_automated\_policy\_template

Fetch one policy template by templateId for configuration details.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>template_id</code></p></td><td><p>Template ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_automated_policy_template",
  "arguments": {
    "template_id": "<template_id>"
  }
}
```

Example response

```json
{
  "templateId": "rate-limiting",
  "name": "Rate Limiting",
  "category": "Quality of Service",
  "version": "1.4.0",
  "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "configurationSchema": {
    "type": "object",
    "properties": {
      "rateLimits": { "type": "array" },
      "exposeHeaders": { "type": "boolean" }
    }
  }
}
```

## fetch\_cost\_instance\_timeseries

Get token usage and response time timeseries for a single instance. This is the only tool that
returns an agent timeseries.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>category</code></p></td><td><p>Scope of the series. Defaults to <code>mcp</code>. Supported values: <code>mcp</code> — an MCP server instance; <code>instance_id</code> is the API Manager instance ID; buckets carry <code>totalTokens</code>, <code>tokenDelta</code>, and <code>avgResponseTimeMs</code>. <code>agent</code> — a single agent (LLM proxy); <code>instance_id</code> is the agent’s ID (<code>agentId</code> or <code>llmProxyId</code> from <code>fetch_cost_instances(category='agent')</code>); buckets carry token counts and <code>avgResponseTimeMs</code> (no per-bucket dollar figures).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Instance ID to query. For <code>mcp</code>, the API Manager instance ID. For <code>agent</code>, the <code>agentId</code> or <code>llmProxyId</code> returned by <code>fetch_cost_instances(category='agent')</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window for the timeseries. Supported values: <code>1h</code>, <code>6h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>. Defaults to <code>24h</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_cost_instance_timeseries",
  "arguments": {
    "organization_id": "<organization_id>",
    "instance_id": "<instance_id>"
  }
}
```

Example response

```json
{
  "instanceId": "16834521",
  "timeRange": "7d",
  "buckets": [
    {
      "timestamp": "2026-04-30T00:00:00Z",
      "totalTokens": 142318,
      "tokenDelta": 21405,
      "avgResponseTimeMs": 312
    },
    {
      "timestamp": "2026-05-01T00:00:00Z",
      "totalTokens": 158902,
      "tokenDelta": 24817,
      "avgResponseTimeMs": 298
    },
    {
      "timestamp": "2026-05-02T00:00:00Z",
      "totalTokens": 134210,
      "tokenDelta": 19503,
      "avgResponseTimeMs": 305
    }
  ]
}
```

## fetch\_cost\_instances

Get per-instance token usage and optimization coverage across MCP servers and agents. To optimize an
MCP instance, pass its `unappliedCostPolicyIds` to `prepare_policy_creation`.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>category</code></p></td><td><p>Scope of the query. Defaults to <code>mcp</code>. Supported values: <code>mcp</code> returns per-MCP-server-instance token usage with optimization coverage (includes <code>totalTokens</code>, <code>tokenDelta</code>, <code>avgResponseTimeMs</code>, <code>toolsListTokens</code>, <code>toolsCallTokens</code>, <code>appliedCostPolicyIds</code>, <code>unappliedCostPolicyIds</code>, and <code>optimizationCoverage</code>). <code>agent</code> returns per-agent LLM-proxy spend and savings in dollars (not token estimates). Dollar figures depend on cost data being available for the org (the response carries <code>costDataAvailable</code>). When <code>false</code>, spend and saved are zeroed placeholders. <code>filter_unoptimized</code> and <code>sort_by</code> do not apply to the agent scope.</p></td><td><p>No</p></td></tr><tr><td><p><code>filter_unoptimized</code></p></td><td><p>Set to <code>true</code> to return only instances that have unapplied cost policies (<code>unappliedCostPolicyIds</code> not empty). Use this to find optimization candidates quickly. Defaults to <code>false</code>. Applies to <code>mcp</code> category only.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to query for per-instance usage and optimization coverage.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>sort_by</code></p></td><td><p>Sort field for results. Supported values: <code>totalTokens</code>, <code>tokenDelta</code>, <code>avgResponseTimeMs</code>, <code>totalCalls</code>, <code>tokensPerCall</code>. Defaults to <code>totalTokens</code>. Applies to <code>mcp</code> category only.</p></td><td><p>No</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window for usage analysis. Supported values: <code>1h</code>, <code>6h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>. Defaults to <code>30d</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>top_n</code></p></td><td><p>Maximum number of instances to return. Defaults to <code>10</code>; maximum is <code>50</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_cost_instances",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "instances": [
    {
      "instanceId": "16834521",
      "instanceName": "orders-mcp-prod",
      "assetId": "orders-mcp-server",
      "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
      "totalTokens": 4218903,
      "tokenDelta": 612418,
      "avgResponseTimeMs": 287,
      "totalCalls": 5142,
      "tokensPerCall": 820,
      "toolsListTokens": 1402189,
      "toolsCallTokens": 2816714,
      "appliedPolicies": ["client-id-enforcement"],
      "appliedCostPolicyIds": [],
      "unappliedCostPolicyIds": ["tool-output-truncation", "response-caching"],
      "optimizationCoverage": 0.0
    }
  ],
  "policyTemplates": {
    "tool-output-truncation": {
      "name": "Tool Output Truncation",
      "description": "Caps tool response token usage."
    },
    "response-caching": {
      "name": "Response Caching",
      "description": "Caches identical tool calls."
    }
  },
  "total": 18
}
```

## fetch\_cost\_optimization\_recommendations

Get a ranked list of instances with the highest projected token savings from unapplied cost
policies.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>category</code></p></td><td><p>Scope to rank. Defaults to <code>mcp</code>. Supported values: <code>mcp</code> — MCP server instances ranked by projected token savings from unapplied cost policies. <code>agent</code> — agent and LLM proxy scope. Currently returns an empty list because the upstream per-proxy rate source is not yet available.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to query for optimization recommendations.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>savings_pool_size</code></p></td><td><p>Number of candidate instances to evaluate before ranking the final recommendations; increase this when you want broader coverage before taking the top results. Defaults to <code>10</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window used to detect active instances and estimate projected token savings. Supported values: <code>1h</code>, <code>6h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>. Defaults to <code>30d</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>top_n</code></p></td><td><p>Maximum number of ranked recommendations to return. Defaults to <code>3</code>; maximum is <code>10</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_cost_optimization_recommendations",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "recommendations": [
    {
      "instanceId": "16834521",
      "instanceName": "orders-mcp-prod",
      "serverName": "Orders MCP Server",
      "assetId": "orders-mcp-server",
      "environment": "production",
      "totalTokens": 4218903,
      "projectedTokensSaved": 1180294,
      "projectedSavingsPercent": 27.97,
      "unappliedCostPolicyIds": ["tool-output-truncation", "response-caching"],
      "perPolicyProjections": [
        {
          "policyId": "tool-output-truncation",
          "policyName": "Tool Output Truncation",
          "rate": 0.18,
          "tokensSaved": 759402
        },
        {
          "policyId": "response-caching",
          "policyName": "Response Caching",
          "rate": 0.1,
          "tokensSaved": 420892
        }
      ]
    }
  ],
  "savingsPoolSize": 3,
  "timeRange": "30d"
}
```

## fetch\_cost\_overview

Get the org-wide cost summary: MCP server token KPIs (total tokens, saved tokens from optimization
policies, and total tool calls) plus org-wide agent dollar cards (`totalManagedSpend` and
`agentAmountSaved`). The dollar cards are populated only when cost data is available for the org
(`costDataAvailable=true`). When unavailable, the cards are absent. Optionally includes token usage
timeseries.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>include_timeseries</code></p></td><td><p>Set to <code>true</code> to include token usage timeseries for charting; this increases response size. Defaults to <code>false</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to query for org-wide MCP token KPIs and agent dollar cards.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window for KPI aggregation. Supported values: <code>1h</code>, <code>6h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>. Defaults to <code>30d</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_cost_overview",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "timeRange": "30d",
  "kpis": {
    "totalTokens": 18472310,
    "savedTokens": 3214087,
    "totalToolCalls": 24158,
    "tokensPerCall": 765,
    "savingsPercent": 14.8
  },
  "timeseries": [
    { "timestamp": "2026-04-08T00:00:00Z", "totalTokens": 612430, "savedTokens": 98215 },
    { "timestamp": "2026-04-09T00:00:00Z", "totalTokens": 587102, "savedTokens": 104812 }
  ]
}
```

## fetch\_governance\_service\_report

Use this tool to get detailed governance conformance data for a single service.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>Optional API version to scope the report when a service has multiple versions.</p></td><td><p>No</p></td></tr><tr><td><p><code>include_rule_messages</code></p></td><td><p>Set to <code>true</code> to include per-rule conformance messages in the response.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID that owns the service.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>service_id</code></p></td><td><p>Service ID to retrieve detailed governance conformance for.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>version</code></p></td><td><p>Optional service version selector (legacy alias). Use when you need a specific version’s conformance view.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_governance_service_report",
  "arguments": {
    "organization_id": "<organization_id>",
    "service_id": "<service_id>"
  }
}
```

Example response

```json
{
  "service": {
    "serviceId": "orders-api",
    "name": "Orders API",
    "provider": "mulesoft",
    "version": "2.1.0",
    "conformanceStatus": "non-compliant"
  },
  "rulesets": [
    {
      "rulesetId": "openapi-best-practices",
      "name": "OpenAPI Best Practices",
      "errorCount": 2,
      "warningCount": 5,
      "infoCount": 1,
      "rules": [
        {
          "ruleId": "operation-success-response",
          "severity": "error",
          "message": "Operation 'POST /orders' is missing a 2xx response."
        }
      ]
    }
  ],
  "instanceConformance": [
    { "instanceId": "16834521", "environment": "production", "conformant": false }
  ]
}
```

## fetch\_governance\_services

Use this tool to search, filter, and count governance conformance across services.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>concern_area_ids</code></p></td><td><p>Filter to one or more concern area IDs (for example <code>security-privacy</code>, <code>consumption-economic-governance</code>, <code>structural-conformity-lifecycle</code>).</p></td><td><p>No</p></td></tr><tr><td><p><code>conformance_status_in</code></p></td><td><p>Filter to one or more conformance states. Canonical values: <code>compliant</code>, <code>non-compliant</code>, <code>pending</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>include_rule_messages</code></p></td><td><p>Set to <code>true</code> to include rule-level messages in each returned service row.</p></td><td><p>No</p></td></tr><tr><td><p><code>include_rulesets</code></p></td><td><p>Set to <code>true</code> to include violated ruleset details in each service row.</p></td><td><p>No</p></td></tr><tr><td><p><code>limit</code></p></td><td><p>Page size for results.</p></td><td><p>No</p></td></tr><tr><td><p><code>min_errors</code></p></td><td><p>Minimum error count threshold for matched services.</p></td><td><p>No</p></td></tr><tr><td><p><code>min_infos</code></p></td><td><p>Minimum info count threshold for matched services.</p></td><td><p>No</p></td></tr><tr><td><p><code>min_warnings</code></p></td><td><p>Minimum warning count threshold for matched services.</p></td><td><p>No</p></td></tr><tr><td><p><code>offset</code></p></td><td><p>Result offset for pagination.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to search for governance conformance data.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider_in</code></p></td><td><p>Filter to one or more gateway/provider values. Canonical values include <code>mulesoft</code>, <code>kong</code>, <code>apigee</code>, <code>aws</code>, <code>azure</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>q</code></p></td><td><p>Free-text search across service metadata.</p></td><td><p>No</p></td></tr><tr><td><p><code>ruleset_ids_in</code></p></td><td><p>Filter to services associated with one or more ruleset IDs.</p></td><td><p>No</p></td></tr><tr><td><p><code>service_ids</code></p></td><td><p>Filter to specific service IDs.</p></td><td><p>No</p></td></tr><tr><td><p><code>service_type_in</code></p></td><td><p>Filter to one or more service types.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_governance_services",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "services": [
    {
      "serviceId": "orders-api",
      "name": "Orders API",
      "provider": "mulesoft",
      "serviceType": "rest-api",
      "conformanceStatus": "non-compliant",
      "errorCount": 2,
      "warningCount": 5,
      "violatedRulesets": ["openapi-best-practices"]
    },
    {
      "serviceId": "payments-api",
      "name": "Payments API",
      "provider": "mulesoft",
      "serviceType": "rest-api",
      "conformanceStatus": "compliant",
      "errorCount": 0,
      "warningCount": 0,
      "violatedRulesets": []
    }
  ],
  "totals": {
    "statusTotals": { "compliant": 38, "non-compliant": 9, "pending": 2 },
    "concernTotals": {
      "security-privacy": { "errorCount": 4, "warningCount": 11 },
      "structural-conformity-lifecycle": { "errorCount": 2, "warningCount": 5 }
    },
    "providerTotals": {
      "mulesoft": { "compliant": 32, "non-compliant": 7, "pending": 1 },
      "kong": { "compliant": 6, "non-compliant": 2, "pending": 1 }
    }
  },
  "total": 49,
  "limit": 25,
  "offset": 0
}
```

## fetch\_guardrail\_ruleset

Fetch a guardrail ruleset payload by sourceRulesetKey.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>source_ruleset_key</code></p></td><td><p>Source ruleset key (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_guardrail_ruleset",
  "arguments": {
    "source_ruleset_key": "<source_ruleset_key>"
  }
}
```

Example response

```json
{
  "sourceRulesetKey": "openapi-best-practices",
  "name": "OpenAPI Best Practices",
  "version": "1.2.0",
  "rules": [
    {
      "ruleId": "operation-success-response",
      "severity": "error",
      "description": "Operations should declare a successful 2xx response."
    },
    {
      "ruleId": "operation-tag-defined",
      "severity": "warning",
      "description": "Operations should be tagged for grouping."
    }
  ]
}
```

## fetch\_model\_wallet\_details

Fetch model wallet details for a given wallet ID and environment.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID to scope the query.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>wallet_id</code></p></td><td><p>Wallet ID.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>wallet_name</code></p></td><td><p>Wallet name.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_model_wallet_details",
  "arguments": {
    "wallet_name": "orders-team-wallet",
    "wallet_id": "<wallet_id>",
    "environment_id": "<environment_id>"
  }
}
```

Example response

```json
{
  "walletId": "wlt_4f8a91d2",
  "walletName": "orders-team-wallet",
  "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
  "modelId": "claude-opus-4-7",
  "budget": {
    "amount": 3,
    "cadence": "weekly",
    "claims": ["claim_abc123"]
  },
  "status": "active",
  "createdDate": "2026-04-12T08:21:43.000Z"
}
```

## fetch\_model\_wallets

Fetch the list of model wallets for an environment.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID to scope the query.</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_model_wallets",
  "arguments": {
    "environment_id": "<environment_id>"
  }
}
```

Example response

```json
{
  "wallets": [
    {
      "walletId": "wlt_4f8a91d2",
      "walletName": "orders-team-wallet",
      "modelId": "claude-opus-4-7",
      "budget": { "amount": 3, "cadence": "weekly" },
      "status": "active"
    },
    {
      "walletId": "wlt_8c4e92a1",
      "walletName": "support-team-wallet",
      "modelId": "gpt-4-turbo",
      "budget": { "amount": 5, "cadence": "monthly" },
      "status": "active"
    }
  ],
  "total": 4
}
```

## fetch\_monitoring\_drill\_down

Use this tool to rank services or instances contributing to a specific performance metric
(availability, reliability, avgLatency, requestVolume, errorRate, or policyViolations). Use this
tool to answer queries such as, "Which services are driving errors?" or "Rank instances by latency."

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>entity_type</code></p></td><td><p>Optional entity category to rank. Supported values: <code>apis</code>, <code>agents</code>, <code>mcp-servers</code>, <code>llms</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment</code></p></td><td><p>Optional single environment filter (legacy convenience field).</p></td><td><p>No</p></td></tr><tr><td><p><code>environments</code></p></td><td><p>Optional list of environments to filter contributors by.</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Optional instance ID to narrow results to a single instance.</p></td><td><p>No</p></td></tr><tr><td><p><code>limit</code></p></td><td><p>Page size for ranked contributors.</p></td><td><p>No</p></td></tr><tr><td><p><code>metric</code></p></td><td><p>Metric used for ranking. Supported values: <code>availability</code>, <code>reliability</code>, <code>avgLatency</code>, <code>requestVolume</code>, <code>errorRate</code>, <code>policyViolations</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>offset</code></p></td><td><p>Result offset for pagination.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Optional organization ID scope (required in multi-org contexts).</p></td><td><p>No</p></td></tr><tr><td><p><code>providers</code></p></td><td><p>Optional list of provider filters.</p></td><td><p>No</p></td></tr><tr><td><p><code>search</code></p></td><td><p>Free-text filter matching service, instance, or environment names.</p></td><td><p>No</p></td></tr><tr><td><p><code>service_id</code></p></td><td><p>Optional service ID to narrow the ranking to one service’s instances.</p></td><td><p>No</p></td></tr><tr><td><p><code>sort_dir</code></p></td><td><p>Sort direction for ranked results, typically <code>asc</code> or <code>desc</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>sort_field</code></p></td><td><p>Field to sort by in the drill-down result set.</p></td><td><p>No</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window for metric calculation (for example <code>24h</code>).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_monitoring_drill_down",
  "arguments": {
    "metric": "availability"
  }
}
```

Example response

```json
{
  "metric": "availability",
  "rows": [
    {
      "serviceId": "orders-api",
      "instanceId": "16834521",
      "name": "Orders API",
      "environment": "production",
      "value": 99.92,
      "delta": -0.04
    },
    {
      "serviceId": "payments-api",
      "instanceId": "16834522",
      "name": "Payments API",
      "environment": "production",
      "value": 99.81,
      "delta": 0.01
    },
    {
      "serviceId": "customers-api",
      "instanceId": "16834523",
      "name": "Customers API",
      "environment": "production",
      "value": 99.43,
      "delta": -0.21
    }
  ],
  "totalRows": 12,
  "offset": 0,
  "pageSize": 10
}
```

## fetch\_monitoring\_instance

Use this tool to get monitoring data for a single API instance: time-series charts (requests, error
rate, latency, policy violations), top endpoints by traffic, and top clients by traffic.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>Optional API version selector for the target asset.</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>API asset ID to retrieve instance monitoring for.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Optional asset version selector.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment</code></p></td><td><p>Target environment for monitoring data. Supported values: <code>production</code>, <code>sandbox</code>, <code>development</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Optional instance ID. If omitted, the first available instance is selected.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID that owns the API asset and instance.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window for charts and summaries. Supported values: <code>1h</code>, <code>6h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_monitoring_instance",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "instanceId": "16834521",
  "assetId": "orders-api",
  "environment": "production",
  "timeRange": "24h",
  "charts": {
    "requests": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 4218 }],
    "errorRate": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 0.012 }],
    "avgLatency": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 287 }],
    "policyViolations": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 0 }]
  },
  "topEndpoints": [
    { "path": "/orders", "method": "POST", "requests": 18420 },
    { "path": "/orders/{id}", "method": "GET", "requests": 12508 }
  ],
  "topClients": [{ "clientId": "c_4f8a91d2", "clientName": "checkout-web", "requests": 21408 }]
}
```

## fetch\_monitoring\_overview

Use this tool to get an org-wide monitoring health snapshot: total requests, error rate, average
latency, availability, reliability, and compact trend charts.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment</code></p></td><td><p>Environment scope for KPI and trend data. Supported values: <code>production</code>, <code>sandbox</code>, <code>development</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>include_charts</code></p></td><td><p>Set to <code>true</code> to include compact time-series chart data with the KPI summary.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to query for org-wide monitoring health metrics.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Optional provider filter. Monitoring data is currently available for <code>mulesoft</code>; other canonical providers (<code>kong</code>, <code>apigee</code>, <code>aws</code>, <code>azure</code>) return empty results.</p></td><td><p>No</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time window for KPI and trend calculations. Supported values: <code>1h</code>, <code>6h</code>, <code>24h</code>, <code>7d</code>, <code>30d</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_monitoring_overview",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "environment": "production",
  "provider": "mulesoft",
  "timeRange": "7d",
  "kpis": {
    "totalRequests": 9128342,
    "errorRate": 0.018,
    "avgLatencyMs": 312,
    "availability": 99.87,
    "reliability": 99.41
  },
  "charts": {
    "requestVolume": [{ "timestamp": "2026-05-01T00:00:00Z", "value": 1284018 }],
    "errorRate": [{ "timestamp": "2026-05-01T00:00:00Z", "value": 0.021 }],
    "avgLatency": [{ "timestamp": "2026-05-01T00:00:00Z", "value": 305 }],
    "errorVolume": [{ "timestamp": "2026-05-01T00:00:00Z", "value": 26904 }]
  }
}
```

## fetch\_service\_facets

Use this tool when you need aggregate counts/buckets for summaries, dashboards, or filter panels,
not full service-row hydration.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>aggregates</code></p></td><td><p>Facet buckets/metrics to compute (for example <code>totalHits</code>, <code>byType</code>, <code>byProvider</code>). Use structured aggregate fields; do not send shorthand strings like <code>type,provider</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_types</code></p></td><td><p>Optional typed asset filter. Canonical values include API classifiers (<code>rest-api</code>, <code>http-api</code>, <code>graphql</code>, <code>soap-api</code>, <code>grpc-api</code>, <code>evented-api</code>) plus <code>agent</code> and <code>mcp</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>business_group_id</code></p></td><td><p>Business group ID to scope the facet query.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>filters</code></p></td><td><p>Optional structured typed filters. Do not combine with <code>q</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>q</code></p></td><td><p>Optional text query mode. When provided, do not send typed <code>filters</code> or <code>aggregates</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>size</code></p></td><td><p>Optional limit for returned facet buckets/results.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_service_facets",
  "arguments": {
    "business_group_id": "<business_group_id>"
  }
}
```

Example response

```json
{
  "businessGroupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "total": 142,
  "aggregates": {
    "byType": {
      "rest-api": 87,
      "graphql": 12,
      "soap-api": 18,
      "agent": 14,
      "mcp": 11
    },
    "byProvider": {
      "mulesoft": 118,
      "kong": 15,
      "apigee": 9
    },
    "byStatus": {
      "active": 128,
      "deprecated": 9,
      "draft": 5
    }
  }
}
```

## fetch\_services

Use this tool when you need concrete service rows (for example asset IDs/names, detail selection, or
navigation affordances).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>aggregates</code></p></td><td><p>Optional aggregate blocks to return alongside service rows (for example counts by type/provider). Use structured aggregate fields, not shorthand strings.</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_types</code></p></td><td><p>Optional typed asset filter. Canonical values include API classifiers (<code>rest-api</code>, <code>http-api</code>, <code>graphql</code>, <code>soap-api</code>, <code>grpc-api</code>, <code>evented-api</code>) plus <code>agent</code> and <code>mcp</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>business_group_id</code></p></td><td><p>Business group ID to scope the service search.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>filters</code></p></td><td><p>Optional structured typed filters. Do not combine with <code>q</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>include_affordances</code></p></td><td><p>Set to <code>true</code> to include navigation/action affordances in each service row.</p></td><td><p>No</p></td></tr><tr><td><p><code>q</code></p></td><td><p>Optional text query mode. When provided, do not send typed <code>filters</code> or <code>aggregates</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>size</code></p></td><td><p>Page size for returned service rows.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "fetch_services",
  "arguments": {
    "business_group_id": "<business_group_id>"
  }
}
```

Example response

```json
{
  "businessGroupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "total": 142,
  "services": [
    {
      "assetId": "orders-api",
      "name": "Orders API",
      "assetType": "rest-api",
      "provider": "mulesoft",
      "version": "2.1.0",
      "status": "active",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "links": { "self": "/exchange/api/v2/assets/orders-api/2.1.0" }
    },
    {
      "assetId": "payments-api",
      "name": "Payments API",
      "assetType": "rest-api",
      "provider": "mulesoft",
      "version": "1.4.2",
      "status": "active",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "links": { "self": "/exchange/api/v2/assets/payments-api/1.4.2" }
    }
  ]
}
```

## get\_asset\_lineage (Beta)

> [!NOTE] This tool is a pilot or beta service that is subject to the Beta Services Terms at
> [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/) or a written Unified
> Pilot Agreement if executed by Customer, and applicable terms in the
> [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992).
> Use of this pilot or beta service is at the Customer’s sole discretion.

Get instance-rooted lineage, including design-time and runtime relationships, from the Context
Catalog for an agent, MCP server, or API.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset</code></p></td><td><p>Asset name or ID to resolve lineage for (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_type</code></p></td><td><p>Type of the root asset. Supported values: <code>agent</code>, <code>mcp</code>, <code>api</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Version of the asset. Defaults to the latest available (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>direction</code></p></td><td><p>Traversal direction. Supported values: <code>upstream</code>, <code>downstream</code>. Downstream supports all three asset types; upstream supports <code>mcp</code> and <code>api</code> only.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID to scope the lineage query. Defaults to the request-scoped active org (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Deployed instance to get root lineage for. If omitted, the tool returns instance options for clarification (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_asset_lineage",
  "arguments": {
    "asset": "fraud-detection-mcp",
    "asset_type": "mcp",
    "direction": "upstream"
  }
}
```

Example response

```json
{
  "root": {
    "assetId": "fraud-detection-mcp",
    "assetType": "mcp",
    "version": "1.2.0",
    "instanceId": "i_7b3f9a12",
    "instanceLabel": "prod-us-east"
  },
  "direction": "upstream",
  "nodes": [
    {
      "assetId": "transactions-api",
      "assetType": "api",
      "version": "3.1.0",
      "instanceId": "i_4e8c2d67",
      "instanceLabel": "prod-transactions"
    },
    {
      "assetId": "customer-profiles-api",
      "assetType": "api",
      "version": "2.0.1",
      "instanceId": "i_9a1f5b83",
      "instanceLabel": "prod-profiles"
    }
  ],
  "edges": [
    {
      "from": "fraud-detection-mcp",
      "to": "transactions-api",
      "relationship": "consumes"
    },
    {
      "from": "fraud-detection-mcp",
      "to": "customer-profiles-api",
      "relationship": "consumes"
    }
  ],
  "totalNodes": 2
}
```

## get\_business\_group

Get full metadata for a business group by its ID.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>group_id</code></p></td><td><p>Group ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_business_group",
  "arguments": {
    "group_id": "<group_id>"
  }
}
```

Example response

```json
{
  "id": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "name": "Acme Corp",
  "parentId": null,
  "isMaster": true,
  "ownerId": "u-9f2a8c12",
  "subOrganizationIds": ["b21d4f88-1c5e-4a3d-9e7b-0a4c6b3e8d11"],
  "entitlements": {
    "vcoreProduction": 50,
    "vcoreSandbox": 10
  }
}
```

## get\_data\_asset\_classification (Beta)

> [!NOTE] This tool is a pilot or beta service that is subject to the Beta Services Terms at
> [Agreements - Salesforce.com](https://www.salesforce.com/company/legal/) or a written Unified
> Pilot Agreement if executed by Customer, and applicable terms in the
> [Product Terms Directory](https://ptd.salesforce.com/?_ga=2.247987783.1372150065.1709219475-629000709.1639001992).
> Use of this pilot or beta service is at the Customer’s sole discretion.

Get a data asset’s source-to-column hierarchy, classifications, descriptions, glossary terms, and
explicit PII state. Use this tool to answer questions such as "What’s the PII classification for the
customer\_orders data source?" or "Is there any PII in the finance\_reporting data catalog source?"

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset</code></p></td><td><p>Name or ID of a single data asset to resolve (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Business-group org ID to search. Defaults to the request-scoped active org (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version to prefer when selecting a document. Defaults to the latest available (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_data_asset_classification",
  "arguments": {
    "asset": "customer_orders"
  }
}
```

Example response

```json
{
  "asset": "customer_orders",
  "assetVersion": "2.1.0",
  "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "hierarchy": {
    "groupId": "com.example",
    "assetId": "customer_orders",
    "version": "2.1.0"
  },
  "classifications": [
    {
      "fieldName": "email_address",
      "classification": "PII",
      "sensitivity": "high",
      "category": "contact_info"
    },
    {
      "fieldName": "shipping_address",
      "classification": "PII",
      "sensitivity": "medium",
      "category": "contact_info"
    },
    {
      "fieldName": "order_total",
      "classification": "non-PII",
      "sensitivity": "low",
      "category": "transactional"
    }
  ],
  "containsPII": true,
  "totalFields": 12,
  "piiFieldCount": 2
}
```

## get\_mcp\_server\_state

Read the deployed state of a catalog-managed MCP server. Returns current systems, tools, and
upstream IDs needed for editing.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_mcp_server_state",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "assetId": "orders-mcp-server",
  "apiId": 16834521,
  "serverName": "Orders MCP Server",
  "targetId": "fg_8c4e92a1",
  "targetName": "prod-omni-gateway",
  "basePath": "/mcp/orders",
  "deployedSystems": [
    {
      "systemId": "salesforce",
      "tools": ["query", "create-record", "update-record"],
      "upstreamId": "u_2f1a8e44"
    }
  ],
  "currentUpstreamIds": { "salesforce": "u_2f1a8e44" }
}
```

## get\_omni\_gateway\_target\_domains

Get ingress domains and app unique id for a managed Omni Gateway target.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>target_id</code></p></td><td><p>Target ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_omni_gateway_target_domains",
  "arguments": {
    "environment_id": "<environment_id>",
    "target_id": "<target_id>"
  }
}
```

Example response

```json
{
  "targetId": "fg_8c4e92a1",
  "appUniqueId": "prod-omni-gateway-us-east-1",
  "ingressDomains": ["prod-omni-gateway.us-e1.cloudhub.io", "api.acme.com"]
}
```

## get\_omni\_gateway\_usage\_report

Get current managed Omni Gateway size entitlement usage.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_omni_gateway_usage_report",
  "arguments": {
    "organization_id": "<organization_id>",
    "provider_id": "<provider_id>"
  }
}
```

Example response

```json
{
  "providerId": "p_mulesoft_default",
  "entitlements": {
    "totalSize": "Medium",
    "usedReplicas": 4,
    "totalReplicas": 10
  },
  "byEnvironment": [
    {
      "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
      "name": "production",
      "replicas": 3
    },
    { "environmentId": "e2a4c731-1f9b-4c20-9e43-7a8e22b14d09", "name": "sandbox", "replicas": 1 }
  ]
}
```

## get\_policy\_operation\_status

Check the status of an asynchronous policy operation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>operation_id</code></p></td><td><p>Operation ID returned by an asynchronous canonical or native policy (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_policy_operation_status",
  "arguments": {
    "operation_id": "<operation_id>"
  }
}
```

Example response

```json
{
  "status": "ok",
  "organizationId": "<organization_id>",
  "operationId": "<operation_id>",
  "operation": {
    "status": "COMPLETED",
    "type": "CANONICAL_APPLY",
    "displayName": "<operation_name>",
    "startTime": "<timestamp>",
    "closeTime": "<timestamp>"
  }
}
```

## get\_policy\_template\_form

Load one policy template detail, including configuration schema, to dynamically render the creation
form. Use this immediately after selecting a policy in `prepare_policy_creation`.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Numeric target instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Exchange policy-template asset ID (string). Required with <code>group_id</code> and <code>asset_version</code> on external creation and edit paths.</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Exchange policy-template version (string). Required with <code>group_id</code> and <code>asset_id</code> on external creation and edit paths.</p></td><td><p>No</p></td></tr><tr><td><p><code>direction</code></p></td><td><p><code>inbound</code> or <code>outbound</code> (string). Defaults to <code>inbound</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>MuleSoft environment ID (string). Optional on the external path.</p></td><td><p>No</p></td></tr><tr><td><p><code>gateway_id</code></p></td><td><p>Unused on the external Universal API path (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>group_id</code></p></td><td><p>Exchange policy-template group ID (string). Required with <code>asset_id</code> and <code>asset_version</code> on external creation and edit paths.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>kong</code>, <code>apigee</code>, or <code>azure</code> for the external schema (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>template_id</code></p></td><td><p>Selected template ID from <code>prepare_policy_creation</code> (string).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_policy_template_form",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "provider": "kong",
    "group_id": "<group_id>",
    "asset_id": "<asset_id>",
    "asset_version": "<version>"
  }
}
```

Example response

```json
{
  "tool": "get_policy_template_form",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "direction": "inbound",
  "template": { "assetId": "<asset_id>", "assetVersion": "<version>", "configuration": {} },
  "via": "apim_universal"
}
```

## get\_provision\_status

Poll the status of a provisioning or update job.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>job_id</code></p></td><td><p>Job ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_provision_status",
  "arguments": {
    "job_id": "<job_id>",
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "tool": "get_provision_status",
  "jobId": "job_a1b2c3d4",
  "status": "running",
  "currentStep": 2,
  "totalSteps": 3,
  "stepLabel": "deploying-omni-gateway",
  "error": null,
  "result": null,
  "failure": null
}
```

## get\_trusted\_mcp\_catalog

Return the catalog of SaaS systems available for MCP server provisioning. Each item includes tools,
auth type, credential fields, and upstream config.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "get_trusted_mcp_catalog",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "catalog": [
    {
      "systemId": "salesforce",
      "name": "Salesforce",
      "authType": "oauth2",
      "credentialFields": ["clientId", "clientSecret", "instanceUrl"],
      "tools": ["query", "create-record", "update-record", "delete-record"]
    },
    {
      "systemId": "github",
      "name": "GitHub",
      "authType": "personal-access-token",
      "credentialFields": ["token"],
      "tools": ["list-repos", "get-file", "create-issue", "list-pull-requests"]
    }
  ]
}
```

## list\_agents

List agents registered in the Omni Platform for a given organization. Presents an interactive UI for
browsing, filtering, and selecting agents.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Provider (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_agents",
  "arguments": {
    "name": "<name>",
    "organization_id": "<organization_id>",
    "provider": "mulesoft"
  }
}
```

Example response

```json
{
  "agents": [
    {
      "assetId": "invoice-approval-agent",
      "name": "Invoice Approval Agent",
      "version": "1.2.0",
      "provider": "mulesoft",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "description": "Routes invoices to approvers based on amount thresholds."
    },
    {
      "assetId": "support-triage-agent",
      "name": "Support Triage Agent",
      "version": "0.9.1",
      "provider": "mulesoft",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "description": "Classifies incoming support tickets."
    }
  ],
  "total": 14
}
```

## list\_apis

List APIs from the Omni Platform catalog for a given organization. Presents an interactive UI for
browsing, filtering, and selecting APIs.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_category</code></p></td><td><p>API category (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Provider (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_apis",
  "arguments": {
    "api_category": "<api_category>",
    "name": "<name>",
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "apis": [
    {
      "assetId": "orders-api",
      "name": "Orders API",
      "apiCategory": "Commerce",
      "version": "2.1.0",
      "provider": "mulesoft",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913"
    },
    {
      "assetId": "payments-api",
      "name": "Payments API",
      "apiCategory": "Commerce",
      "version": "1.4.2",
      "provider": "mulesoft",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913"
    }
  ],
  "total": 87
}
```

## list\_business\_groups

List available business groups, optionally filtering by name.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_business_groups",
  "arguments": {
    "name": "<name>"
  }
}
```

Example response

```json
{
  "businessGroups": [
    {
      "id": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "name": "Acme Corp",
      "parentId": null,
      "isMaster": true
    },
    {
      "id": "b21d4f88-1c5e-4a3d-9e7b-0a4c6b3e8d11",
      "name": "Acme Payments Division",
      "parentId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "isMaster": false
    }
  ],
  "total": 2
}
```

## list\_governance\_strategies

List governance strategies for an organization. Shows the same searchable and filterable table style
as the main web app.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>strategy_type</code></p></td><td><p>Strategy type (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_governance_strategies",
  "arguments": {
    "organization_id": "<organization_id>",
    "strategy_type": "<strategy_type>"
  }
}
```

Example response

```json
{
  "strategies": [
    {
      "strategyId": "strat_a91f2c4d",
      "name": "Auto-apply rate limiting",
      "strategyType": "automated-policy",
      "status": "active",
      "scopeFilter": "apis:*",
      "createdDate": "2026-04-12T08:21:43.000Z"
    },
    {
      "strategyId": "gs_5e2f9a18",
      "name": "PII redaction guardrail",
      "strategyType": "guardrail",
      "status": "active",
      "scopeFilter": "apis:tags:public",
      "createdDate": "2026-03-28T11:09:22.000Z"
    }
  ],
  "total": 6
}
```

## list\_instance\_policy\_operations

List the asynchronous policy operations for an external gateway instance (Kong, Apigee, or Azure).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Numeric external-gateway API Manager instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>limit</code></p></td><td><p>Newest operations to return (integer). <code>0</code> uses the service default of <code>10</code>, capped at <code>50</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>kong</code>, <code>apigee</code>, or <code>azure</code> (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_instance_policy_operations",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "provider": "kong",
    "limit": 10
  }
}
```

Example response

```json
{
  "tool": "list_instance_policy_operations",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "total": 1,
  "running": 0,
  "failed": 0,
  "operations": [{ "id": "<operation_id>", "type": "APPLY", "status": "COMPLETED" }],
  "failedDetailsTruncated": 0,
  "via": "apim_universal"
}
```

## list\_integration\_secrets

List all secret references discovered by a specific vault integration, showing metadata only.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Target environment ID. Required unless <code>environment_name</code> is provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Human-readable environment name. Provide this or <code>environment_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>integration_name</code></p></td><td><p>Human-readable name of the vault integration. Provide this or <code>integration_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>integration_id</code></p></td><td><p>UUID of the vault integration. Provide this or <code>integration_name</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>offset</code></p></td><td><p>Zero-based pagination offset. Default: <code>0</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>limit</code></p></td><td><p>Maximum number of items to return. Default: <code>10</code>.</p></td><td><p>No</p></td></tr></tbody></table>

> [!NOTE] You must provide either `integration_name` or `integration_id`. You must also provide
> either `environment_id` or `environment_name`.

Example request

```json
{
  "name": "list_integration_secrets",
  "arguments": {
    "environment_name": "Production",
    "integration_name": "My Azure Vault",
    "offset": 0,
    "limit": 10
  }
}
```

Example response

```json
{
  "tool": "list_integration_secrets",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "environmentName": "Production",
  "integrationId": "integration-uuid",
  "items": [
    {
      "name": "db-password",
      "type": "sharedSecret",
      "secretGroupName": "",
      "expirationDate": "2027-06-01"
    },
    {
      "name": "api-token",
      "type": "sharedSecret",
      "secretGroupName": "",
      "expirationDate": ""
    }
  ],
  "offset": 0,
  "limit": 10,
  "returned": 2,
  "total": 2,
  "has_more": false,
  "next_offset": null
}
```

## list\_llms

List LLM models registered in the Omni Platform for a given organization. Presents an interactive UI
for browsing, filtering, and selecting LLMs.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>category</code></p></td><td><p>Category (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Provider (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_llms",
  "arguments": {
    "category": "<category>",
    "name": "<name>",
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "llms": [
    {
      "assetId": "claude-opus-4-7",
      "name": "Claude Opus 4.7",
      "category": "general-purpose",
      "provider": "anthropic",
      "version": "1.0.0",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913"
    },
    {
      "assetId": "gpt-4-turbo",
      "name": "GPT-4 Turbo",
      "category": "general-purpose",
      "provider": "openai",
      "version": "1.0.0",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913"
    }
  ],
  "total": 9
}
```

## list\_mcp\_servers

List MCP servers registered in the Omni Platform for a given organization. Presents an interactive
UI for browsing, filtering, and selecting MCP servers.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>protocol</code></p></td><td><p>Protocol (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_mcp_servers",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "mcpServers": [
    {
      "assetId": "orders-mcp-server",
      "name": "Orders MCP Server",
      "protocol": "streamable-http",
      "version": "1.0.0",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "instances": 2
    },
    {
      "assetId": "salesforce-mcp-server",
      "name": "Salesforce MCP Server",
      "protocol": "streamable-http",
      "version": "1.2.1",
      "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
      "instances": 3
    }
  ],
  "total": 11
}
```

## list\_omni\_gateway\_environments

List Anypoint environments available for managed Omni Gateway creation.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_omni_gateway_environments",
  "arguments": {
    "organization_id": "<organization_id>",
    "provider_id": "<provider_id>"
  }
}
```

Example response

```json
{
  "environments": [
    {
      "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
      "name": "production",
      "type": "production",
      "isProduction": true
    },
    {
      "environmentId": "e2a4c731-1f9b-4c20-9e43-7a8e22b14d09",
      "name": "sandbox",
      "type": "sandbox",
      "isProduction": false
    },
    {
      "environmentId": "e3d2a811-7f5c-4983-89ce-a141f9120abc",
      "name": "development",
      "type": "design",
      "isProduction": false
    }
  ]
}
```

## list\_omni\_gateway\_targets

List managed Omni Gateway deployment targets for an environment.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_omni_gateway_targets",
  "arguments": {
    "environment_id": "<environment_id>"
  }
}
```

Example response

```json
{
  "targets": [
    {
      "targetId": "fg_8c4e92a1",
      "name": "prod-omni-gateway",
      "targetType": "cloudhub2",
      "status": "running",
      "ingressDomains": ["prod-omni-gateway.us-e1.cloudhub.io"],
      "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002"
    }
  ]
}
```

## list\_provider\_gateways

List gateways for the active provider. Currently returns Flex Gateways when the active provider is
MuleSoft.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_provider_gateways",
  "arguments": {
    "organization_id": "<organization_id>",
    "provider_id": "<provider_id>"
  }
}
```

Example response

```json
{
  "providerId": "p_mulesoft_default",
  "gatewayType": "flex-gateway",
  "gateways": [
    {
      "gatewayId": "fg_8c4e92a1",
      "name": "prod-omni-gateway",
      "status": "running",
      "version": "1.9.2",
      "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002"
    },
    {
      "gatewayId": "fg_2f1a8e44",
      "name": "sandbox-flex-gateway",
      "status": "running",
      "version": "1.9.2",
      "environmentId": "e2a4c731-1f9b-4c20-9e43-7a8e22b14d09"
    }
  ]
}
```

## list\_scanner\_providers

Get the list of available scanner providers (Google Vertex, Microsoft Copilot, and others).

This tool does not accept any input parameters.

Example request

```json
{
  "name": "list_scanner_providers",
  "arguments": {}
}
```

Example response

```json
{
  "providers": [
    {
      "providerId": "google-vertex",
      "name": "Google Vertex AI",
      "authMethods": ["service-account", "oauth2"]
    },
    { "providerId": "microsoft-copilot", "name": "Microsoft Copilot", "authMethods": ["oauth2"] },
    {
      "providerId": "aws-bedrock",
      "name": "AWS Bedrock",
      "authMethods": ["iam-role", "access-key"]
    }
  ]
}
```

## list\_universal\_policies

List the open (canonical) policy templates available to an organization.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>policy_name_hint</code></p></td><td><p>Case-insensitive substring of the canonical name or label (string). Empty lists all templates.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "list_universal_policies",
  "arguments": {
    "policy_name_hint": "rate"
  }
}
```

Example response

```json
{
  "status": "ok",
  "organizationId": "<organization_id>",
  "policies": [
    {
      "name": "rate-limiting",
      "label": "Rate Limiting",
      "configurationSchema": { "type": "object", "properties": {} },
      "supportedProviders": ["mulesoft", "kong"],
      "providerMapping": []
    }
  ]
}
```

## login

Authenticate with Omni Platform. MUST be called before any other tool.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>password</code></p></td><td><p>Password (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>username</code></p></td><td><p>Username (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "login",
  "arguments": {
    "password": "<password>",
    "username": "<username>"
  }
}
```

Example response

```json
{
  "authenticated": true,
  "userId": "u-9f2a8c12",
  "username": "alice@acme.com",
  "activeOrganizationId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "expiresAt": "2026-05-08T14:32:18.412Z"
}
```

## logout

Clear the stored authentication token.

This tool does not accept any input parameters.

Example request

```json
{
  "name": "logout",
  "arguments": {}
}
```

Example response

```json
{
  "authenticated": false
}
```

## onboard\_vault

Register a new external vault provider integration using the managed raw-value flow. Validates
credentials and performs a live connectivity test before saving.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Target environment ID. Required unless <code>environment_name</code> is provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Human-readable environment name. Provide this <strong>or</strong> <code>environment_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Display name for the integration (3-64 characters).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Vault provider. One of: <code>aws_secrets_manager</code>, <code>azure_key_vault</code>, <code>hashicorp_vault</code>.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>auth_method</code></p></td><td><p>Authentication method for the provider (for example, <code>aws_static</code>, <code>azure_sp_secret</code>).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>vault_url</code></p></td><td><p>Vault endpoint URL.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>raw_secrets</code></p></td><td><p>Raw secret credential values keyed by the auth schema’s secret-field key.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>connection_config</code></p></td><td><p>Non-secret connection configuration keyed by the auth schema’s config-field key.</p></td><td><p>No</p></td></tr><tr><td><p><code>description</code></p></td><td><p>Human-readable description (max 512 characters).</p></td><td><p>No</p></td></tr><tr><td><p><code>sync_interval_minutes</code></p></td><td><p>How often (minutes) to re-sync. Must be between <code>120</code> and <code>1440</code>. Default: <code>120</code>.</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "onboard_vault",
  "arguments": {
    "environment_name": "Production",
    "name": "My Azure Vault",
    "provider": "azure_key_vault",
    "auth_method": "azure_sp_secret",
    "vault_url": "https://my-vault.vault.azure.net",
    "raw_secrets": { "azure.spSecret.clientSecret": "" },
    "connection_config": {
      "azure.spSecret.clientId": "",
      "azure.spSecret.tenantId": ""
    },
    "sync_interval_minutes": 120
  }
}
```

Example response (success)

```json
{
  "tool": "onboard_vault",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "environmentName": "Production",
  "created": true,
  "integration": {
    "id": "integration-uuid",
    "name": "My Azure Vault",
    "provider": "azure_key_vault",
    "authMethod": "azure_sp_secret",
    "vaultUrl": "https://my-vault.vault.azure.net",
    "managed": true,
    "version": 1,
    "healthStatus": "healthy",
    "syncIntervalMinutes": 120
  },
  "healthCheck": {
    "status": "connected",
    "permissions": {
      "canList": true,
      "canDescribe": true,
      "canGetValue": true
    },
    "latencyMs": 245
  }
}
```

Example response (connection failed)

```json
{
  "tool": "onboard_vault",
  "organizationId": "org-uuid",
  "created": false,
  "connected": false,
  "reachable": true,
  "missingPermissions": ["canDescribe"],
  "error": "Connection test failed. Integration was NOT saved. Reason: the vault credential is reachable but lacks required permission(s): canDescribe."
}
```

## prepare\_automated\_policy\_creation

Open the automated-policy creation wizard with scope options and policy templates.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "prepare_automated_policy_creation",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "scopeOptions": [
    { "scopeFilter": "apis:*", "label": "All APIs" },
    { "scopeFilter": "apis:tags:public", "label": "APIs tagged public" }
  ],
  "policyTemplates": [
    { "templateId": "rate-limiting", "name": "Rate Limiting", "category": "Quality of Service" },
    {
      "templateId": "client-id-enforcement",
      "name": "Client ID Enforcement",
      "category": "Security"
    },
    { "templateId": "jwt-validation", "name": "JWT Validation", "category": "Security" }
  ]
}
```

## prepare\_guardrail\_creation

Open the guardrail creation wizard with scope options and guardrail rule catalog data, using the
same scope, selection, and naming flow as the web app.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "prepare_guardrail_creation",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "scopeOptions": [
    { "scopeFilter": "apis:*", "label": "All APIs" },
    { "scopeFilter": "apis:tags:public", "label": "APIs tagged public" }
  ],
  "rulesetCatalog": [
    { "rulesetId": "openapi-best-practices", "name": "OpenAPI Best Practices", "ruleCount": 24 },
    { "rulesetId": "pii-redaction", "name": "PII Redaction", "ruleCount": 8 },
    { "rulesetId": "owasp-api-top-10", "name": "OWASP API Top 10", "ruleCount": 10 }
  ]
}
```

## prepare\_policy\_creation

Load policy options for one asset instance. Returns only policies that are not already applied.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Numeric API Manager instance ID (string). Provide this or <code>asset_id</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Exchange API asset ID (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>gateway_id</code></p></td><td><p>Unused on the external Universal API path (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>policy_name_hint</code></p></td><td><p>Filter applicable templates by name (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>kong</code>, <code>apigee</code>, or <code>azure</code> to read the native external catalog (string).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "prepare_policy_creation",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "provider": "kong",
    "policy_name_hint": "rate"
  }
}
```

Example response

```json
{
  "tool": "prepare_policy_creation",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "totalAvailable": 1,
  "policyNameHint": "rate",
  "policies": [{ "templateId": "<template_id>", "name": "<policy_name>" }],
  "via": "apim_universal"
}
```

## remove\_applied\_policy

Permanently remove a single applied policy from a MuleSoft or external gateway instance.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Target API Manager instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>confirmed</code></p></td><td><p><code>true</code> only after explicit user confirmation of permanent removal (boolean).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string). Required for MuleSoft. Omit for external providers.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>policy_id</code></p></td><td><p>Policy ID from <code>view_api_instance_policies</code> (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>mulesoft</code>, <code>kong</code>, <code>apigee</code>, <code>azure-apim</code>, or <code>aws-apigw</code> (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "remove_applied_policy",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "policy_id": "<policy_id>",
    "provider": "kong",
    "confirmed": true
  }
}
```

Example response

```json
{
  "tool": "remove_applied_policy",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "policyId": "<policy_id>",
  "removed": false,
  "status": "pending",
  "via": "apim_universal",
  "httpStatus": 202
}
```

## toggle\_applied\_policy

Enable or disable a single applied policy on a MuleSoft or external gateway instance.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_instance_id</code></p></td><td><p>Target API Manager instance ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>enabled</code></p></td><td><p><code>true</code> enables the policy, <code>false</code> disables it (boolean).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string). Required for MuleSoft. Omit for external providers.</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>policy_id</code></p></td><td><p>Policy ID from <code>view_api_instance_policies</code> (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>provider</code></p></td><td><p><code>mulesoft</code>, <code>kong</code>, <code>apigee</code>, <code>azure-apim</code>, or <code>aws-apigw</code> (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "toggle_applied_policy",
  "arguments": {
    "organization_id": "<organization_id>",
    "api_instance_id": "12345",
    "policy_id": "<policy_id>",
    "enabled": false,
    "provider": "kong"
  }
}
```

Example response

```json
{
  "tool": "toggle_applied_policy",
  "platform": "kong",
  "organizationId": "<organization_id>",
  "apiInstanceId": "12345",
  "policyId": "<policy_id>",
  "enabled": false,
  "status": "success",
  "via": "apim_universal"
}
```

## provision\_mcp\_server

Provision a composite MCP server on Flex Gateway from selected catalog systems.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>base_path</code></p></td><td><p>Base path (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>server_name</code></p></td><td><p>Server name (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>servers</code></p></td><td><p>Servers (array).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>target_id</code></p></td><td><p>Target ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>target_name</code></p></td><td><p>Target name (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "provision_mcp_server",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "server_name": "<server_name>",
    "target_id": "<target_id>",
    "target_name": "<target_name>",
    "base_path": "/<base_path>",check_guardrail_scope_targets
    "servers": [
      {}
    ]
  }
}
```

Example response

```json
{
  "jobId": "job_a1b2c3d4",
  "status": "running",
  "serverName": "Orders MCP Server",
  "basePath": "/mcp/orders",
  "targetId": "fg_8c4e92a1",
  "estimatedDurationSeconds": 90
}
```

## resume\_provision\_job

Resume a failed provisioning or update job from its last checkpoint. Only works on jobs with status
'failed' that have completed steps.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>job_id</code></p></td><td><p>Job ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "resume_provision_job",
  "arguments": {
    "job_id": "<job_id>",
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "jobId": "job_a1b2c3d4",
  "status": "running",
  "resumedFromStep": "deploy-flex-gateway"
}
```

## search\_assets\_semantic

Search portfolio assets using natural language semantic search. Use this when the user asks for
assets related to a concept or use case, not just keyword matching. Examples: 'Find services for
payment processing', 'Search for customer authentication services'. Returns asset names,
descriptions, relevance scores, and types.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_type</code></p></td><td><p>Asset type (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>query</code></p></td><td><p>Query (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>rows</code></p></td><td><p>Rows (integer).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "search_assets_semantic",
  "arguments": {
    "query": "payment processing"
  }
}
```

Example response

```json
{
  "query": "payment processing",
  "results": [
    {
      "assetId": "payments-api",
      "name": "Payments API",
      "assetType": "rest-api",
      "description": "Handles credit card and ACH payment authorization and capture.",
      "relevanceScore": 0.94,
      "version": "1.4.2"
    },
    {
      "assetId": "stripe-mcp-server",
      "name": "Stripe MCP Server",
      "assetType": "mcp",
      "description": "Tools for Stripe charges, refunds, and customer management.",
      "relevanceScore": 0.87,
      "version": "0.5.0"
    }
  ],
  "total": 6
}
```

## search\_global\_assets

Compatibility alias for global content search. Searches across agents, MCP servers, and APIs in one
business group. You must pass exactly one business\_group\_id.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>business_group_id</code></p></td><td><p>Business group ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>query</code></p></td><td><p>Query (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>size</code></p></td><td><p>Size (integer).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "search_global_assets",
  "arguments": {
    "query": "payment processing",
    "business_group_id": "<business_group_id>"
  }
}
```

Example response

```json
{
  "query": "payment processing",
  "businessGroupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "results": [
    {
      "assetId": "payments-api",
      "name": "Payments API",
      "assetType": "rest-api",
      "relevanceScore": 0.94
    },
    {
      "assetId": "stripe-mcp-server",
      "name": "Stripe MCP Server",
      "assetType": "mcp",
      "relevanceScore": 0.87
    },
    {
      "assetId": "fraud-detection-agent",
      "name": "Fraud Detection Agent",
      "assetType": "agent",
      "relevanceScore": 0.71
    }
  ],
  "total": 8
}
```

## search\_global\_content

UI tool for embedded agents to search content across agents, MCP servers, and APIs in the Omni
Platform.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>business_group_id</code></p></td><td><p>Business group ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>query</code></p></td><td><p>Query (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>size</code></p></td><td><p>Size (integer).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "search_global_content",
  "arguments": {
    "query": "payment processing",
    "business_group_id": "<business_group_id>"
  }
}
```

Example response

```json
{
  "query": "payment processing",
  "businessGroupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "results": [
    {
      "assetId": "payments-api",
      "name": "Payments API",
      "assetType": "rest-api",
      "snippet": "Handles credit card and ACH payment authorization and capture.",
      "relevanceScore": 0.94
    },
    {
      "assetId": "stripe-mcp-server",
      "name": "Stripe MCP Server",
      "assetType": "mcp",
      "snippet": "Tools for Stripe charges, refunds, and customer management.",
      "relevanceScore": 0.87
    }
  ],
  "total": 8
}
```

## search\_portfolio\_services

Use this tool to discover assets based on capabilities and use cases.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_type</code></p></td><td><p>Asset type (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>max_results</code></p></td><td><p>Max results (integer).</p></td><td><p>No</p></td></tr><tr><td><p><code>query</code></p></td><td><p>Query (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "search_portfolio_services",
  "arguments": {
    "query": "payment processing"
  }
}
```

Example response

```json
{
  "query": "payment processing",
  "results": [
    {
      "assetId": "payments-api",
      "name": "Payments API",
      "assetType": "rest-api",
      "description": "Handles credit card and ACH payment authorization and capture.",
      "version": "1.4.2",
      "relevanceScore": 0.94
    },
    {
      "assetId": "stripe-mcp-server",
      "name": "Stripe MCP Server",
      "assetType": "mcp",
      "description": "Tools for Stripe charges, refunds, and customer management.",
      "version": "0.5.0",
      "relevanceScore": 0.87
    },
    {
      "assetId": "fraud-detection-agent",
      "name": "Fraud Detection Agent",
      "assetType": "agent",
      "description": "Scores transactions for fraud risk before settlement.",
      "version": "1.1.0",
      "relevanceScore": 0.71
    }
  ],
  "total": 11
}
```

## search\_repository\_knowledge

Use this tool for repository-grounded conceptual questions. It searches a curated static corpus
(policy/governance/security docs and rulesets) and returns cited snippets.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>lexical_top_n</code></p></td><td><p>Lexical top n (integer).</p></td><td><p>No</p></td></tr><tr><td><p><code>query</code></p></td><td><p>Query (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>source_path_prefixes</code></p></td><td><p>Source path prefixes (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>top_k</code></p></td><td><p>Top k (integer).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "search_repository_knowledge",
  "arguments": {
    "query": "payment processing"
  }
}
```

Example response

```json
{
  "query": "payment processing",
  "matches": [
    {
      "sourcePath": "docs/policies/security/jwt-validation.md",
      "snippet": "Use JWT Validation policy to authenticate requests carrying bearer tokens issued by your IdP...",
      "lexicalScore": 0.62,
      "semanticScore": 0.81,
      "metadata": { "category": "security", "lastModified": "2026-02-14" }
    },
    {
      "sourcePath": "docs/governance/rulesets/owasp-api-top-10.md",
      "snippet": "OWASP API Top 10 ruleset addresses broken object-level authorization and excessive data exposure...",
      "lexicalScore": 0.41,
      "semanticScore": 0.74,
      "metadata": { "category": "governance", "lastModified": "2026-01-30" }
    }
  ],
  "total": 5
}
```

## search\_secrets

Search for secrets by name across all secret groups in an environment.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization UUID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Target Anypoint environment UUID. Required unless <code>environment_name</code> is provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Human-readable environment name. Provide this <strong>or</strong> <code>environment_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>search_term</code></p></td><td><p>The secret name (or partial name) to search for. Must be at least 3 characters.</p></td><td><p>Yes</p></td></tr><tr><td><p><code>limit</code></p></td><td><p>Maximum number of results to return (default: <code>25</code>, max: <code>100</code>).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "search_secrets",
  "arguments": {
    "environment_name": "Production",
    "search_term": "api-key",
    "limit": 50
  }
}
```

Example response

```json
{
  "tool": "search_secrets",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "environmentName": "Production",
  "searchTerm": "api-key",
  "results": [
    {
      "name": "my-api-key",
      "type": "sharedSecret",
      "secretGroupName": "Vault-A",
      "expirationDate": "2027-01-01"
    },
    {
      "name": "stripe-api-key",
      "type": "sharedSecret",
      "secretGroupName": "Payments",
      "expirationDate": "2026-12-15"
    }
  ],
  "count": 2
}
```

## select\_active\_business\_group

Set the current active business group context and optionally set a new active business group by
passing business\_group\_id.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>business_group_id</code></p></td><td><p>Business group ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>name</code></p></td><td><p>Name (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "select_active_business_group",
  "arguments": {
    "business_group_id": "<business_group_id>",
    "name": "<name>"
  }
}
```

Example response

```json
{
  "activeBusinessGroup": {
    "businessGroupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
    "name": "Acme Corp"
  },
  "changed": true
}
```

## select\_active\_environment

Browse the available Anypoint environments for the active MuleSoft provider and set one as the
active environment context.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "select_active_environment",
  "arguments": {
    "environment_id": "<environment_id>",
    "organization_id": "<organization_id>",
    "provider_id": "<provider_id>"
  }
}
```

Example response

```json
{
  "activeEnvironment": {
    "environmentId": "e1f3b920-4c8a-11ee-be56-0242ac120002",
    "name": "production",
    "type": "production",
    "isProduction": true
  },
  "changed": true
}
```

## select\_active\_provider

Browse the available providers and set one as the active provider context for follow-on provider
tools.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>provider_id</code></p></td><td><p>Provider ID (string or null).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "select_active_provider",
  "arguments": {
    "provider_id": "<provider_id>"
  }
}
```

Example response

```json
{
  "activeProvider": {
    "providerId": "p_mulesoft_default",
    "name": "MuleSoft",
    "type": "mulesoft"
  },
  "changed": true
}
```

## select\_api\_version

Show an interactive version selector for an API and notify the host when the user picks a version.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "select_api_version",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "assetId": "orders-api",
  "selectedVersion": "2.1.0",
  "versions": [
    { "version": "2.1.0", "lifecycleState": "stable", "createdDate": "2026-03-12T08:21:43.000Z" },
    {
      "version": "2.0.0",
      "lifecycleState": "deprecated",
      "createdDate": "2025-11-04T11:09:22.000Z"
    },
    {
      "version": "1.4.0",
      "lifecycleState": "deprecated",
      "createdDate": "2025-06-18T14:32:18.000Z"
    }
  ]
}
```

## show\_observability\_performance

Load observability dashboards data for embedded MCP app rendering.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>environment</code></p></td><td><p>Environment (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Provider (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time range (string).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "show_observability_performance",
  "arguments": {
    "environment": "sandbox",
    "provider": "mulesoft",
    "time_range": "7d"
  }
}
```

Example response

```json
{
  "environment": "sandbox",
  "provider": "mulesoft",
  "timeRange": "7d",
  "kpis": {
    "totalRequests": 612430,
    "avgLatencyMs": 218,
    "errorRate": 0.009
  },
  "topServices": [
    { "assetId": "orders-api", "name": "Orders API", "requests": 184028, "avgLatencyMs": 287 },
    { "assetId": "payments-api", "name": "Payments API", "requests": 142810, "avgLatencyMs": 214 }
  ]
}
```

## test\_integration\_connection

Validate vault connectivity and credential permissions. Supports two modes: **pre-create** (supply
provider, auth method, URL, and credentials to test before saving) and **post-create** (supply an
integration name or ID to test an already-saved integration).

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Anypoint organization ID. When omitted, the caller’s authenticated org is used.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Target environment ID. Required unless <code>environment_name</code> is provided.</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_name</code></p></td><td><p>Human-readable environment name. Provide this or <code>environment_id</code>, not both.</p></td><td><p>No</p></td></tr><tr><td><p><code>integration_name</code></p></td><td><p>Post-create mode: human-readable vault integration name. Provide this or <code>integration_id</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>integration_id</code></p></td><td><p>Post-create mode: vault integration UUID. Provide this or <code>integration_name</code>.</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Pre-create mode: vault provider (<code>aws_secrets_manager</code>, <code>azure_key_vault</code>, <code>hashicorp_vault</code>).</p></td><td><p>No</p></td></tr><tr><td><p><code>auth_method</code></p></td><td><p>Pre-create mode: authentication method for the provider.</p></td><td><p>No</p></td></tr><tr><td><p><code>vault_url</code></p></td><td><p>Pre-create mode: vault endpoint URL.</p></td><td><p>No</p></td></tr><tr><td><p><code>raw_secrets</code></p></td><td><p>Pre-create managed flow: credential values.</p></td><td><p>No</p></td></tr><tr><td><p><code>connection_config</code></p></td><td><p>Non-secret connection configuration.</p></td><td><p>No</p></td></tr><tr><td><p><code>credential_refs</code></p></td><td><p>Pre-create reference flow: credential references.</p></td><td><p>No</p></td></tr><tr><td><p><code>managed</code></p></td><td><p>Pre-create mode: <code>true</code> for managed flow, <code>false</code> for reference flow. Defaults based on <code>raw_secrets</code> presence.</p></td><td><p>No</p></td></tr></tbody></table>

Example request (post-create)

```json
{
  "name": "test_integration_connection",
  "arguments": {
    "environment_name": "Production",
    "integration_name": "My Azure Vault"
  }
}
```

Example request (pre-create managed)

```json
{
  "name": "test_integration_connection",
  "arguments": {
    "environment_name": "Production",
    "provider": "azure_key_vault",
    "auth_method": "azure_sp_secret",
    "vault_url": "https://my-vault.vault.azure.net",
    "raw_secrets": {
      "azure.spSecret.clientSecret": ""
    },
    "connection_config": {
      "azure.spSecret.clientId": "",
      "azure.spSecret.tenantId": ""
    }
  }
}
```

Example response (fully connected)

```json
{
  "tool": "test_integration_connection",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "environmentName": "Production",
  "integrationId": "integration-uuid",
  "mode": "post_create",
  "connected": true,
  "reachable": true,
  "requiredPermissions": ["canList", "canDescribe", "canGetValue"],
  "result": {
    "status": "connected",
    "permissions": {
      "canList": true,
      "canDescribe": true,
      "canGetValue": true
    },
    "latencyMs": 180
  }
}
```

Example response (under-permissioned)

```json
{
  "tool": "test_integration_connection",
  "organizationId": "org-uuid",
  "environmentId": "env-uuid",
  "mode": "pre_create",
  "connected": false,
  "reachable": true,
  "missingPermissions": ["canGetValue"],
  "warning": "The vault is reachable but the credential is missing required permission(s): canGetValue.",
  "result": {
    "status": "connected",
    "permissions": {
      "canList": true,
      "canDescribe": true,
      "canGetValue": false
    }
  }
}
```

## test\_scanner\_connection

Test connection to a scanner provider before creating the scanner.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>auth_fields</code></p></td><td><p>Auth fields (ScannerAuthFields or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>auth_method</code></p></td><td><p>Auth method (string).</p></td><td><p>No</p></td></tr><tr><td><p><code>provider</code></p></td><td><p>Provider (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "test_scanner_connection",
  "arguments": {
    "provider": "mulesoft"
  }
}
```

Example response

```json
{
  "provider": "mulesoft",
  "authMethod": "service-account",
  "connectionStatus": "success",
  "latencyMs": 142
}
```

## update\_mcp\_server

Update an existing catalog-managed MCP server. Diffs new configuration against deployed state and
applies incremental changes. Returns a job\_id for status polling. Requires state from
get\_mcp\_server\_state.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_id</code></p></td><td><p>API ID (integer).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>current_upstream_ids</code></p></td><td><p>Current upstream IDs (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>deployed_systems</code></p></td><td><p>Deployed systems (array or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>environment_id</code></p></td><td><p>Environment ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>server_name</code></p></td><td><p>Server name (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>servers</code></p></td><td><p>Servers (array).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>target_id</code></p></td><td><p>Target ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>target_name</code></p></td><td><p>Target name (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "update_mcp_server",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "asset_id": "<asset_id>",
    "api_id": "<api_id>",
    "server_name": "<server_name>",
    "target_id": "<target_id>",
    "target_name": "<target_name>",
    "servers": [{}]
  }
}
```

Example response

```json
{
  "jobId": "job_b5c6d7e8",
  "status": "running",
  "assetId": "orders-mcp-server",
  "diff": {
    "addedSystems": ["github"],
    "removedSystems": [],
    "updatedSystems": ["salesforce"]
  }
}
```

## view\_agent\_details

Show read-only details for one agent, including versions, instances, and metadata.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_agent_details",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "assetId": "invoice-approval-agent",
  "name": "Invoice Approval Agent",
  "description": "Routes invoices to approvers based on amount thresholds.",
  "provider": "mulesoft",
  "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "versions": [
    { "version": "1.2.0", "lifecycleState": "stable", "createdDate": "2026-04-01T08:21:43.000Z" },
    {
      "version": "1.1.0",
      "lifecycleState": "deprecated",
      "createdDate": "2026-01-15T11:09:22.000Z"
    }
  ],
  "instances": [
    {
      "instanceId": "16834561",
      "environment": "production",
      "endpoint": "https://agents.acme.com/invoice-approval"
    }
  ]
}
```

## view\_api\_instance\_details

Show details for one API instance with a web-aligned header. Accepts either an instance object or
identifiers to resolve it.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>API version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance</code></p></td><td><p>Instance (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Instance ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_api_instance_details",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "instanceId": "16834521",
  "assetId": "orders-api",
  "assetVersion": "2.1.0",
  "apiVersion": "v2",
  "endpoint": "https://api.acme.com/orders",
  "environment": "production",
  "deploymentType": "cloudhub2",
  "status": "active",
  "appliedPolicyCount": 4,
  "createdDate": "2026-03-12T08:21:43.000Z"
}
```

## view\_api\_instance\_monitoring

Show instance monitoring charts, traffic, and clients for one API instance.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>API version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance</code></p></td><td><p>Instance (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Instance ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>time_range</code></p></td><td><p>Time range (string).</p></td><td><p>No</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_api_instance_monitoring",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "instanceId": "16834521",
  "assetId": "orders-api",
  "timeRange": "24h",
  "charts": {
    "requests": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 4218 }],
    "errorRate": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 0.012 }],
    "avgLatency": [{ "timestamp": "2026-05-07T13:00:00Z", "value": 287 }]
  },
  "topClients": [{ "clientId": "c_4f8a91d2", "clientName": "checkout-web", "requests": 21408 }]
}
```

## view\_api\_instance\_policies

Show the applied policies for one API instance with the same grouping UI as the web app.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>API version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance</code></p></td><td><p>Instance (object or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>instance_id</code></p></td><td><p>Instance ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_api_instance_policies",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "instanceId": "16834521",
  "assetId": "orders-api",
  "policiesByCategory": {
    "Security": [
      {
        "policyId": "p_4f8a91d2",
        "templateId": "client-id-enforcement",
        "name": "Client ID Enforcement",
        "order": 1,
        "disabled": false
      },
      {
        "policyId": "p_2f1a8e44",
        "templateId": "jwt-validation",
        "name": "JWT Validation",
        "order": 2,
        "disabled": false
      }
    ],
    "Quality of Service": [
      {
        "policyId": "p_8c4e92a1",
        "templateId": "rate-limiting",
        "name": "Rate Limiting",
        "order": 3,
        "disabled": false
      }
    ]
  },
  "totalCount": 4
}
```

## view\_api\_version\_details

Show read-only details for one API version, including instances, metadata, and lifecycle fields.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>API version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>version</code></p></td><td><p>Version (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_api_version_details",
  "arguments": {
    "version": "1.0.0"
  }
}
```

Example response

```json
{
  "assetId": "orders-api",
  "version": "2.1.0",
  "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "lifecycleState": "stable",
  "createdDate": "2026-03-12T08:21:43.000Z",
  "instances": [
    { "instanceId": "16834521", "environment": "production" },
    { "instanceId": "16834522", "environment": "sandbox" }
  ]
}
```

## view\_api\_version\_governance\_report

Show governance ruleset report summary and findings for one API version.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_name</code></p></td><td><p>API name (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>api_version</code></p></td><td><p>API version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>group_id</code></p></td><td><p>Group ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>version</code></p></td><td><p>Version (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_api_version_governance_report",
  "arguments": {
    "organization_id": "<organization_id>",
    "group_id": "<group_id>",
    "asset_id": "<asset_id>",
    "version": "1.0.0"
  }
}
```

Example response

```json
{
  "assetId": "orders-api",
  "apiName": "Orders API",
  "version": "2.1.0",
  "summary": {
    "conformanceStatus": "non-compliant",
    "errorCount": 2,
    "warningCount": 5,
    "infoCount": 1
  },
  "rulesets": [
    {
      "rulesetId": "openapi-best-practices",
      "name": "OpenAPI Best Practices",
      "errorCount": 2,
      "warningCount": 5,
      "findings": [
        {
          "ruleId": "operation-success-response",
          "severity": "error",
          "path": "paths./orders.post",
          "message": "Operation 'POST /orders' is missing a 2xx response."
        }
      ]
    }
  ]
}
```

## view\_api\_version\_instances

Show available instances for one API version and allow selecting instances to send back to the host.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>api_version</code></p></td><td><p>API version (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_api_version_instances",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>",
    "api_version": "v1"
  }
}
```

Example response

```json
{
  "assetId": "orders-api",
  "apiVersion": "v2",
  "instances": [
    {
      "instanceId": "16834521",
      "environment": "production",
      "endpoint": "https://api.acme.com/orders",
      "status": "active"
    },
    {
      "instanceId": "16834522",
      "environment": "sandbox",
      "endpoint": "https://api-sandbox.acme.com/orders",
      "status": "active"
    }
  ]
}
```

## view\_governance\_report

Fetch the latest Governance Strategy report for an organization and render it in an interactive MCP
app panel.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_governance_report",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}
```

Example response

```json
{
  "organizationId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "summary": {
    "totalServices": 49,
    "compliant": 38,
    "nonCompliant": 9,
    "pending": 2
  },
  "byConcernArea": {
    "security-privacy": { "errorCount": 4, "warningCount": 11 },
    "consumption-economic-governance": { "errorCount": 1, "warningCount": 3 },
    "structural-conformity-lifecycle": { "errorCount": 2, "warningCount": 5 }
  },
  "topViolations": [
    { "rulesetId": "openapi-best-practices", "name": "OpenAPI Best Practices", "violationCount": 7 }
  ]
}
```

## view\_llm\_details

Show read-only details for one LLM model, including versions, instances, and metadata.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_llm_details",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "assetId": "claude-opus-4-7",
  "name": "Claude Opus 4.7",
  "provider": "anthropic",
  "category": "general-purpose",
  "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "versions": [
    { "version": "1.0.0", "lifecycleState": "stable", "createdDate": "2026-04-22T08:21:43.000Z" }
  ],
  "instances": [
    {
      "instanceId": "16834581",
      "environment": "production",
      "endpoint": "https://llm.acme.com/claude-opus-4-7"
    }
  ],
  "metadata": {
    "contextWindow": 200000,
    "modalities": ["text", "vision"]
  }
}
```

## view\_mcp\_server\_details

Show read-only details for one MCP server, including versions, instances, and metadata.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Parameter</th><th>Description</th><th>Required</th></tr></thead><tbody><tr><td><p><code>asset_id</code></p></td><td><p>Asset ID (string).</p></td><td><p>Yes</p></td></tr><tr><td><p><code>asset_version</code></p></td><td><p>Asset version (string or null).</p></td><td><p>No</p></td></tr><tr><td><p><code>organization_id</code></p></td><td><p>Organization ID (string).</p></td><td><p>Yes</p></td></tr></tbody></table>

Example request

```json
{
  "name": "view_mcp_server_details",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}
```

Example response

```json
{
  "assetId": "orders-mcp-server",
  "name": "Orders MCP Server",
  "description": "MCP server exposing Orders API operations as tools.",
  "protocol": "streamable-http",
  "groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
  "versions": [
    { "version": "1.0.0", "lifecycleState": "stable", "createdDate": "2026-04-22T08:21:43.000Z" }
  ],
  "instances": [
    {
      "instanceId": "16834571",
      "environment": "production",
      "endpoint": "https://mcp.acme.com/orders",
      "status": "active"
    }
  ],
  "tools": [
    { "name": "list-orders", "description": "List orders for a customer." },
    { "name": "get-order", "description": "Get a single order by ID." },
    { "name": "cancel-order", "description": "Cancel an order." }
  ]
}
```

<!-- document id=0e3a3abf12617b5bccff796434651b6dbb7bb10b160a819d2b56e6026a263151 url=/mulesoft/current/en-us/mulesoft-mcp-server/using-mulesoft-mcp-server.md -->

---
product: MuleSoft MCP Servers
---

# Using MuleSoft DX MCP Server

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft DX MCP Server integrates with MuleSoft Vibes so that you can build, deploy, and manage
projects using natural language prompts. Whether you use Anypoint Code Builder, Cursor, Windsurf, or
another MCP-compatible IDE, you keep the full Mule application lifecycle in your editor.

To learn more about MuleSoft Vibes, see
[Get Started with MuleSoft Vibes](https://docs.mulesoft.com/anypoint-code-builder/vibes-get-started).

To learn more about the MuleSoft DX MCP Server tools, see
[MuleSoft DX MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools).

## Before You Begin

Before you get started, make sure you meet these prerequisites.

- If you’re using Anypoint Code Builder, make sure that you:

  - [Set up and access the desktop IDE](https://docs.mulesoft.com/anypoint-code-builder/start-acb).

  - Set the
    [required Anypoint Code Builder permissions](https://docs.mulesoft.com/anypoint-code-builder/start-configure-permissions#permissions),
    including the Mule Developer Generative AI User permission.

  - [Enabling or Disabling Generative AI for Anypoint Platform](https://docs.mulesoft.com/access-management/enabling-generative-ai).

- If you’re using Cursor, Windsurf, or any MCP-compatible IDE, make sure you set up and configure
  MuleSoft DX MCP Server for your IDE, including all permissions. See
  [Getting Started with MuleSoft DX MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started).

## Example: Create a Network Using MuleSoft Vibes

1.  In the Anypoint Code Builder activity bar (or similar location in your IDE), click the agent
    icon ![](/mulesoft/current/en-us/mulesoft-mcp-server/_images/af-acb-dev-agent-icon.png).

2.  In the prompt field, describe your agent network, including the brokers, agents, MCP servers,
    and LLMs you want to connect. MuleSoft Vibes does the rest.

For example, consider this prompt entered using the agent’s
[Plan mode](https://docs.mulesoft.com/anypoint-code-builder/vibes-get-started#plan-and-act-modes):
`Create a new agent network project called "Employee Onboarding." Add HR agent and CRM agent.`

The agent asks for `projectPath`, which is a required parameter for the
[`create_agent_network_project`](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools#create-agent-network-project) tool.

After successfully running, the agent creates an `agent-network.yaml` file and responds with a final
success summary.

```json
{
  "success": true,
  "projectPath": "/Users/test/src/mulesoft/mulesoft-mcp-server/Employee Onboarding",
  "message": "Employee Onboarding agent network created successfully",
  "components": {
    "agents": ["hr-agent", "crm-agent"],
    "brokers": ["onboarding-coordinator"],
    "connections": 1,
    "filesCreated": ["agent-network.yaml", "exchange.json", "README.md"]
  },
  "nextSteps": [
    "Deploy to runtime environment using deploy_agent_network",
    "Publish to Exchange using publish_agent_network_assets",
    "Open project in workspace using open_project"
  ],
  "validationStatus": "passed"
}
```

## Example Prompts

Use these example prompts to guide MuleSoft Vibes in completing common tasks. Customize the values
to match your project or environment.

### Application Deployment and Projects

- **Task**: Deploy an app to CloudHub or Runtime Fabric.

  **Prompt**: Deploy the \[application\_name\] app from Anypoint Exchange.

- **Task**: Create an integration project.

  **Prompt**: Create a Mule project that creates an order in NetSuite every time an opportunity in
  Salesforce is updated to the ‘Closed Won’ stage.

- **Task**: Deploy an integration application.

  **Prompt**: Deploy \[application\_name\] app in the current project. Deploy it with high security,
  high availability, and performance optimized settings.

- **Task**: Modify an existing application.

  **Prompt**: Update \[application\_name\] so that it meets \[specific business requirements\].

- **Task**: Generate an MCP server using Anypoint connectors.

  **Prompt**: Generate an MCP server that exposes three tools from the following operations:
  Workday - Absence Management - Get Time Off Plan Balances, Workday - Absence Management - Enter
  Time Off, and Google Calendar - Create Calendar Event.

### Exchange Asset Management

- **Task**: Create an asset in Exchange.

  **Prompt**: Publish \[this asset type\] in Exchange using this \[name\].

- **Task**: Search for an asset in Exchange.

  **Prompt**: Do I have any assets for order notifications in Exchange?

- **Task**: Search for an asset within a specific organization.

  **Prompt**: Find \[asset name\] in \[organization name\].

### API Instances

- **Task**: Create an app instance and apply a policy.

  **Prompt**: Create an instance for the \[application\_name\] and apply the rate limiting policy to
  that instance.

- **Task**: View performance metrics for your APIs or apps.

  **Prompt**: Which apps generated the most errors this month?

### Custom Metadata

- **Task**: Set custom metadata that uses sample data.

  **Prompt**: Can you help me define custom metadata on the following component? This is how the
  sample data looks: \[sample data\].

- **Task**: Set custom metadata using a file.

  **Prompt**: Define custom metadata using the sample file below and attach it to
  \[processor\_name\] @\[path\_to\_file\].

### Agent Network Operations

- **Task**: Create an Agent Network

  **Prompt**: Create an Agent Network for called "Employee Onboarding".

- **Task**: Publish an Agent Network.

  **Prompt**: Publish the "Employee Onboarding" Agent Network project to Exchange.

- **Task**: Deploy an instance of the "Employee Onboarding" Agent Network to staging.

  **Prompt**: Deploy this Agent Network project.

<!-- document id=ee8b08c6ce76ca8fc57dcee2eeeb001945689972889d391eecec30064d7e2868 url=/mulesoft/current/en-us/mulesoft-mcp-server/using-mulesoft-platform-mcp-server.md -->

---
product: MuleSoft MCP Servers
---

# Using MuleSoft Platform MCP Server

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Get governed access to your entire agentic landscape, including APIs, agents, MCP servers, and LLMs,
to accelerate production-ready AI at scale using MuleSoft Platform MCP Server. Use it to you scan,
discover, govern, and monitor services across the infrastructure you already run. Integrations with
MuleSoft Vibes or various AI clients, including Claude, Windsurf, and Cursor enables you to access
your assets wherever you want.

To learn more about how to set up MuleSoft Platform MCP Server, see
[Getting Started with MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started-platform).

To learn more about MuleSoft Platform MCP Server tools, see
[MuleSoft Platform MCP Server Tool Reference](https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform).

## Before You Begin

Before you get started, make sure you complete the setup and configuration steps, including
permissions, in [Getting Started with MuleSoft Platform MCP Server](https://docs.mulesoft.com/mulesoft-mcp-server/getting-started-platform).

## Example: Applying Policies Across MuleSoft Platform

1.  From your IDE or AI assistant, authenticate into your org.

2.  In the prompt field, ask the agent to apply a policy to a specific API.

For example, use this prompt: `Help me set up a rate-limiting policy on my Stripe API.`

The agent calls `prepare_policy_creation` to fetch available policies for the target API instance:

```json
{
  "name": "prepare_policy_creation",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>",
    "policy_name_hint": "rate-limiting"
  }
}
```

This returns a list of applicable policies for the target API instance. The user selects a policy,
and the agent calls `get_policy_template_form` to present configuration options. After the user
specifies the policy configuration, the agent calls `apply_policy_to_instance` to apply the policy
immediately.

## Example Prompts

Use prompts like these to explore key platform workflows:

- Search and browse: `Show me all payment-related APIs across my organization.`

- Govern and secure:
  `Create a governance strategy that applies a PII detection policy to all customer-facing agents.`

- Monitor and analyze: `Which LLMs consumed the most requests last week?`