Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions SKILLS.md → .agents/skills/vortex-integration/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Vortex SKILLS.md
---
name: vortex-integration
description: Use when integrating Vortex or @vortexfi/sdk, including quotes, BRL PIX onramps/offramps, ramp register/update/start/status flows, webhook verification, ephemeral key custody, supported corridors, sandbox/production auth, and recovery from ramp errors.
---

# Vortex Integration Skill

A machine-loadable capability catalog for AI coding agents integrating Vortex into third-party applications. Each skill below is a self-contained unit with YAML frontmatter (`name`, `description`, `triggers`) plus a minimal recipe in both SDK and REST form.
A machine-loadable capability catalog for AI coding agents integrating Vortex into third-party applications. Start by reading **Global Context**, then match the user's task to the closest recipe below before implementing. Each recipe includes trigger phrases plus a minimal SDK and/or REST form.

> **Companion document**: [`docs/api/pages/12-ai-agent-integration.md`](https://api-docs.vortexfinance.co/ai-agent-integration) covers the raw-API contract, mandatory client responsibilities, and language-agnostic guidance. SKILLS.md focuses on **task-shaped recipes** an agent can match against user intent.
> **Companion document**: [AI Agent Integration](https://api-docs.vortexfinance.co/ai-agent-integration) covers the raw-API contract, mandatory client responsibilities, and language-agnostic guidance. This skill focuses on **task-shaped recipes** an agent can match against user intent.

---

Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@

Vortex is a gateway for cross-border payments. It is built on top of the Pendulum blockchain.

## AI Agent Skill

This repository includes a repo-scoped Codex/Agent Skills skill for Vortex integrations:

- [`.agents/skills/vortex-integration/SKILL.md`](.agents/skills/vortex-integration/SKILL.md)

When this repository is open in Codex, the skill is discovered automatically from `.agents/skills`. If you are integrating Vortex from another repository, install the public skill directory URL instead:

```text
https://github.com/pendulum-chain/vortex/tree/main/.agents/skills/vortex-integration
```

Use the skill for task-shaped guidance around quotes, BRL PIX onramps/offramps, ramp polling, webhook verification, supported corridors, auth setup, and error recovery. The hosted AI-agent integration guide is available at <https://api-docs.vortexfinance.co/ai-agent-integration>.

## Repository Structure

This is a **Bun monorepo** containing multiple sub-projects organized into apps, packages, and contracts:
Expand Down
1 change: 1 addition & 0 deletions docs/api/pages/12-ai-agent-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This page is written so that an AI coding agent (or a human engineer using one)
When you point an AI coding agent at Vortex:

- **Anchor the agent on this section first.** Pages 1–11 describe the protocol and contracts; this page describes what a correct client must do.
- **Load the Vortex integration skill if available.** This repository ships a Codex/Agent Skills skill at [`vortex-integration`](https://github.com/pendulum-chain/vortex/tree/main/.agents/skills/vortex-integration). If this repository is open in Codex, the skill is discovered automatically from `$REPO_ROOT/.agents/skills/vortex-integration/SKILL.md`; if you are integrating Vortex from another repository, install the public skill directory URL (`https://github.com/pendulum-chain/vortex/tree/main/.agents/skills/vortex-integration`) first, then match the user's task to the relevant recipe before implementing.
- **Treat the OpenAPI file as the source of truth for shapes**, and these Markdown pages as the source of truth for *behavior, ordering, custody, signing, and timing*. Both are required; neither is sufficient alone.
- **Pin versions.** Record the commit hash of these docs and the version of `@vortexfi/sdk` you are mirroring. The SDK's behavior is the reference implementation; if your integration disagrees with it, the SDK wins.
- **Never let the agent invent endpoints, fields, status values, or fee categories.** If something is not in the OpenAPI file or these pages, the agent should stop and ask.
Expand Down
Loading