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	login	None
logout	None
Business Group & Org	get_business_group	organization_read
list_business_groups	organization_read
select_active_business_group	organization_read
select_active_environment	organization_read
select_active_provider	organization_read
API Management	list_apis	exchange:exchange_viewer
select_api_version	organization_read
list_provider_gateways	apimanager:environment_viewer
view_api_instance_details	apimanager:environment_viewer
view_api_instance_monitoring	monitoring:viewer
view_api_instance_policies	apimanager:environment_viewer
view_api_version_details	exchange:exchange_viewer
view_api_version_instances	apimanager:environment_viewer
Policy Management	apply_policy_to_instance	apimanager:environment_admin
create_automated_policy_strategy	apimanager:environment_admin
delete_automated_policy_strategy	apimanager:environment_admin
fetch_automated_policy_template	apimanager:environment_viewer
get_policy_template_form	apimanager:environment_viewer
list_governance_strategies	apimanager:environment_viewer
prepare_automated_policy_creation	apimanager:environment_viewer
prepare_policy_creation	apimanager:environment_viewer
Governance	check_guardrail_scope_targets	apimanager:environment_viewer
check_policy_conformance	governance:viewer
create_guardrail	governance:administrator
delete_governance_strategy	governance:administrator
fetch_governance_service_report	governance:viewer
fetch_governance_services	governance:viewer
fetch_guardrail_ruleset	apimanager:environment_viewer
prepare_guardrail_creation	apimanager:environment_viewer
view_api_version_governance_report	governance:viewer
view_governance_report	governance:viewer
Monitoring & Observability	fetch_monitoring_drill_down	monitoring:viewer
fetch_monitoring_instance	monitoring:viewer
fetch_monitoring_overview	monitoring:viewer
show_observability_performance	monitoring:viewer
Search & Discovery	fetch_service_facets	exchange:exchange_viewer
fetch_services	exchange:exchange_viewer
search_assets_semantic	exchange:exchange_viewer
search_global_assets	exchange:exchange_viewer
search_global_content	exchange:exchange_viewer
search_portfolio_services	exchange:exchange_viewer
search_repository_knowledge	exchange:exchange_viewer
MCP Servers	get_mcp_server_state	exchange:exchange_contributor
get_provision_status	exchange:exchange_contributor
get_trusted_mcp_catalog	exchange:exchange_contributor
list_mcp_servers	exchange:exchange_viewer
provision_mcp_server	exchange:exchange_contributor
resume_provision_job	exchange:exchange_contributor
update_mcp_server	exchange:exchange_contributor
view_mcp_server_details	exchange:exchange_viewer
Agents	list_agents	exchange:exchange_viewer
view_agent_details	exchange:exchange_viewer
LLMs	list_llms	exchange:exchange_viewer
view_llm_details	exchange:exchange_viewer
Cost Management	fetch_cost_instance_timeseries	None
fetch_cost_instances	None
fetch_cost_optimization_recommendations	None
fetch_cost_overview	None
Omni Gateway	create_omni_gateway	runtime:deploy_applications
get_omni_gateway_target_domains	runtime:deploy_applications
get_omni_gateway_usage_report	runtime:deploy_applications
list_omni_gateway_environments	runtime:deploy_applications
list_omni_gateway_targets	runtime:deploy_applications
Scanners	create_scanner	runtime:deploy_applications
list_scanner_providers	runtime:deploy_applications
test_scanner_connection	runtime:deploy_applications

apply_policy_to_instance

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

Parameter Description Required

Parameter	Description	Required
`api_instance_id`	API instance ID (string).	Yes
`asset_id`	Asset ID (string or null).	No
`asset_version`	Asset version (string or null).	No
`configuration_data`	Configuration data (PolicyConfigurationData or null).	No
`disabled`	Disabled (boolean or null).	No
`environment_id`	Environment ID (string).	Yes
`group_id`	Group ID (string or null).	No
`order`	Order (integer or null).	No
`organization_id`	Organization ID (string).	Yes
`pointcut_data`	Pointcut data (PolicyPointcutData or null).	No
`policy_template_id`	Policy template ID (string or null).	No

api_instance_id

API instance ID (string).

Yes

asset_id

Asset ID (string or null).

asset_version

Asset version (string or null).

configuration_data

Configuration data (PolicyConfigurationData or null).

disabled

Disabled (boolean or null).

environment_id

Environment ID (string).

Yes

group_id

Group ID (string or null).

order

Order (integer or null).

organization_id

Organization ID (string).

Yes

pointcut_data

Pointcut data (PolicyPointcutData or null).

policy_template_id

Policy template ID (string or null).

Example request

{
  "name": "apply_policy_to_instance",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "api_instance_id": "<api_instance_id>"
  }
}

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`scope_filter`	Scope filter (string).	Yes

organization_id

Organization ID (string or null).

scope_filter

Scope filter (string).

Yes

Example request

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

Example response

{
  "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

Parameter	Description	Required
`api_instance_id`	API instance ID (string).	Yes
`asset_id`	Asset ID (string or null).	No
`asset_version`	Asset version (string or null).	No
`configuration_data`	Configuration data (PolicyConfigurationData or null).	No
`disabled`	Disabled (boolean or null).	No
`environment_id`	Environment ID (string).	Yes
`group_id`	Group ID (string or null).	No
`order`	Order (integer or null).	No
`organization_id`	Organization ID (string).	Yes
`pointcut_data`	Pointcut data (PolicyPointcutData or null).	No
`policy_template_id`	Policy template ID (string or null).	No

api_instance_id

API instance ID (string).

Yes

asset_id

Asset ID (string or null).

asset_version

Asset version (string or null).

configuration_data

Configuration data (PolicyConfigurationData or null).

disabled

Disabled (boolean or null).

environment_id

Environment ID (string).

Yes

group_id

Group ID (string or null).

order

Order (integer or null).

organization_id

Organization ID (string).

Yes

pointcut_data

Pointcut data (PolicyPointcutData or null).

policy_template_id

Policy template ID (string or null).

Example request

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

Example response

{
  "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"
  }
}

create_automated_policy_strategy

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

Parameter Description Required

Parameter	Description	Required
`allow_duplicated`	Allow duplicated (boolean).	No
`automated_policy_configuration`	Automated policy configuration (object or null).	No
`automated_policy_endpoint_type_groups`	Automated policy endpoint type groups (array or null).	No
`automated_policy_endpoint_type_mode`	Automated policy endpoint type mode (string).	No
`automated_policy_environment_id`	Automated policy environment ID (string or null).	No
`automated_policy_id`	Automated policy ID (string or null).	No
`automated_policy_runtime`	Automated policy runtime (string or null).	No
`automated_policy_runtime_range_from`	Automated policy runtime range from (string or null).	No
`automated_policy_runtime_range_to`	Automated policy runtime range to (string or null).	No
`description`	Description (string).	No
`name`	Name (string or null).	No
`organization_id`	Organization ID (string or null).	No
`scope_filter`	Scope filter (string or null).	No

allow_duplicated

Allow duplicated (boolean).

automated_policy_configuration

Automated policy configuration (object or null).

automated_policy_endpoint_type_groups

Automated policy endpoint type groups (array or null).

automated_policy_endpoint_type_mode

Automated policy endpoint type mode (string).

automated_policy_environment_id

Automated policy environment ID (string or null).

automated_policy_id

Automated policy ID (string or null).

automated_policy_runtime

Automated policy runtime (string or null).

automated_policy_runtime_range_from

Automated policy runtime range from (string or null).

automated_policy_runtime_range_to

Automated policy runtime range to (string or null).

description

Description (string).

name

Name (string or null).

organization_id

Organization ID (string or null).

scope_filter

Scope filter (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`description`	Description (string).	No
`governance_target_type`	Governance target type (string).	No
`name`	Name (string or null).	No
`organization_id`	Organization ID (string or null).	No
`position`	Position (integer or null).	No
`rules`	Rules (array or null).	No
`rulesets`	Rulesets (array or null).	No
`schedule_config`	Schedule config (object or null).	No
`scope_condition_mode`	Scope condition mode (string).	No
`scope_conditions`	Scope conditions (array or null).	No
`scope_filter`	Scope filter (string or null).	No
`strategy_status`	Strategy status (string).	No
`strategy_type`	Strategy type (string).	No

description

Description (string).

governance_target_type

Governance target type (string).

name

Name (string or null).

organization_id

Organization ID (string or null).

position

Position (integer or null).

rules

Rules (array or null).

rulesets

Rulesets (array or null).

schedule_config

Schedule config (object or null).

scope_condition_mode

Scope condition mode (string).

scope_conditions

Scope conditions (array or null).

scope_filter

Scope filter (string or null).

strategy_status

Strategy status (string).

strategy_type

Strategy type (string).

Example request

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

Example response

{
  "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_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

Parameter	Description	Required
`environment_id`	Environment ID (string or null).	No
`environment_name`	Environment name (string or null).	No
`environment_type`	Environment type (string or null).	No
`governance_override_warnings`	Governance override warnings (boolean).	No
`organization_id`	Organization ID (string or null).	No
`payload`	Payload (FlexGatewayCreatePayload or null).	No
`provider_id`	Provider ID (string or null).	No
`target_type`	Target type (string or null).	No

environment_id

Environment ID (string or null).

environment_name

Environment name (string or null).

environment_type

Environment type (string or null).

governance_override_warnings

Governance override warnings (boolean).

organization_id

Organization ID (string or null).

payload

Payload (FlexGatewayCreatePayload or null).

provider_id

Provider ID (string or null).

target_type

Target type (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`auth_fields`	Auth fields (ScannerAuthFields or null).	No
`auth_fields_alias`	Auth fields alias (ScannerAuthFields or null).	No
`auth_method`	Auth method (string or null).	No
`auth_method_alias`	Auth method alias (string or null).	No
`description`	Description (string).	No
`filters`	Filters (array or null).	No
`name`	Name (string or null).	No
`notifications`	Notifications (ScannerNotifications or null).	No
`organization_id`	Organization ID (string or null).	No
`owner_id`	Owner ID (string or null).	No
`provider`	Provider (string or null).	No
`schedule`	Schedule (ScannerSchedule or null).	No

auth_fields

Auth fields (ScannerAuthFields or null).

auth_fields_alias

Auth fields alias (ScannerAuthFields or null).

auth_method

Auth method (string or null).

auth_method_alias

Auth method alias (string or null).

description

Description (string).

filters

Filters (array or null).

name

Name (string or null).

notifications

Notifications (ScannerNotifications or null).

organization_id

Organization ID (string or null).

owner_id

Owner ID (string or null).

provider

Provider (string or null).

schedule

Schedule (ScannerSchedule or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`strategy_id`	Strategy ID (string).	Yes

organization_id

Organization ID (string or null).

strategy_id

Strategy ID (string).

Yes

Example request

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

Example response

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

delete_governance_strategy

Delete one governance strategy by strategy id.

Parameter Description Required

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`strategy_id`	Strategy ID (string).	Yes

organization_id

Organization ID (string or null).

strategy_id

Strategy ID (string).

Yes

Example request

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

Example response

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

fetch_automated_policy_template

Fetch one policy template by templateId for configuration details.

Parameter Description Required

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`template_id`	Template ID (string).	Yes

organization_id

Organization ID (string or null).

template_id

Template ID (string).

Yes

Example request

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

Example response

{
  "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

Use this tool to get token usage and response time timeseries for a single MCP server instance.

Parameter Description Required

Parameter	Description	Required
`instance_id`	Instance ID (string).	Yes
`organization_id`	Organization ID (string).	Yes
`time_range`	Time range (string).	No

instance_id

Instance ID (string).

Yes

organization_id

Organization ID (string).

Yes

time_range

Time range (string).

Example request

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

Example response

{
  "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

Use this tool to get per-instance token usage with optimization coverage.

Parameter Description Required

Parameter	Description	Required
`filter_unoptimized`	Set to `true` to return only instances that have unapplied cost policies (`unappliedCostPolicyIds` not empty); use this to find optimization candidates quickly.	No
`organization_id`	Organization ID to query for per-instance token usage and optimization coverage.	Yes
`sort_by`	Sort field for results. Supported values: `totalTokens`, `tokenDelta`, `avgResponseTimeMs`, `totalCalls`, `tokensPerCall`.	No
`time_range`	Time window for usage analysis. Supported values: `1h`, `6h`, `24h`, `7d`, `30d`.	No
`top_n`	Maximum number of instances to return. Defaults to `10`; maximum is `50`.	No

filter_unoptimized

Set to true to return only instances that have unapplied cost policies (unappliedCostPolicyIds not empty); use this to find optimization candidates quickly.

organization_id

Organization ID to query for per-instance token usage and optimization coverage.

Yes

sort_by

Sort field for results. Supported values: totalTokens, tokenDelta, avgResponseTimeMs, totalCalls, tokensPerCall.

time_range

Time window for usage analysis. Supported values: 1h, 6h, 24h, 7d, 30d.

top_n

Maximum number of instances to return. Defaults to 10; maximum is 50.

Example request

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

Example response

{
  "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

Use this tool to get a ranked list of MCP server instances that should be optimized, mirroring the 'Recommended Optimizations' card on the Cost Management page. Use this tool to answer questions, such as "What should I optimize next?', "What are the biggest token savings opportunities?"", "Where is the most waste?".

Parameter Description Required

Parameter	Description	Required
`organization_id`	Organization ID to query for optimization recommendations.	Yes
`savings_pool_size`	Number of candidate instances to evaluate before ranking the final recommendations; increase this when you want broader coverage before taking the top results.	No
`time_range`	Time window used to detect active instances and estimate projected token savings. Supported values: `1h`, `6h`, `24h`, `7d`, `30d`.	No
`top_n`	Maximum number of ranked recommendations to return. Defaults to `3`; maximum is `10`.	No

organization_id

Organization ID to query for optimization recommendations.

Yes

savings_pool_size

Number of candidate instances to evaluate before ranking the final recommendations; increase this when you want broader coverage before taking the top results.

time_range

Time window used to detect active instances and estimate projected token savings. Supported values: 1h, 6h, 24h, 7d, 30d.

top_n

Maximum number of ranked recommendations to return. Defaults to 3; maximum is 10.

Example request

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

Example response

{
  "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

Use this tool to get org-wide token usage KPIs for MCP servers: total tokens, saved tokens (from optimization policies), and total tool calls.

Parameter Description Required

Parameter	Description	Required
`include_timeseries`	Set to `true` to include token usage timeseries for charting; this increases response size.	No
`organization_id`	Organization ID to query for org-wide MCP token usage KPIs.	Yes
`time_range`	Time window for KPI aggregation. Supported values: `1h`, `6h`, `24h`, `7d`, `30d`.	No

include_timeseries

Set to true to include token usage timeseries for charting; this increases response size.

organization_id

Organization ID to query for org-wide MCP token usage KPIs.

Yes

time_range

Time window for KPI aggregation. Supported values: 1h, 6h, 24h, 7d, 30d.

Example request

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

Example response

{
  "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

Parameter	Description	Required
`api_version`	Optional API version to scope the report when a service has multiple versions.	No
`include_rule_messages`	Set to `true` to include per-rule conformance messages in the response.	No
`organization_id`	Organization ID that owns the service.	Yes
`service_id`	Service ID to retrieve detailed governance conformance for.	Yes
`version`	Optional service version selector (legacy alias). Use when you need a specific version’s conformance view.	No

api_version

Optional API version to scope the report when a service has multiple versions.

include_rule_messages

Set to true to include per-rule conformance messages in the response.

organization_id

Organization ID that owns the service.

Yes

service_id

Service ID to retrieve detailed governance conformance for.

Yes

version

Optional service version selector (legacy alias). Use when you need a specific version’s conformance view.

Example request

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

Example response

{
  "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

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

concern_area_ids

Filter to one or more concern area IDs (for example security-privacy, consumption-economic-governance, structural-conformity-lifecycle).

conformance_status_in

Filter to one or more conformance states. Canonical values: compliant, non-compliant, pending.

include_rule_messages

Set to true to include rule-level messages in each returned service row.

include_rulesets

Set to true to include violated ruleset details in each service row.

limit

Page size for results.

min_errors

Minimum error count threshold for matched services.

min_infos

Minimum info count threshold for matched services.

min_warnings

Minimum warning count threshold for matched services.

offset

Result offset for pagination.

organization_id

Organization ID to search for governance conformance data.

Yes

provider_in

Filter to one or more gateway/provider values. Canonical values include mulesoft, kong, apigee, aws, azure.

q

Free-text search across service metadata.

ruleset_ids_in

Filter to services associated with one or more ruleset IDs.

service_ids

Filter to specific service IDs.

service_type_in

Filter to one or more service types.

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`source_ruleset_key`	Source ruleset key (string).	Yes

organization_id

Organization ID (string or null).

source_ruleset_key

Source ruleset key (string).

Yes

Example request

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

Example response

{
  "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_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

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

entity_type

Optional entity category to rank. Supported values: apis, agents, mcp-servers, llms.

environment

Optional single environment filter (legacy convenience field).

environments

Optional list of environments to filter contributors by.

instance_id

Optional instance ID to narrow results to a single instance.

limit

Page size for ranked contributors.

metric

Metric used for ranking. Supported values: availability, reliability, avgLatency, requestVolume, errorRate, policyViolations.

Yes

offset

Result offset for pagination.

organization_id

Optional organization ID scope (required in multi-org contexts).

providers

Optional list of provider filters.

search

Free-text filter matching service, instance, or environment names.

service_id

Optional service ID to narrow the ranking to one service’s instances.

sort_dir

Sort direction for ranked results, typically asc or desc.

sort_field

Field to sort by in the drill-down result set.

time_range

Time window for metric calculation (for example 24h).

Example request

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

Example response

{
  "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

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

api_version

Optional API version selector for the target asset.

asset_id

API asset ID to retrieve instance monitoring for.

Yes

asset_version

Optional asset version selector.

environment

Target environment for monitoring data. Supported values: production, sandbox, development.

instance_id

Optional instance ID. If omitted, the first available instance is selected.

organization_id

Organization ID that owns the API asset and instance.

Yes

time_range

Time window for charts and summaries. Supported values: 1h, 6h, 24h, 7d, 30d.

Example request

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

Example response

{
  "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

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

environment

Environment scope for KPI and trend data. Supported values: production, sandbox, development.

include_charts

Set to true to include compact time-series chart data with the KPI summary.

organization_id

Organization ID to query for org-wide monitoring health metrics.

Yes

provider

Optional provider filter. Monitoring data is currently available for mulesoft; other canonical providers (kong, apigee, aws, azure) return empty results.

time_range

Time window for KPI and trend calculations. Supported values: 1h, 6h, 24h, 7d, 30d.

Example request

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

Example response

{
  "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 }]
  }
}

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

Parameter Description Required

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

aggregates

Facet buckets/metrics to compute (for example totalHits, byType, byProvider). Use structured aggregate fields; do not send shorthand strings like type,provider.

asset_types

Optional typed asset filter. Canonical values include API classifiers (rest-api, http-api, graphql, soap-api, grpc-api, evented-api) plus agent and mcp.

business_group_id

Business group ID to scope the facet query.

Yes

filters

Optional structured typed filters. Do not combine with q.

q

Optional text query mode. When provided, do not send typed filters or aggregates.

size

Optional limit for returned facet buckets/results.

Example request

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

Example response

{
  "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

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

aggregates

Optional aggregate blocks to return alongside service rows (for example counts by type/provider). Use structured aggregate fields, not shorthand strings.

asset_types

Optional typed asset filter. Canonical values include API classifiers (rest-api, http-api, graphql, soap-api, grpc-api, evented-api) plus agent and mcp.

business_group_id

Business group ID to scope the service search.

Yes

filters

Optional structured typed filters. Do not combine with q.

include_affordances

Set to true to include navigation/action affordances in each service row.

q

Optional text query mode. When provided, do not send typed filters or aggregates.

size

Page size for returned service rows.

Example request

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

Example response

{
  "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_business_group

Get full metadata for a business group by its ID.

Parameter Description Required

Parameter	Description	Required
`group_id`	Group ID (string).	Yes

group_id

Group ID (string).

Yes

Example request

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

Example response

{
  "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_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

Parameter	Description	Required
`asset_id`	Asset ID (string).	Yes
`environment_id`	Environment ID (string).	Yes
`organization_id`	Organization ID (string).	Yes

asset_id

Asset ID (string).

Yes

environment_id

Environment ID (string).

Yes

organization_id

Organization ID (string).

Yes

Example request

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

Example response

{
  "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

Parameter	Description	Required
`environment_id`	Environment ID (string).	Yes
`organization_id`	Organization ID (string or null).	No
`provider_id`	Provider ID (string or null).	No
`target_id`	Target ID (string).	Yes

environment_id

Environment ID (string).

Yes

organization_id

Organization ID (string or null).

provider_id

Provider ID (string or null).

target_id

Target ID (string).

Yes

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`provider_id`	Provider ID (string or null).	No

organization_id

Organization ID (string or null).

provider_id

Provider ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`api_instance_id`	API instance ID (string).	Yes
`asset_id`	Asset ID (string or null).	No
`asset_version`	Asset version (string or null).	No
`direction`	Direction (string).	No
`environment_id`	Environment ID (string).	Yes
`group_id`	Group ID (string or null).	No
`organization_id`	Organization ID (string).	Yes
`template_id`	Template ID (string or null).	No

api_instance_id

API instance ID (string).

Yes

asset_id

Asset ID (string or null).

asset_version

Asset version (string or null).

direction

Direction (string).

environment_id

Environment ID (string).

Yes

group_id

Group ID (string or null).

organization_id

Organization ID (string).

Yes

template_id

Template ID (string or null).

Example request

{
  "name": "get_policy_template_form",
  "arguments": {
    "organization_id": "<organization_id>",
    "environment_id": "<environment_id>",
    "api_instance_id": "<api_instance_id>"
  }
}

Example response

{
  "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. Returns status (running/complete/failed), progress step, completed steps, result (MCP URL on success), and can_resume flag.

Parameter Description Required

Parameter	Description	Required
`job_id`	Job ID (string).	Yes
`organization_id`	Organization ID (string or null).	No

job_id

Job ID (string).

Yes

organization_id

Organization ID (string or null).

Example request

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

Example response

{
  "jobId": "job_a1b2c3d4",
  "status": "running",
  "progressStep": "deploying-flex-gateway",
  "completedSteps": ["create-asset", "configure-upstreams"],
  "remainingSteps": ["deploy-flex-gateway", "register-mcp-server"],
  "result": null,
  "canResume": false
}

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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No

organization_id

Organization ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`name`	Name (string or null).	No
`organization_id`	Organization ID (string or null).	No
`provider`	Provider (string or null).	No

name

Name (string or null).

organization_id

Organization ID (string or null).

provider

Provider (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`api_category`	API category (string or null).	No
`name`	Name (string or null).	No
`organization_id`	Organization ID (string or null).	No
`provider`	Provider (string or null).	No

api_category

API category (string or null).

name

Name (string or null).

organization_id

Organization ID (string or null).

provider

Provider (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`name`	Name (string or null).	No

name

Name (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`strategy_type`	Strategy type (string or null).	No

organization_id

Organization ID (string or null).

strategy_type

Strategy type (string or null).

Example request

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

Example response

{
  "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_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

Parameter	Description	Required
`category`	Category (string or null).	No
`name`	Name (string or null).	No
`organization_id`	Organization ID (string or null).	No
`provider`	Provider (string or null).	No

category

Category (string or null).

name

Name (string or null).

organization_id

Organization ID (string or null).

provider

Provider (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`name`	Name (string or null).	No
`organization_id`	Organization ID (string).	Yes
`protocol`	Protocol (string or null).	No

name

Name (string or null).

organization_id

Organization ID (string).

Yes

protocol

Protocol (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`provider_id`	Provider ID (string or null).	No

organization_id

Organization ID (string or null).

provider_id

Provider ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`environment_id`	Environment ID (string).	Yes
`organization_id`	Organization ID (string or null).	No
`provider_id`	Provider ID (string or null).	No

environment_id

Environment ID (string).

Yes

organization_id

Organization ID (string or null).

provider_id

Provider ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No
`provider_id`	Provider ID (string or null).	No

organization_id

Organization ID (string or null).

provider_id

Provider ID (string or null).

Example request

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

Example response

{
  "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

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

Example response

{
  "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"] }
  ]
}

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

Parameter Description Required

Parameter	Description	Required
`password`	Password (string or null).	No
`username`	Username (string or null).	No

password

Password (string or null).

username

Username (string or null).

Example request

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

Example response

{
  "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

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

Example response

{
  "authenticated": false
}

prepare_automated_policy_creation

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

Parameter Description Required

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No

organization_id

Organization ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`organization_id`	Organization ID (string or null).	No

organization_id

Organization ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`api_instance_id`	API instance ID (string or null).	No
`asset_id`	Asset ID (string or null).	No
`environment_id`	Environment ID (string or null).	No
`organization_id`	Organization ID (string).	Yes
`policy_name_hint`	Policy name hint (string or null).	No

api_instance_id

API instance ID (string or null).

asset_id

Asset ID (string or null).

environment_id

Environment ID (string or null).

organization_id

Organization ID (string).

Yes

policy_name_hint

Policy name hint (string or null).

Example request

{
  "name": "prepare_policy_creation",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}

Example response

{
  "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

Parameter	Description	Required
`base_path`	Base path (string).	Yes
`environment_id`	Environment ID (string).	Yes
`organization_id`	Organization ID (string).	Yes
`server_name`	Server name (string).	Yes
`servers`	Servers (array).	Yes
`target_id`	Target ID (string).	Yes
`target_name`	Target name (string).	Yes

base_path

Base path (string).

Yes

environment_id

Environment ID (string).

Yes

organization_id

Organization ID (string).

Yes

server_name

Server name (string).

Yes

servers

Servers (array).

Yes

target_id

Target ID (string).

Yes

target_name

Target name (string).

Yes

Example request

{
  "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": [
      {}
    ]
  }
}

Example response

{
  "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

Parameter	Description	Required
`job_id`	Job ID (string).	Yes
`organization_id`	Organization ID (string or null).	No

job_id

Job ID (string).

Yes

organization_id

Organization ID (string or null).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`asset_type`	Asset type (string or null).	No
`organization_id`	Organization ID (string or null).	No
`query`	Query (string).	Yes
`rows`	Rows (integer).	No

asset_type

Asset type (string or null).

organization_id

Organization ID (string or null).

query

Query (string).

Yes

rows

Rows (integer).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`business_group_id`	Business group ID (string).	Yes
`query`	Query (string).	Yes
`size`	Size (integer).	No

business_group_id

Business group ID (string).

Yes

query

Query (string).

Yes

size

Size (integer).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`business_group_id`	Business group ID (string).	Yes
`query`	Query (string).	Yes
`size`	Size (integer).	No

business_group_id

Business group ID (string).

Yes

query

Query (string).

Yes

size

Size (integer).

Example request

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

Example response

{
  "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

Parameter	Description	Required
`asset_type`	Asset type (string).	No
`max_results`	Max results (integer).	No
`query`	Query (string).	Yes

asset_type

Asset type (string).

max_results

Max results (integer).

query

Query (string).

Yes

Example request

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

Example response

{
  "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

Parameter	Description	Required
`lexical_top_n`	Lexical top n (integer).	No
`query`	Query (string).	Yes
`source_path_prefixes`	Source path prefixes (array or null).	No
`top_k`	Top k (integer).	No

lexical_top_n

Lexical top n (integer).

query

Query (string).

Yes

source_path_prefixes

Source path prefixes (array or null).

top_k

Top k (integer).

Example request

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

Example response

{
  "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
}

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

Business group ID (string or null).

name

Name (string or null).

Example request

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

Example response

{
  "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

Environment ID (string or null).

organization_id

Organization ID (string or null).

provider_id

Provider ID (string or null).

Example request

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

Example response

{
  "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

Provider ID (string or null).

Example request

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

Example response

{
  "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

Asset ID (string).

Yes

organization_id

Organization ID (string).

Yes

Example request

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

Example response

{
  "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

Environment (string).

provider

Provider (string or null).

time_range

Time range (string).

Example request

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

Example response

{
  "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_scanner_connection

Test connection to a scanner provider before creating the scanner.

Parameter Description Required

auth_fields

Auth fields (ScannerAuthFields or null).

auth_method

Auth method (string).

provider

Provider (string).

Yes

Example request

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

Example response

{
  "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

API ID (integer).

Yes

asset_id

Asset ID (string).

Yes

current_upstream_ids

Current upstream IDs (object or null).

deployed_systems

Deployed systems (array or null).

environment_id

Environment ID (string).

Yes

organization_id

Organization ID (string).

Yes

server_name

Server name (string).

Yes

servers

Servers (array).

Yes

target_id

Target ID (string).

Yes

target_name

Target name (string).

Yes

Example request

{
  "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

{
  "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

Asset ID (string).

Yes

asset_version

Asset version (string or null).

organization_id

Organization ID (string).

Yes

Example request

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

Example response

{
  "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

API version (string or null).

asset_id

Asset ID (string).

Yes

asset_version

Asset version (string or null).

instance

Instance (object or null).

instance_id

Instance ID (string or null).

organization_id

Organization ID (string).

Yes

Example request

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

Example response

{
  "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

API version (string or null).

asset_id

Asset ID (string).

Yes

asset_version

Asset version (string or null).

instance

Instance (object or null).

instance_id

Instance ID (string or null).

organization_id

Organization ID (string).

Yes

time_range

Time range (string).

Example request

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

Example response

{
  "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

API version (string or null).

asset_id

Asset ID (string).

Yes

asset_version

Asset version (string or null).

instance

Instance (object or null).

instance_id

Instance ID (string or null).

organization_id

Organization ID (string).

Yes

Example request

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

Example response

{
  "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

API version (string or null).

asset_id

Asset ID (string or null).

asset_version

Asset version (string or null).

organization_id

Organization ID (string or null).

version

Version (string).

Yes

Example request

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

Example response

{
  "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

API name (string or null).

api_version

API version (string or null).

asset_id

Asset ID (string).

Yes

group_id

Group ID (string).

Yes

organization_id

Organization ID (string).

Yes

version

Version (string).

Yes

Example request

{
  "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

{
  "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

API version (string).

Yes

asset_id

Asset ID (string).

Yes

asset_version

Asset version (string or null).

organization_id

Organization ID (string).

Yes

Example request

{
  "name": "view_api_version_instances",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>",
    "api_version": "v1"
  }
}

Example response

{
  "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

Organization ID (string).

Yes

Example request

{
  "name": "view_governance_report",
  "arguments": {
    "organization_id": "<organization_id>"
  }
}

Example response

{
  "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

Asset ID (string).

Yes

asset_version

Asset version (string or null).

organization_id

Organization ID (string).

Yes

Example request

{
  "name": "view_llm_details",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}

Example response

{
  "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

Asset ID (string).

Yes

asset_version

Asset version (string or null).

organization_id

Organization ID (string).

Yes

Example request

{
  "name": "view_mcp_server_details",
  "arguments": {
    "organization_id": "<organization_id>",
    "asset_id": "<asset_id>"
  }
}

Example response

{
  "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." }
  ]
}