-
API Manager: Manage Policies
-
API Manager: View APIs Configuration
-
API Manager: View Policies
-
Anypoint Monitoring: Monitoring Viewer
-
Exchange: Exchange Viewer
-
Anypoint Code Builder: Mule Developer Generative AI User (Optional)
MuleSoft Platform MCP Server Tool Reference
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 for setup and authentication, including the Connected App scopes that map to each permission tier.
Command Summary
| Category | Tool | Required Permission Scopes |
|---|---|---|
Authentication |
None |
|
None |
||
Business Group & Org |
read:organization |
|
read:organization |
||
read:organization |
||
read:organization |
||
read:organization |
||
API Management |
exchange:exchange_viewer |
|
read:organization |
||
apimanager:environment_viewer |
||
apimanager:environment_viewer |
||
monitoring:viewer |
||
apimanager:environment_viewer |
||
exchange:exchange_viewer |
||
apimanager:environment_viewer |
||
Policy Management |
apimanager:environment_admin |
|
apimanager:environment_admin |
||
apimanager:environment_admin |
||
apimanager:environment_viewer |
||
apimanager:environment_viewer |
||
apimanager:environment_viewer |
||
apimanager:environment_viewer |
||
apimanager:environment_viewer |
||
Governance |
apimanager:environment_viewer |
|
governance:viewer |
||
governance:administrator |
||
governance:administrator |
||
governance:viewer |
||
governance:viewer |
||
apimanager:environment_viewer |
||
apimanager:environment_viewer |
||
governance:viewer |
||
governance:viewer |
||
Monitoring & Observability |
monitoring:viewer |
|
monitoring:viewer |
||
monitoring:viewer |
||
monitoring:viewer |
||
Search & Discovery |
exchange:exchange_viewer |
|
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
exchange:exchange_viewer |
||
MCP Servers |
exchange:exchange_contributor |
|
exchange:exchange_contributor |
||
exchange:exchange_contributor |
||
exchange:exchange_viewer |
||
exchange:exchange_contributor |
||
exchange:exchange_contributor |
||
exchange:exchange_contributor |
||
exchange:exchange_viewer |
||
Agents |
exchange:exchange_viewer |
|
exchange:exchange_viewer |
||
LLMs |
exchange:exchange_viewer |
|
exchange:exchange_viewer |
||
Cost Management |
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Omni Gateway |
runtime:deploy_applications |
|
runtime:deploy_applications |
||
runtime:deploy_applications |
||
runtime:deploy_applications |
||
runtime:deploy_applications |
||
Scanners |
runtime:deploy_applications |
|
runtime:deploy_applications |
||
runtime:deploy_applications |
||
Secrets Manager |
Manage vault integrations, read secrets metadata, and manage secret groups |
|
Manage vault integrations |
||
Manage vault integrations |
||
Manage vault integrations, read secrets metadata, and manage secret groups |
||
Manage vault integrations |
||
Manage vault integrations, read secrets metadata, and manage secret groups |
||
Manage vault integrations |
apply_policy_to_instance
Apply the selected policy to the target asset instance using the provided configuration data.
| Parameter | Description | Required |
|---|---|---|
|
API instance ID (string). |
Yes |
|
Asset ID (string or null). |
No |
|
Asset version (string or null). |
No |
|
Configuration data (PolicyConfigurationData or null). |
No |
|
Disabled (boolean or null). |
No |
|
Environment ID (string). |
Yes |
|
Group ID (string or null). |
No |
|
Order (integer or null). |
No |
|
Organization ID (string). |
Yes |
|
Pointcut data (PolicyPointcutData or null). |
No |
|
Policy template ID (string or null). |
No |
{
"name": "apply_policy_to_instance",
"arguments": {
"organization_id": "<organization_id>",
"environment_id": "<environment_id>",
"api_instance_id": "<api_instance_id>"
}
}
{
"policyId": "p_4f8a91d2",
"apiInstanceId": "16834521",
"policyTemplateId": "client-id-enforcement",
"assetId": "client-id-enforcement",
"assetVersion": "1.3.3",
"order": 1,
"disabled": false,
"status": "applied"
}
check_guardrail_scope_targets
Preview APIs matched by a guardrail scope filter.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Scope filter (string). |
Yes |
{
"name": "check_guardrail_scope_targets",
"arguments": {
"scope_filter": "apis:*"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API instance ID (string). |
Yes |
|
Asset ID (string or null). |
No |
|
Asset version (string or null). |
No |
|
Configuration data (PolicyConfigurationData or null). |
No |
|
Disabled (boolean or null). |
No |
|
Environment ID (string). |
Yes |
|
Group ID (string or null). |
No |
|
Order (integer or null). |
No |
|
Organization ID (string). |
Yes |
|
Pointcut data (PolicyPointcutData or null). |
No |
|
Policy template ID (string or null). |
No |
{
"name": "check_policy_conformance",
"arguments": {
"organization_id": "<organization_id>",
"environment_id": "<environment_id>",
"api_instance_id": "<api_instance_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization ID. When omitted, the caller’s authenticated org is used. |
No |
|
Target Anypoint environment ID. Required unless |
No |
|
Human-readable environment name. Provide this or |
No |
|
Human-readable name of the secret group (as returned by |
No |
|
Human-readable name of the secret. Pair with |
No |
|
ID of the secret group. Pair with |
No |
|
ID of the secret. Pair with |
No |
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.
|
{
"name": "check_secret",
"arguments": {
"environment_name": "Production",
"secret_group_name": "My Group",
"secret_name": "my-api-key"
}
}
{
"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"
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Allow duplicated (boolean). |
No |
|
Automated policy configuration (object or null). |
No |
|
Automated policy endpoint type groups (array or null). |
No |
|
Automated policy endpoint type mode (string). |
No |
|
Automated policy environment ID (string or null). |
No |
|
Automated policy ID (string or null). |
No |
|
Automated policy runtime (string or null). |
No |
|
Automated policy runtime range from (string or null). |
No |
|
Automated policy runtime range to (string or null). |
No |
|
Description (string). |
No |
|
Name (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Scope filter (string or null). |
No |
{
"name": "create_automated_policy_strategy",
"arguments": {
"organization_id": "<organization_id>",
"name": "Auto-apply rate limiting"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Description (string). |
No |
|
Governance target type (string). |
No |
|
Name (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Position (integer or null). |
No |
|
Rules (array or null). |
No |
|
Rulesets (array or null). |
No |
|
Schedule config (object or null). |
No |
|
Scope condition mode (string). |
No |
|
Scope conditions (array or null). |
No |
|
Scope filter (string or null). |
No |
|
Strategy status (string). |
No |
|
Strategy type (string). |
No |
{
"name": "create_guardrail",
"arguments": {
"description": "",
"governance_target_type": "service-assets",
"name": "<name>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Token amount allocated for the wallet budget. |
Yes |
|
Budget replenishment period (for example, |
Yes |
|
Required JWT claims that must match for budget grants (array or null). |
No |
|
Environment ID to scope the wallet. |
Yes |
|
Model ID to associate with the wallet budget. |
Yes |
|
Organization ID to scope the wallet. |
Yes |
|
Wallet name or ID. |
Yes |
{
"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"]
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID (string or null). |
No |
|
Environment name (string or null). |
No |
|
Environment type (string or null). |
No |
|
Governance override warnings (boolean). |
No |
|
Organization ID (string or null). |
No |
|
Payload (FlexGatewayCreatePayload or null). |
No |
|
Provider ID (string or null). |
No |
|
Target type (string or null). |
No |
{
"name": "create_omni_gateway",
"arguments": {
"environment_id": "<environment_id>",
"environment_name": "<environment_name>",
"environment_type": "<environment_type>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Auth fields (ScannerAuthFields or null). |
No |
|
Auth fields alias (ScannerAuthFields or null). |
No |
|
Auth method (string or null). |
No |
|
Auth method alias (string or null). |
No |
|
Description (string). |
No |
|
Filters (array or null). |
No |
|
Name (string or null). |
No |
|
Notifications (ScannerNotifications or null). |
No |
|
Organization ID (string or null). |
No |
|
Owner ID (string or null). |
No |
|
Provider (string or null). |
No |
|
Schedule (ScannerSchedule or null). |
No |
{
"name": "create_scanner",
"arguments": {
"auth_fields": {},
"auth_fields_alias": {},
"auth_method": "<auth_method>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Strategy ID (string). |
Yes |
{
"name": "delete_automated_policy_strategy",
"arguments": {
"strategy_id": "<strategy_id>"
}
}
{
"strategyId": "strat_a91f2c4d",
"deleted": true
}
delete_governance_strategy
Delete one governance strategy by strategy id.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Strategy ID (string). |
Yes |
{
"name": "delete_governance_strategy",
"arguments": {
"strategy_id": "<strategy_id>"
}
}
{
"strategyId": "gs_5e2f9a18",
"deleted": true
}
delete_model_wallet
Delete a model wallet.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID to scope the query. |
Yes |
|
Wallet ID. |
Yes |
|
Wallet name. |
Yes |
{
"name": "delete_model_wallet",
"arguments": {
"wallet_name": "orders-team-wallet",
"wallet_id": "<wallet_id>",
"environment_id": "<environment_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization UUID. When omitted, the caller’s authenticated org is used. |
No |
|
Vault provider to describe ( |
No |
|
Authentication method to describe (for example, |
No |
{
"name": "describe_vault_auth_schema",
"arguments": {}
}
{
"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."
}
{
"name": "describe_vault_auth_schema",
"arguments": {
"provider": "azure_key_vault",
"auth_method": "azure_sp_secret"
}
}
{
"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_integration
Modify an existing vault integration’s configuration. Validates edited credentials and performs a connectivity test before saving.
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization ID. When omitted, the caller’s authenticated org is used. |
No |
|
Target environment ID. Required unless |
No |
|
Human-readable environment name. Provide this or |
No |
|
Human-readable name of the vault integration. Provide this or |
No |
|
UUID of the vault integration. Provide this or |
No |
|
New description (max 512 characters). |
No |
|
Enable or disable automatic sync (reference-based integrations only). |
No |
|
Updated credential values (managed integrations only). |
No |
|
Updated non-secret configuration (managed integrations only). |
No |
|
Updated credential references (reference-based integrations only). |
No |
You must provide either integration_name or integration_id. You must also provide either environment_id or environment_name.
|
{
"name": "edit_integration",
"arguments": {
"environment_name": "Production",
"integration_name": "My Azure Vault",
"description": "Updated description",
"raw_secrets": {
"azure.spSecret.clientSecret": "new-secret-value"
}
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID to scope the query. |
Yes |
|
Wallet name or ID. |
Yes |
{
"name": "edit_model_wallet",
"arguments": {
"wallet_id": "orders-team-wallet",
"environment_id": "<environment_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Template ID (string). |
Yes |
{
"name": "fetch_automated_policy_template",
"arguments": {
"template_id": "<template_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Scope of the series. Defaults to |
No |
|
Instance ID to query. For |
Yes |
|
Organization ID (string). |
Yes |
|
Time window for the timeseries. Supported values: |
No |
{
"name": "fetch_cost_instance_timeseries",
"arguments": {
"organization_id": "<organization_id>",
"instance_id": "<instance_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Scope of the query. Defaults to |
No |
|
Set to |
No |
|
Organization ID to query for per-instance usage and optimization coverage. |
Yes |
|
Sort field for results. Supported values: |
No |
|
Time window for usage analysis. Supported values: |
No |
|
Maximum number of instances to return. Defaults to |
No |
{
"name": "fetch_cost_instances",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Scope to rank. Defaults to |
No |
|
Organization ID to query for optimization recommendations. |
Yes |
|
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 |
No |
|
Time window used to detect active instances and estimate projected token savings. Supported values: |
No |
|
Maximum number of ranked recommendations to return. Defaults to |
No |
{
"name": "fetch_cost_optimization_recommendations",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.10, "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.
| Parameter | Description | Required |
|---|---|---|
|
Set to |
No |
|
Organization ID to query for org-wide MCP token KPIs and agent dollar cards. |
Yes |
|
Time window for KPI aggregation. Supported values: |
No |
{
"name": "fetch_cost_overview",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Optional API version to scope the report when a service has multiple versions. |
No |
|
Set to |
No |
|
Organization ID that owns the service. |
Yes |
|
Service ID to retrieve detailed governance conformance for. |
Yes |
|
Optional service version selector (legacy alias). Use when you need a specific version’s conformance view. |
No |
{
"name": "fetch_governance_service_report",
"arguments": {
"organization_id": "<organization_id>",
"service_id": "<service_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Filter to one or more concern area IDs (for example |
No |
|
Filter to one or more conformance states. Canonical values: |
No |
|
Set to |
No |
|
Set to |
No |
|
Page size for results. |
No |
|
Minimum error count threshold for matched services. |
No |
|
Minimum info count threshold for matched services. |
No |
|
Minimum warning count threshold for matched services. |
No |
|
Result offset for pagination. |
No |
|
Organization ID to search for governance conformance data. |
Yes |
|
Filter to one or more gateway/provider values. Canonical values include |
No |
|
Free-text search across service metadata. |
No |
|
Filter to services associated with one or more ruleset IDs. |
No |
|
Filter to specific service IDs. |
No |
|
Filter to one or more service types. |
No |
{
"name": "fetch_governance_services",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Source ruleset key (string). |
Yes |
{
"name": "fetch_guardrail_ruleset",
"arguments": {
"source_ruleset_key": "<source_ruleset_key>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID to scope the query. |
Yes |
|
Wallet ID. |
Yes |
|
Wallet name. |
Yes |
{
"name": "fetch_model_wallet_details",
"arguments": {
"wallet_name": "orders-team-wallet",
"wallet_id": "<wallet_id>",
"environment_id": "<environment_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID to scope the query. |
Yes |
{
"name": "fetch_model_wallets",
"arguments": {
"environment_id": "<environment_id>"
}
}
{
"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."
| Parameter | Description | Required |
|---|---|---|
|
Optional entity category to rank. Supported values: |
No |
|
Optional single environment filter (legacy convenience field). |
No |
|
Optional list of environments to filter contributors by. |
No |
|
Optional instance ID to narrow results to a single instance. |
No |
|
Page size for ranked contributors. |
No |
|
Metric used for ranking. Supported values: |
Yes |
|
Result offset for pagination. |
No |
|
Optional organization ID scope (required in multi-org contexts). |
No |
|
Optional list of provider filters. |
No |
|
Free-text filter matching service, instance, or environment names. |
No |
|
Optional service ID to narrow the ranking to one service’s instances. |
No |
|
Sort direction for ranked results, typically |
No |
|
Field to sort by in the drill-down result set. |
No |
|
Time window for metric calculation (for example |
No |
{
"name": "fetch_monitoring_drill_down",
"arguments": {
"metric": "availability"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Optional API version selector for the target asset. |
No |
|
API asset ID to retrieve instance monitoring for. |
Yes |
|
Optional asset version selector. |
No |
|
Target environment for monitoring data. Supported values: |
No |
|
Optional instance ID. If omitted, the first available instance is selected. |
No |
|
Organization ID that owns the API asset and instance. |
Yes |
|
Time window for charts and summaries. Supported values: |
No |
{
"name": "fetch_monitoring_instance",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment scope for KPI and trend data. Supported values: |
No |
|
Set to |
No |
|
Organization ID to query for org-wide monitoring health metrics. |
Yes |
|
Optional provider filter. Monitoring data is currently available for |
No |
|
Time window for KPI and trend calculations. Supported values: |
No |
{
"name": "fetch_monitoring_overview",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Facet buckets/metrics to compute (for example |
No |
|
Optional typed asset filter. Canonical values include API classifiers ( |
No |
|
Business group ID to scope the facet query. |
Yes |
|
Optional structured typed filters. Do not combine with |
No |
|
Optional text query mode. When provided, do not send typed |
No |
|
Optional limit for returned facet buckets/results. |
No |
{
"name": "fetch_service_facets",
"arguments": {
"business_group_id": "<business_group_id>"
}
}
{
"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).
| Parameter | Description | Required |
|---|---|---|
|
Optional aggregate blocks to return alongside service rows (for example counts by type/provider). Use structured aggregate fields, not shorthand strings. |
No |
|
Optional typed asset filter. Canonical values include API classifiers ( |
No |
|
Business group ID to scope the service search. |
Yes |
|
Optional structured typed filters. Do not combine with |
No |
|
Set to |
No |
|
Optional text query mode. When provided, do not send typed |
No |
|
Page size for returned service rows. |
No |
{
"name": "fetch_services",
"arguments": {
"business_group_id": "<business_group_id>"
}
}
{
"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
Get instance-rooted lineage, including design-time and runtime relationships, from the Context Catalog for an agent, MCP server, or API.
| Parameter | Description | Required |
|---|---|---|
|
Asset name or ID to resolve lineage for (string). |
Yes |
|
Type of the root asset. Supported values: |
Yes |
|
Version of the asset. Defaults to the latest available (string or null). |
No |
|
Traversal direction. Supported values: |
Yes |
|
Organization ID to scope the lineage query. Defaults to the request-scoped active org (string or null). |
No |
|
Deployed instance to get root lineage for. If omitted, the tool returns instance options for clarification (string or null). |
No |
{
"name": "get_asset_lineage",
"arguments": {
"asset": "fraud-detection-mcp",
"asset_type": "mcp",
"direction": "upstream"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Group ID (string). |
Yes |
{
"name": "get_business_group",
"arguments": {
"group_id": "<group_id>"
}
}
{
"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
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?"
| Parameter | Description | Required |
|---|---|---|
|
Name or ID of a single data asset to resolve (string). |
Yes |
|
Business-group org ID to search. Defaults to the request-scoped active org (string or null). |
No |
|
Asset version to prefer when selecting a document. Defaults to the latest available (string or null). |
No |
{
"name": "get_data_asset_classification",
"arguments": {
"asset": "customer_orders"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset ID (string). |
Yes |
|
Environment ID (string). |
Yes |
|
Organization ID (string). |
Yes |
{
"name": "get_mcp_server_state",
"arguments": {
"organization_id": "<organization_id>",
"environment_id": "<environment_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID (string). |
Yes |
|
Organization ID (string or null). |
No |
|
Provider ID (string or null). |
No |
|
Target ID (string). |
Yes |
{
"name": "get_omni_gateway_target_domains",
"arguments": {
"environment_id": "<environment_id>",
"target_id": "<target_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Provider ID (string or null). |
No |
{
"name": "get_omni_gateway_usage_report",
"arguments": {
"organization_id": "<organization_id>",
"provider_id": "<provider_id>"
}
}
{
"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_template_form
Load one policy template detail, including configuration schema, to dynamically render the creation form. Use this immediately after the user selects a policy in prepare_policy_creation.
| Parameter | Description | Required |
|---|---|---|
|
API instance ID (string). |
Yes |
|
Asset ID (string or null). |
No |
|
Asset version (string or null). |
No |
|
Direction (string). |
No |
|
Environment ID (string). |
Yes |
|
Group ID (string or null). |
No |
|
Organization ID (string). |
Yes |
|
Template ID (string or null). |
No |
{
"name": "get_policy_template_form",
"arguments": {
"organization_id": "<organization_id>",
"environment_id": "<environment_id>",
"api_instance_id": "<api_instance_id>"
}
}
{
"templateId": "rate-limiting",
"name": "Rate Limiting",
"version": "1.4.0",
"groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
"form": {
"fields": [
{ "name": "rateLimits", "type": "array", "required": true, "label": "Rate Limits" },
{ "name": "exposeHeaders", "type": "boolean", "required": false, "label": "Expose Headers", "default": true }
]
},
"direction": "inbound"
}
get_provision_status
Poll the status of a provisioning or update job.
| Parameter | Description | Required |
|---|---|---|
|
Job ID (string). |
Yes |
|
Organization ID (string or null). |
No |
{
"name": "get_provision_status",
"arguments": {
"job_id": "<job_id>",
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
{
"name": "get_trusted_mcp_catalog",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Name (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Provider (string or null). |
No |
{
"name": "list_agents",
"arguments": {
"name": "<name>",
"organization_id": "<organization_id>",
"provider": "mulesoft"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API category (string or null). |
No |
|
Name (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Provider (string or null). |
No |
{
"name": "list_apis",
"arguments": {
"api_category": "<api_category>",
"name": "<name>",
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Name (string or null). |
No |
{
"name": "list_business_groups",
"arguments": {
"name": "<name>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Strategy type (string or null). |
No |
{
"name": "list_governance_strategies",
"arguments": {
"organization_id": "<organization_id>",
"strategy_type": "<strategy_type>"
}
}
{
"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_integration_secrets
List all secret references discovered by a specific vault integration, showing metadata only.
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization ID. When omitted, the caller’s authenticated org is used. |
No |
|
Target environment ID. Required unless |
No |
|
Human-readable environment name. Provide this or |
No |
|
Human-readable name of the vault integration. Provide this or |
No |
|
UUID of the vault integration. Provide this or |
No |
|
Zero-based pagination offset. Default: |
No |
|
Maximum number of items to return. Default: |
No |
You must provide either integration_name or integration_id. You must also provide either environment_id or environment_name.
|
{
"name": "list_integration_secrets",
"arguments": {
"environment_name": "Production",
"integration_name": "My Azure Vault",
"offset": 0,
"limit": 10
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Category (string or null). |
No |
|
Name (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Provider (string or null). |
No |
{
"name": "list_llms",
"arguments": {
"category": "<category>",
"name": "<name>",
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Name (string or null). |
No |
|
Organization ID (string). |
Yes |
|
Protocol (string or null). |
No |
{
"name": "list_mcp_servers",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Provider ID (string or null). |
No |
{
"name": "list_omni_gateway_environments",
"arguments": {
"organization_id": "<organization_id>",
"provider_id": "<provider_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID (string). |
Yes |
|
Organization ID (string or null). |
No |
|
Provider ID (string or null). |
No |
{
"name": "list_omni_gateway_targets",
"arguments": {
"environment_id": "<environment_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
|
Provider ID (string or null). |
No |
{
"name": "list_provider_gateways",
"arguments": {
"organization_id": "<organization_id>",
"provider_id": "<provider_id>"
}
}
{
"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.
{
"name": "list_scanner_providers",
"arguments": {}
}
{
"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"] }
]
}
login
Authenticate with Omni Platform. MUST be called before any other tool.
| Parameter | Description | Required |
|---|---|---|
|
Password (string or null). |
No |
|
Username (string or null). |
No |
{
"name": "login",
"arguments": {
"password": "<password>",
"username": "<username>"
}
}
{
"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.
{
"name": "logout",
"arguments": {}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization ID. When omitted, the caller’s authenticated org is used. |
No |
|
Target environment ID. Required unless |
No |
|
Human-readable environment name. Provide this or |
No |
|
Display name for the integration (3-64 characters). |
Yes |
|
Vault provider. One of: |
Yes |
|
Authentication method for the provider (for example, |
Yes |
|
Vault endpoint URL. |
Yes |
|
Raw secret credential values keyed by the auth schema’s secret-field key. |
Yes |
|
Non-secret connection configuration keyed by the auth schema’s config-field key. |
No |
|
Human-readable description (max 512 characters). |
No |
|
How often (minutes) to re-sync. Must be between |
No |
{
"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
}
}
{
"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
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
{
"name": "prepare_automated_policy_creation",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string or null). |
No |
{
"name": "prepare_guardrail_creation",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API instance ID (string or null). |
No |
|
Asset ID (string or null). |
No |
|
Environment ID (string or null). |
No |
|
Organization ID (string). |
Yes |
|
Policy name hint (string or null). |
No |
{
"name": "prepare_policy_creation",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"apiInstanceId": "16834521",
"assetId": "orders-api",
"assetVersion": "2.1.0",
"groupId": "68ef9520-24e9-4cf2-b2f5-620025690913",
"availablePolicies": [
{ "templateId": "rate-limiting", "assetId": "rate-limiting", "assetVersion": "1.4.0", "name": "Rate Limiting", "category": "Quality of Service" },
{ "templateId": "jwt-validation", "assetId": "jwt-validation", "assetVersion": "1.3.1", "name": "JWT Validation", "category": "Security" },
{ "templateId": "ip-allowlist", "assetId": "ip-allowlist", "assetVersion": "1.2.0", "name": "IP Allowlist", "category": "Security" }
]
}
provision_mcp_server
Provision a composite MCP server on Flex Gateway from selected catalog systems.
| Parameter | Description | Required |
|---|---|---|
|
Base path (string). |
Yes |
|
Environment ID (string). |
Yes |
|
Organization ID (string). |
Yes |
|
Server name (string). |
Yes |
|
Servers (array). |
Yes |
|
Target ID (string). |
Yes |
|
Target name (string). |
Yes |
{
"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>",
"servers": [
{}
]
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Job ID (string). |
Yes |
|
Organization ID (string or null). |
No |
{
"name": "resume_provision_job",
"arguments": {
"job_id": "<job_id>",
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset type (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Query (string). |
Yes |
|
Rows (integer). |
No |
{
"name": "search_assets_semantic",
"arguments": {
"query": "payment processing"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Business group ID (string). |
Yes |
|
Query (string). |
Yes |
|
Size (integer). |
No |
{
"name": "search_global_assets",
"arguments": {
"query": "payment processing",
"business_group_id": "<business_group_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Business group ID (string). |
Yes |
|
Query (string). |
Yes |
|
Size (integer). |
No |
{
"name": "search_global_content",
"arguments": {
"query": "payment processing",
"business_group_id": "<business_group_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset type (string). |
No |
|
Max results (integer). |
No |
|
Query (string). |
Yes |
{
"name": "search_portfolio_services",
"arguments": {
"query": "payment processing"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Lexical top n (integer). |
No |
|
Query (string). |
Yes |
|
Source path prefixes (array or null). |
No |
|
Top k (integer). |
No |
{
"name": "search_repository_knowledge",
"arguments": {
"query": "payment processing"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization UUID. When omitted, the caller’s authenticated org is used. |
No |
|
Target Anypoint environment UUID. Required unless |
No |
|
Human-readable environment name. Provide this or |
No |
|
The secret name (or partial name) to search for. Must be at least 3 characters. |
Yes |
|
Maximum number of results to return (default: |
No |
{
"name": "search_secrets",
"arguments": {
"environment_name": "Production",
"search_term": "api-key",
"limit": 50
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Business group ID (string or null). |
No |
|
Name (string or null). |
No |
{
"name": "select_active_business_group",
"arguments": {
"business_group_id": "<business_group_id>",
"name": "<name>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment ID (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Provider ID (string or null). |
No |
{
"name": "select_active_environment",
"arguments": {
"environment_id": "<environment_id>",
"organization_id": "<organization_id>",
"provider_id": "<provider_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Provider ID (string or null). |
No |
{
"name": "select_active_provider",
"arguments": {
"provider_id": "<provider_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset ID (string). |
Yes |
|
Organization ID (string). |
Yes |
{
"name": "select_api_version",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Environment (string). |
No |
|
Provider (string or null). |
No |
|
Time range (string). |
No |
{
"name": "show_observability_performance",
"arguments": {
"environment": "sandbox",
"provider": "mulesoft",
"time_range": "7d"
}
}
{
"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).
| Parameter | Description | Required |
|---|---|---|
|
Anypoint organization ID. When omitted, the caller’s authenticated org is used. |
No |
|
Target environment ID. Required unless |
No |
|
Human-readable environment name. Provide this or |
No |
|
Post-create mode: human-readable vault integration name. Provide this or |
No |
|
Post-create mode: vault integration UUID. Provide this or |
No |
|
Pre-create mode: vault provider ( |
No |
|
Pre-create mode: authentication method for the provider. |
No |
|
Pre-create mode: vault endpoint URL. |
No |
|
Pre-create managed flow: credential values. |
No |
|
Non-secret connection configuration. |
No |
|
Pre-create reference flow: credential references. |
No |
|
Pre-create mode: |
No |
{
"name": "test_integration_connection",
"arguments": {
"environment_name": "Production",
"integration_name": "My Azure Vault"
}
}
{
"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": ""
}
}
}
{
"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
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Auth fields (ScannerAuthFields or null). |
No |
|
Auth method (string). |
No |
|
Provider (string). |
Yes |
{
"name": "test_scanner_connection",
"arguments": {
"provider": "mulesoft"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API ID (integer). |
Yes |
|
Asset ID (string). |
Yes |
|
Current upstream IDs (object or null). |
No |
|
Deployed systems (array or null). |
No |
|
Environment ID (string). |
Yes |
|
Organization ID (string). |
Yes |
|
Server name (string). |
Yes |
|
Servers (array). |
Yes |
|
Target ID (string). |
Yes |
|
Target name (string). |
Yes |
{
"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": [
{}
]
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Organization ID (string). |
Yes |
{
"name": "view_agent_details",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API version (string or null). |
No |
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Instance (object or null). |
No |
|
Instance ID (string or null). |
No |
|
Organization ID (string). |
Yes |
{
"name": "view_api_instance_details",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API version (string or null). |
No |
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Instance (object or null). |
No |
|
Instance ID (string or null). |
No |
|
Organization ID (string). |
Yes |
|
Time range (string). |
No |
{
"name": "view_api_instance_monitoring",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API version (string or null). |
No |
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Instance (object or null). |
No |
|
Instance ID (string or null). |
No |
|
Organization ID (string). |
Yes |
{
"name": "view_api_instance_policies",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API version (string or null). |
No |
|
Asset ID (string or null). |
No |
|
Asset version (string or null). |
No |
|
Organization ID (string or null). |
No |
|
Version (string). |
Yes |
{
"name": "view_api_version_details",
"arguments": {
"version": "1.0.0"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API name (string or null). |
No |
|
API version (string or null). |
No |
|
Asset ID (string). |
Yes |
|
Group ID (string). |
Yes |
|
Organization ID (string). |
Yes |
|
Version (string). |
Yes |
{
"name": "view_api_version_governance_report",
"arguments": {
"organization_id": "<organization_id>",
"group_id": "<group_id>",
"asset_id": "<asset_id>",
"version": "1.0.0"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
API version (string). |
Yes |
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Organization ID (string). |
Yes |
{
"name": "view_api_version_instances",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>",
"api_version": "v1"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Organization ID (string). |
Yes |
{
"name": "view_governance_report",
"arguments": {
"organization_id": "<organization_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Organization ID (string). |
Yes |
{
"name": "view_llm_details",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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.
| Parameter | Description | Required |
|---|---|---|
|
Asset ID (string). |
Yes |
|
Asset version (string or null). |
No |
|
Organization ID (string). |
Yes |
{
"name": "view_mcp_server_details",
"arguments": {
"organization_id": "<organization_id>",
"asset_id": "<asset_id>"
}
}
{
"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." }
]
}



