Skip to main content

Documentation Index

Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Yield.xyz provides a set of agent skills following the Agent Skills open standard that enable AI agents to autonomously interact with the Yield.xyz API. These skills are structured, machine-readable capability files that tell AI agents exactly how to discover yields, manage positions, and track portfolios.
Agent skills work with any AI tool that supports the agentskills.io specification, including Cursor, Claude Code, OpenAI Codex, Gemini CLI, and others.

​
Quick Start

​
Install via Skills CLI

Add Yield.xyz skills to your AI agent’s context: 
npx skills add https://docs.yield.xyz

​
Manual Setup

You can also reference the skill files directly. Each skill is a directory containing a SKILL.md file: 
skills/
├── find-yields/
│   └── SKILL.md
├── get-yield-info/
│   └── SKILL.md
├── enter-position/
│   └── SKILL.md
├── exit-position/
│   └── SKILL.md
├── manage-position/
│   └── SKILL.md
└── check-portfolio/
    └── SKILL.md

​
Available Skills

find-yields

Search and discover yield opportunities across 2,900+ options on 80+ networks. Filter by network, token, provider, type, or APY.

get-yield-info

Retrieve detailed metadata, APY/APR rates, token information, validator data, and protocol details for a specific yield.

enter-position

Enter (deposit into) a yield position by generating unsigned transactions. Covers staking, lending, vaults, and all yield types.

exit-position

Exit (withdraw from) a yield position. Handles unstaking, withdrawals, cooldown periods, and partial exits.

manage-position

Manage existing positions: claim rewards, restake, claim unstaked tokens, rebond, vote, and other lifecycle operations.

check-portfolio

View yield portfolio balances and positions across multiple networks and protocols. Track rewards and unstaking progress.

​
Skill Format

Each skill follows the agentskills.io specification with:
  • YAML frontmatter containing name, description, and metadata
  • Markdown body with step-by-step instructions, API endpoints, request/response examples, and error handling guidance
---
name: find-yields
description: Search and discover yield opportunities...
license: MIT
metadata:
  author: yield-xyz
  version: "1.0"
---

​
How It Works

When an AI agent encounters a task related to Yield.xyz (e.g., “Find the best ETH staking yields”), it:
1

Skill detection

The agent reads the skill’s name and description to determine if the skill is relevant to the user’s request.
2

Skill activation

The agent loads the full SKILL.md content to get detailed instructions.
3

API execution

The agent follows the step-by-step instructions to make API calls, handle pagination, and process responses.
4

Result presentation

The agent formats and presents the results to the user.

​
Example Prompts

Once skills are installed, try these prompts with your AI coding tool:
  • “What are the best yields for ETH right now?”
  • “Show me all staking options on Solana”
  • “Find USDC lending yields with the highest APY”
  • “Compare Aave vs Compound yields on Ethereum”
  • “Stake 1 ETH with Lido”
  • “Deposit 5000 USDC into Aave on Arbitrum”
  • “Unstake my ATOM from Cosmos”
  • “Claim my staking rewards”
  • “Show my yield portfolio across all networks”
  • “Check my staking balance on Ethereum”
  • “Do I have any rewards to claim?”
  • “What’s the status of my DOT unstaking?”

​
Prerequisites

To use these skills, you need:
  1. A Yield.xyz API key — sign up at dashboard.yield.xyz
  2. An AI tool that supports agent skills (Cursor, Claude Code, Codex, Gemini CLI)
  3. The API key set as an environment variable:
export YIELD_API_KEY=your_api_key_here

​
Using with Cursor

If you’re using Cursor IDE, you can reference the skills directly in your project:
  1. Add the skills directory to your project
  2. Reference skills in your Cursor rules (.cursor/rules/)
  3. The agent will automatically detect and use relevant skills
See Cursor Setup for detailed configuration.

​
Using with LLMs

For direct LLM integration, you can also use:
  • /llms.txt — Directory of all documentation pages
  • /llms-full.txt — Complete documentation content for full context
  • /skill.md — Root capability file describing all skills
See Using Docs with LLMs for more details.

​
Next Steps

Cursor Setup

Set up Cursor IDE for Yield.xyz development

Prompting Patterns

Effective prompts for Yield.xyz with AI

API Reference

Full API documentation

Guardrails

Safety considerations for AI-assisted development