Anypoint Platform Operations
Overview
Navigate the Anypoint Platform developer portal to discover available APIs, agent skills, and extension schemas. The portal is the single source of truth for all public Anypoint Platform API specifications and agent-executable workflows. The portal URL is provided in the agent context preamble injected at the top of this file.
The portal exposes three machine-readable discovery files designed for AI agent consumption. Start with
for a quick inventory, read
for the full operating manual, and query
for programmatic access to every document.
Important: All portal files are plain-text source documents (YAML, JSON, Markdown). Always retrieve them with raw HTTP tools (curl, direct GET requests) — never pass portal URLs through summarizer or browser-rendering tools, which will truncate structured content.
llms.txt -- Quick Inventory
Fetch
for a lightweight, one-page summary following the
llmstxt.org convention. It lists:
- A link to (the full agent entry point)
- A link to (the machine-readable catalog)
- Schema references for and JTBD extensions
- Every public API with a one-line description
- Every agent skill with a one-line description
Use
when you need a quick overview of what the portal offers before diving deeper.
AGENTS.md -- The Agent Operating Manual
Fetch
for the complete reference designed specifically for AI agents. This is the most important file to read thoroughly. It covers:
- Site structure -- where every file type lives (specs, skills, schemas)
- Registry format -- field definitions for entries
- URN scheme and resolution -- how to convert identifiers to fetchable URLs:
- resolves to
{portal-url}/apis/{slug}/api.yaml
- resolves to
{portal-url}/skills/{slug}/SKILL.md
- resolves to
{portal-url}/schemas/x-origin.schema.json
- API spec conventions -- format, authentication, server variables
- x-origin extension -- how dynamic parameters reference other APIs
- Skill format (JTBD) -- step structure, input types, output chaining
- Common agent workflows -- step-by-step patterns for discovery, execution, and resolution
registry.json -- Programmatic Catalog
Fetch
{portal-url}/registry.json
for the complete document index as a flat JSON array. Each entry contains:
- -- URN identifier (e.g., )
- -- document type: (API spec), , , or
- -- URL-safe short name
- and -- human-readable metadata
- -- relative path to the raw source file
- -- relative path to the rendered HTML page
- -- (skills only) array of API slugs this skill references
Filter by
to segment the catalog:
- Find all APIs:
- Find all skills:
- Find skills for a specific API: AND contains the target slug
- Find extension schemas: or
Understanding x-origin (Dynamic Parameters)
Many API parameters have valid values that come from another API's response. These parameters carry an
annotation in the OpenAPI spec:
yaml
parameters:
- name: environmentId
in: path
schema:
type: string
x-origin:
- api: urn:api:access-management
operation: listEnvironments
values: "$.data[*].id"
labels: "$.data[*].name"
- Read the array on the parameter
- For each source, resolve the API URN to fetch the referenced spec
- Find and call the referenced (by )
- Apply the JSONPath expression to extract valid identifiers
- Optionally apply the JSONPath to get human-readable display names
The
field is always required. The
field is optional -- when absent, display the value directly. Both can be single JSONPath strings or arrays of paths.
Full schema:
{portal-url}/schemas/x-origin.schema.json
Documentation:
{portal-url}/schemas/x-origin-schema.md
Understanding JTBD Skills
Skills are multi-step API workflows written in markdown. Each skill's
contains:
- YAML frontmatter with (kebab-case) and (includes trigger terms for agent matching)
- Numbered steps () each containing a YAML code block with:
- -- URN of the target API (e.g., )
- -- the operation to call
- -- parameter mappings with four possible types
- -- values to capture for subsequent steps
The four input types are:
| Type | Syntax | Use when |
|---|
| From another API | + + | Value must be fetched from an API call |
| From previous step | | Using an output captured earlier in the workflow |
| Literal | | Static constant known in advance |
| User-provided | | Agent must prompt the user or use context |
Outputs chain between steps -- a value captured as
in Step 1 can be referenced as
from.variable: environmentApiId
in Step 2.
Some skills define Execution Paths -- alternative routes through the steps depending on what the agent already has (e.g., skip authentication if already logged in).
Full schema:
{portal-url}/schemas/jtbd-schema.md
Template:
{portal-url}/schemas/jtbd-template.md
Fetching Strategy
Portal files (
,
,
) are plain-text source documents, NOT rendered web pages. When retrieving them:
- Use raw HTTP tools (curl, direct GET, file-read tools) — NOT browser-rendering or summarizer tools (e.g., WebFetch). Summarizers truncate structured content like JSON arrays, YAML code blocks, and tables.
- Parse responses verbatim — must be parsed as JSON, API specs as YAML, and skills as Markdown. Do not summarize or abbreviate.
- Fetch files individually when you need their content:
- Registry:
GET {portal-url}/registry.json
- API spec:
GET {portal-url}/apis/{slug}/api.yaml
- Skill definition:
GET {portal-url}/skills/{slug}/SKILL.md
- Agent guide:
GET {portal-url}/AGENTS.md
Prerequisites
- Network access -- ability to make HTTP requests to the portal URL (see agent context preamble for the base URL)
- Anypoint Platform credentials (for executing skills) -- Bearer token or OAuth2 client credentials for API calls
- HTTP fetch capability -- ability to fetch and parse YAML, JSON, and Markdown responses directly (raw HTTP, not via summarizer)
Tips and Best Practices
Discovery Strategy
- Start with for programmatic discovery -- it is structured, filterable, and machine-parseable
- Read when you need to understand conventions, resolve ambiguity, or learn how the portal works
- Use for a quick, lightweight overview before committing to a deeper exploration
- Always use raw HTTP tools (curl, direct GET) for portal files -- never use summarizer tools that pass content through an intermediate model
Working with x-origin
- Always check x-origin on parameters before hardcoding values -- dynamic enums change per organization and environment
- Chain x-origin calls: one API's x-origin often references Access Management, which itself provides foundational IDs for other APIs
- Cache and -- they are reused across nearly every API call and rarely change within a session
- Read the full x-origin array -- some parameters offer multiple sources (e.g., different API endpoints for different contexts)
Skill Execution
- Read the full skill before starting -- execution paths may let you skip steps if prerequisites are already met
- Chain variables between steps -- outputs from one step become inputs to the next via
- Check the troubleshooting section of each skill when errors occur -- skills document known failure modes and solutions
- Resolve user-provided inputs early -- gather all inputs before starting execution to avoid mid-workflow interruptions
Portal Navigation
- Raw files via -- use this for machine consumption (OpenAPI YAML, SKILL.md, JSON Schema)
- Rendered pages via -- use this when you need HTML documentation (useful for extracting formatted content)
- URN resolution -- always resolve URNs through the portal URL, never hardcode file paths
Troubleshooting
Portal Files Not Accessible
Symptoms: HTTP errors when fetching llms.txt, AGENTS.md, or registry.json
Possible causes:
- Incorrect portal URL
- Network connectivity issues
- Portal is being redeployed
Solutions:
- Verify the base URL matches the one in the agent context preamble at the top of this file
- Check that the full URL path is correct (no trailing slash issues)
- Retry after a brief wait if the portal is temporarily unavailable
Registry Returns Empty or Unexpected Results
Symptoms: registry.json parses but filtering returns no results
Possible causes:
- Using wrong value for filtering
- API slug does not match any entry
Solutions:
- Valid kind values are exactly: , , ,
- List all slugs first to find exact matches (slugs are kebab-case, e.g., not )
- Skills have an array field -- APIs do not have a field
URN Resolution Fails
Symptoms: Fetching a URL constructed from a URN returns 404
Possible causes:
- Incorrect URN-to-URL mapping
- API or skill has been renamed or removed
Solutions:
- Follow the exact resolution rules: maps to , not
- Check for the field which gives the canonical relative path
- For schemas, resolution is not slug-based: maps to
/schemas/x-origin.schema.json
x-origin Operation Not Found
Symptoms: The operationId referenced in x-origin does not exist in the target API spec
Possible causes:
- API spec version has changed
- Incorrect operationId spelling (operationIds are camelCase)
Solutions:
- Fetch the latest API spec via its URN and search for the operationId
- Check the API spec's for all available operations
Related Jobs
- secure-api: Apply security and traffic management policies to an API instance
- apply-policy-to-api-instance: Apply a specific policy to an existing API instance
- setup-service-scanner: Configure scanners to discover services from cloud platforms
- run-service-scan-and-view-results: Execute a scanner and view discovered services