Skip to main content
Glama
brbousnguar

mulewatch

by brbousnguar

List API Manager instances

anypoint_list_api_manager_instances

List API instances managed by Anypoint API Manager in an environment to inspect their assets, endpoints, and technology for operational visibility.

Instructions

List API instances managed by Anypoint API Manager in an environment, with their assets, endpoints and technology.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum records, default 100.
orgIdNoBusiness group id. Defaults to ANYPOINT_ORG_ID, or the credentials' own organization.
offsetNoPagination offset, default 0.
assetIdNoFilter by Exchange asset id.
includeRawNoInclude the raw Anypoint API objects alongside the normalized fields.
technologyNoFilter by technology, e.g. mule4, flexGateway.
environmentIdNoEnvironment id. Use instead of environmentName.
environmentNameNoEnvironment name, e.g. 'Production'. Resolved to an id, must match exactly one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are supplied, so the description carries the full behavioral burden. It usefully discloses what comes back (assets, endpoints, technology) and, via the includeRaw parameter, that normalized fields are the default. However, it says nothing about pagination semantics, permission/credential requirements, or rate limits for what is implicitly a read-only list operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence that names the operation, the scope, and the return payload with no filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only list tool with no annotations and no output schema, the description does the essential work of stating what is listed and roughly what is returned. It is nearly complete; pagination and environment-selection nuance are covered by the rich schema, so only minor context is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all eight parameters including defaults, filtering, and the environmentId/environmentName exclusivity. The description adds nothing about parameter behavior, so the baseline of 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (List) and a precisely bounded resource (API instances managed by Anypoint API Manager), plus the scope (an environment) and the payload returned (assets, endpoints, technology). It is naturally distinct from siblings like anypoint_list_deployed_apps and anypoint_list_environments, though it never explicitly contrasts itself with them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'in an environment' hints that environment scoping matters, but there is no explicit when-to-use guidance, no prerequisites, and no mention of when a caller should reach for this tool versus anypoint_list_deployed_apps or anypoint_search_exchange_assets. An agent gets no routing help from the text.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.