Aggregated Docs for LLMs

Reference the entire Yield.xyz documentation in your AI tool via llms.txt, llms-full.txt, MCP, and OpenAPI

Add Yield.xyz Docs to Your LLM

Yield.xyz provides machine-readable documentation files that follow the llms.txt standard, making it easy to feed our entire docs into any LLM, AI agent, or coding assistant.

---

LLM-Optimized Documentation Files

These are the primary resources for giving an LLM full context on Yield.xyz.

llms.txt

Structured directory of all documentation pages with titles, descriptions, and URLs — lightweight and fast to ingest

llms-full.txt

Complete documentation content in a single file — gives your LLM full context on every page

When to use which

File	Size	Best for
llms.txt	~15 KB	Quick reference, link discovery, building a docs index for RAG pipelines
llms-full.txt	~740 KB	Full-context ingestion — paste into ChatGPT, Claude, or use as a knowledge base

For most AI assistants, llms-full.txt is the best option — it gives the LLM the complete documentation content in a single copy-paste or file upload.

---

Agent Skills & Capability Files

For AI agents that support the agentskills.io specification, Yield.xyz provides structured skill files:

skill.md

Root capability file describing all available Yield.xyz agent skills

Agent Skills Guide

Detailed guide on using Yield.xyz skills with Cursor, Claude Code, Codex, and Gemini CLI

Install skills into your AI agent:

npx skills add https://docs.yield.xyz

---

API Specifications

For API-focused workflows, use the OpenAPI spec directly:

Swagger UI

Interactive API documentation with try-it-out functionality

OpenAPI Spec (YAML)

Full OpenAPI specification for programmatic access

OpenAPI Spec (JSON)

JSON version of the OpenAPI specification

MCP Server

Connect your AI tool directly via Model Context Protocol

---

Quick Access Links

Resource	URL
llms.txt	https://docs.yield.xyz/llms.txt
llms-full.txt	https://docs.yield.xyz/llms-full.txt
skill.md	https://docs.yield.xyz/skill.md
MCP Server	https://yieldxyz.mintlify.app/mcp
Swagger UI	https://api.yield.xyz/docs
OpenAPI YAML	https://api.yield.xyz/docs.yaml
OpenAPI JSON	https://api.yield.xyz/openapi.json
Documentation	https://docs.yield.xyz

---

Supported AI Assistants

ChatGPT

Upload llms-full.txt or paste the OpenAPI spec

Claude

Upload llms-full.txt or use the MCP server

Cursor

Use agent skills, MCP, or index docs directly

Perplexity

Point to docs.yield.xyz for search + AI answers

---

Using with ChatGPT

1. Download llms-full.txt
2. Attach the file to your ChatGPT conversation
3. Ask questions about the Yield.xyz API

Example prompt:

Based on the attached Yield.xyz documentation, help me understand 
how to implement a staking flow for Ethereum with Lido.

You can also upload the OpenAPI YAML spec for API-specific questions with request/response schemas.

---

Using with Claude

1. Download llms-full.txt
2. Upload it to your Claude conversation
3. Reference it in your prompts

Example prompt:

Using the Yield.xyz docs I uploaded, create a TypeScript 
function that lists all available yields on Ethereum and 
filters by APY greater than 5%.

---

Using with Cursor

See our dedicated Cursor Setup Guide for detailed instructions on integrating Yield.xyz docs with Cursor IDE, including MCP server configuration and agent skills.

---

API Overview

The Yield.xyz API provides endpoints for:

Discovery

• GET /v1/yields - List all yield opportunities
• GET /v1/yields/{yieldId} - Get yield metadata
• GET /v1/yields/{yieldId}/validators - Get validators for a yield
• GET /v1/networks - List supported networks
• GET /v1/providers - List all providers

Portfolio

• POST /v1/yields/balances - Get balances across multiple yields
• POST /v1/yields/{yieldId}/balances - Get balances for a specific yield

Actions

• POST /v1/actions/enter - Enter a yield position
• POST /v1/actions/exit - Exit a yield position
• POST /v1/actions/manage - Manage a yield (claim rewards, restake, etc.)
• PUT /v1/transactions/{transactionId}/submit-hash - Submit transaction hash
• POST /v1/transactions/{transactionId}/submit - Submit signed transaction

---

Next Steps

Agent Skills

Use AI agent skills for Yield.xyz

Cursor Setup

Set up Cursor IDE

Prompting Patterns

Effective prompts for Yield.xyz

API Reference

Full API documentation