Home / mendixlabs / mxcli · .claude/skills/mendix/rest-client/SKILL.md · GitHub

rest-client skillA

rest-client is agent-read markdown (skill) from mendixlabs/mxcli: Call external REST APIs from Mendix — the three approaches (inline REST CALL, consumed REST client document, generated from OpenAPI) and how to choose. Use when integrating with any external REST API..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# REST Integration Skill

Use this skill when integrating with external REST APIs from Mendix.

## Three Approaches

Mendix offers three ways to call REST APIs from microflows. Choose based on the use case:

| Approach | When to Use | Artifacts |
|----------|-------------|-----------|
| **OpenAPI import** | API has an OpenAPI 3.0 spec — auto-generate from the spec | REST client document generated in one command |
| **REST Client (manual)** | No spec available, or need fine-grained control | REST client document + microflow |
| **REST CALL (inline)** | One-off calls, quick prototyping, dynamic URLs, low-level HTTP control | Microflow only |

Both REST Client approaches can be combined with **Data Transformers** (Mendix 11.9+) and **Import/Export Mappings** to map between JSON and entities.

No API to call against yet — or one you would rather not depend on while building? [mock-rest-apis](../mock-rest-apis/SKILL.md) covers standing up an endpoint you control and pointing the app at it.

---

## Approach 0: OpenAPI Import (Fastest)

If the API has an OpenAPI 3.0 spec (JSON or YAML), generate the REST client in one command:

```sql
-- From a local file (relative to the .mpr file)
…

Read the whole file at its exact version.

How to install

Latest version
mdr add mendixlabs/mxcli/rest-client@git:20260825.db9ee43
Exact content
mdr add mendixlabs/mxcli/rest-client@sha256:f8775ae7e46cd2fb

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_6bmn2dafrxldagey.svg)](https://markdownregistry.com/a/art_6bmn2dafrxldagey)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
git:20260825.db9ee43 latest2026-08-25 db9ee43 14,887 BA view · diff
git:20260821.ff81a242026-08-21 ff81a24 13,715 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (14887 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

mendixlabs/mxcli · 124 stars · license Apache-2.0 · pushed 2026-09-24 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_6bmn2dafrxldagey
GET https://markdownregistry.com/api/v1/resolve?ref=mendixlabs/mxcli/rest-client
GET https://markdownregistry.com/api/v1/blob/f8775ae7e46cd2fb99edb63d4c64ef3c531bef84e011fbbc17a808a465280cde

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from mendixlabs/mxcli

agents skill
mendixlabs/mxcli · .claude/skills/mendix/agents/SKILL.md · Author Mendix AI agent documents in MDL — Model, Knowledge Base, Consumed MCP Service and Agent, with variables, tools…
git:20260922.4954f84 · audit A · 124 stars
alter-page skill
mendixlabs/mxcli · .claude/skills/mendix/alter-page/SKILL.md · Modify an existing page or snippet's widget tree in place with ALTER PAGE / ALTER SNIPPET — SET, INSERT, DROP, REPLACE…
git:20260923.328828c · audit A · 124 stars
analyze-runtime skill
mendixlabs/mxcli · .claude/skills/mendix/analyze-runtime/SKILL.md · Find out what a running Mendix app actually does — logs, Prometheus metrics, OpenTelemetry traces and the model…
git:20260821.ff81a24 · audit B · 124 stars
assess-migration skill
mendixlabs/mxcli · .claude/skills/mendix/assess-migration/SKILL.md · Investigate an existing non-Mendix application (Java, .NET, Python, Node, PHP, …) and produce a structured migration…
git:20260821.ff81a24 · audit A · 124 stars
assess-quality skill
mendixlabs/mxcli · .claude/skills/mendix/assess-quality/SKILL.md · Audit a Mendix project against best practices for naming, security, performance, maintainability and architecture, and…
git:20260821.ff81a24 · audit A · 124 stars
atlas-design skill
mendixlabs/mxcli · .claude/skills/mendix/atlas-design/SKILL.md · Make a Mendix app look designed rather than default-Atlas: layout, spacing, typography, colour and design properties…
git:20260915.3d3ca1f · audit A · 124 stars
bootstrap-app skill
mendixlabs/mxcli · .claude/skills/mendix/bootstrap-app/SKILL.md · Provision a Mendix project in a repo that has none — interview, `mxcli new`, session hook, project brief, first commit…
git:20260922.98aa174 · audit A · 124 stars
browse-integrations skill
mendixlabs/mxcli · .claude/skills/mendix/browse-integrations/SKILL.md · Discover the external services a project consumes and browse their cached contracts through the MDL CATALOG — OData…
git:20260821.ff81a24 · audit A · 124 stars
bulk-widget-updates skill
mendixlabs/mxcli · .claude/skills/mendix/bulk-widget-updates/SKILL.md · Discover and bulk-change widget properties across many pages with SHOW WIDGETS and UPDATE WIDGETS. Use when the same…
git:20260821.ff81a24 · audit A · 124 stars
business-events skill
mendixlabs/mxcli · .claude/skills/mendix/business-events/SKILL.md · Define event-driven APIs over Kafka with Mendix business event services — publish and subscribe contracts…
git:20260821.ff81a24 · audit A · 124 stars
catalog-search skill
mendixlabs/mxcli · .claude/skills/mendix/catalog-search/SKILL.md · Search the Mendix Catalog platform service registry (catalog.mendix.com) from the CLI to find services published across…
git:20260821.ff81a24 · audit A · 124 stars
cheatsheet-errors skill
mendixlabs/mxcli · .claude/skills/mendix/cheatsheet-errors/SKILL.md · Quick fixes for the MDL syntax errors that come up most: undeclared variables, wrong retrieve source, list operations…
git:20260911.0d73eed · audit A · 124 stars

Every file in mendixlabs/mxcli

Browse by kind, by grade A, or by owner.