> ## Documentation Index
> Fetch the complete documentation index at: https://yieldxyz.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://llmstxt.org/), 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.

<CardGroup cols={2}>
  <Card title="llms.txt" icon="file-lines" href="https://yieldxyz-documentation.mintlify.app/llms.txt">
    Structured directory of all documentation pages with titles, descriptions, and URLs — lightweight and fast to ingest
  </Card>

  <Card title="llms-full.txt" icon="file" href="https://yieldxyz-documentation.mintlify.app/llms-full.txt">
    Complete documentation content in a single file — gives your LLM full context on every page
  </Card>
</CardGroup>

### 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 |

<Tip>
  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.
</Tip>

***

## Agent Skills & Capability Files

For AI agents that support the [agentskills.io specification](https://agentskills.io/specification), Yield.xyz provides structured skill files:

<CardGroup cols={2}>
  <Card title="skill.md" icon="robot" href="https://docs.yield.xyz/skill.md">
    Root capability file describing all available Yield.xyz agent skills
  </Card>

  <Card title="Agent Skills Guide" icon="book" href="/guides/ai/agent-skills">
    Detailed guide on using Yield.xyz skills with Cursor, Claude Code, Codex, and Gemini CLI
  </Card>
</CardGroup>

Install skills into your AI agent:

```bash theme={null}
npx skills add https://docs.yield.xyz
```

***

## API Specifications

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

<CardGroup cols={2}>
  <Card title="Swagger UI" icon="code" href="https://api.yield.xyz/docs">
    Interactive API documentation with try-it-out functionality
  </Card>

  <Card title="OpenAPI Spec (YAML)" icon="file-code" href="https://api.yield.xyz/docs.yaml">
    Full OpenAPI specification for programmatic access
  </Card>

  <Card title="OpenAPI Spec (JSON)" icon="file-code" href="https://api.yield.xyz/openapi.json">
    JSON version of the OpenAPI specification
  </Card>

  <Card title="MCP Server" icon="server" href="https://yieldxyz.mintlify.app/mcp">
    Connect your AI tool directly via Model Context Protocol
  </Card>
</CardGroup>

***

## 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

<CardGroup cols={2}>
  <Card title="ChatGPT" icon="message">
    Upload llms-full.txt or paste the OpenAPI spec
  </Card>

  <Card title="Claude" icon="brain">
    Upload llms-full.txt or use the MCP server
  </Card>

  <Card title="Cursor" icon="code">
    Use agent skills, MCP, or index docs directly
  </Card>

  <Card title="Perplexity" icon="magnifying-glass">
    Point to docs.yield.xyz for search + AI answers
  </Card>
</CardGroup>

***

## Using with ChatGPT

1. Download [`llms-full.txt`](https://docs.yield.xyz/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.
```

<Tip>
  You can also upload the [OpenAPI YAML spec](https://api.yield.xyz/docs.yaml) for API-specific questions with request/response schemas.
</Tip>

***

## Using with Claude

1. Download [`llms-full.txt`](https://docs.yield.xyz/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](/guides/ai/cursor-setup) 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

<CardGroup cols={2}>
  <Card title="Agent Skills" icon="robot" href="/guides/ai/agent-skills">
    Use AI agent skills for Yield.xyz
  </Card>

  <Card title="Cursor Setup" icon="code" href="/guides/ai/cursor-setup">
    Set up Cursor IDE
  </Card>

  <Card title="Prompting Patterns" icon="message" href="/guides/ai/prompting-patterns">
    Effective prompts for Yield.xyz
  </Card>

  <Card title="API Reference" icon="book" href="/api-reference/getting-started">
    Full API documentation
  </Card>
</CardGroup>
