---
schema_version: "1"
id: eb9c66c8bfe1e03febfbb94fb0c411761e2c76f978f23db9bdb410c1ef0d07fa
title: MuleSoft Platform MCP Server Tool Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/mulesoft-mcp-server/reference-mcp-tools-platform.md
canonical_url: https://docs.mulesoft.com/mulesoft-mcp-server/reference-mcp-tools-platform
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 6cc385294673b886c61dcfdb122e8b5070a01cab72fb1546b59a946e339808a4
description: MuleSoft Documentation Site
latest: true
---
---
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." }
  ]
}
```
