AI-Friendly Features

How AI agents and LLMs can interact with Avail documentation — llms.txt, markdown access, MCP servers, agent skills, and more.

Avail documentation is built to be consumed by AI agents, LLMs, and developer tools alongside human readers. This page describes every AI-friendly feature available.

Feature Overview

Feature	Access	Description
llms.txt hub	`GET /llms.txt`	Lightweight routing index with quick-reference links and page listing
Section spokes	`GET /llms-da.txt`, `/llms-nexus.txt`	Focused content dumps per product (fits within context windows)
Full dump	`GET /llms-full.txt`	All documentation as a single text file
.md suffix	Append `.md` to any page URL	Get any docs page as clean markdown
Content negotiation	`Accept: text/markdown` header	Request markdown from any docs URL via HTTP header
Markdown API	`GET /api/markdown/{slug}`	Programmatic markdown access with JSON option
Structured data	`GET /api/reference.json`	Networks, contracts, SDKs as machine-readable JSON
AI headers	Automatic	`Content-Signal`, `X-Robots-Tag`, and `Vary` on all AI responses
Agent detection	Automatic	Identifies Claude, ChatGPT, Cursor, Perplexity via User-Agent
Copy for LLM	Page sidebar	One-click copy of cleaned markdown for the current page
Ask AI	Page sidebar	Open page context in v0, ChatGPT, or Claude
MCP Server	shadcn MCP	Browse and install Avail Widgets via natural language
Agent Skills	skills.sh	Install Nexus SDK and Widgets skills for AI coding agents

llms.txt Hub & Spoke Architecture

The documentation follows a hub-and-spoke pattern so agents can fetch only what they need:

Hub — /llms.txt: Quick reference links, network endpoints, and a full page index. Start here.
Spoke: DA — /llms-da.txt: Full content dump for Avail DA (data availability layer, build guides, operations, user guides, API reference).
Spoke: Nexus — /llms-nexus.txt: Full content dump for Avail Nexus (SDK, concepts, contracts, UI elements, supported chains and tokens).
Full dump — /llms-full.txt: Every page in one file. Supports ?section= filtering (e.g. ?section=da/build).

Section-Specific llms.txt

Spokes keep context usage efficient. For example, if an agent only needs Nexus SDK documentation:

curl https://docs.availproject.org/llms-nexus.txt

Or filter the full dump to a specific section:

curl "https://docs.availproject.org/llms-full.txt?section=nexus/nexus-sdk"

.md Suffix Access

Append .md to any documentation URL to get its content as clean markdown:

# Get a page as markdown
curl https://docs.availproject.org/docs/nexus/get-started.md
 
# Also supports JSON format
curl "https://docs.availproject.org/docs/nexus/get-started.md?format=json"

The markdown is cleaned for agent consumption — JSX components, import statements, and frontmatter are stripped, while Callouts, Tabs, and Cards are converted to readable text.

Content Negotiation

Send Accept: text/markdown in your HTTP request to receive markdown instead of HTML from any /docs/** URL:

curl -H "Accept: text/markdown" https://docs.availproject.org/docs/da/build/networks

Browser requests (with Accept: */*) still receive normal HTML pages.

Markdown API

The programmatic API at /api/markdown/{slug} powers all markdown features:

# Plain markdown
curl https://docs.availproject.org/api/markdown/nexus/get-started
 
# JSON format (includes title, description, URL, and content)
curl "https://docs.availproject.org/api/markdown/nexus/get-started?format=json"

JSON response shape:

{
  "title": "Get Started with Nexus",
  "description": "Introduction to Avail Nexus",
  "url": "/docs/nexus/get-started",
  "content": "## Get Started with Nexus\n\n..."
}

Structured Reference Data

Machine-readable reference data is available at /api/reference.json:

curl https://docs.availproject.org/api/reference.json

This returns structured JSON with networks, contract addresses, SDK packages, and other reference data that agents can parse directly.

AI Headers

All AI-facing responses include these headers:

Header	Value	Purpose
`Content-Signal`	`ai-train=yes, search=yes, ai-input=yes`	Signals content is available for AI training, search, and input
`X-Robots-Tag`	`noindex`	Prevents search engines from indexing raw markdown responses
`Vary`	`accept`	Tells CDNs to cache HTML and markdown representations separately

Agent Detection

The docs automatically detect AI agent requests via User-Agent patterns and track them with PostHog analytics. Recognized agents include:

Claude (Anthropic)
ChatGPT / GPT (OpenAI)
Cursor
Perplexity

This helps us understand how agents consume our documentation and improve the experience.

Page Actions

Every documentation page includes AI actions in the right sidebar:

Ask AI — Opens page content in v0, ChatGPT, or Claude with context pre-loaded
Copy for LLM — Copies the cleaned markdown of the current page to your clipboard
View as markdown — Opens the raw markdown in a new tab
AI features — Links to this page

MCP Server for Avail Widgets

The Avail Widgets registry supports the Model Context Protocol (MCP), allowing AI assistants to browse, search, and install the Nexus Widget with natural language.

Quick Setup

Add the Avail Widgets registry

Add to your project's components.json:

components.json

{
  "registries": {
    "@avail-widgets": "https://widgets.availproject.org/r/{name}.json"
  }
}

Initialize the MCP server


pnpm dlx shadcn@latest mcp init --client cursor

Enable the shadcn MCP server in Cursor Settings.

Use natural language to install components

Once connected, try prompts like:

"Show me all available components in the Avail Widgets registry"
"Add @avail-widgets/nexus to my project"
"Set up the NexusProvider and render the Nexus Widget in swap mode"

For full details, see the MCP & Agent Skills documentation.

Agent Skills

skills.sh skills give AI coding agents (Codex, Claude Code, Cursor, etc.) deep context about the Nexus SDK and Widgets. Two skill packages are available:

Nexus SDK Skills

The Nexus SDK repository ships the nexus-core skill, covering client lifecycle, operations, hooks, events, error handling, utils, and v1 → v2 migration.


pnpm dlx skills add availproject/nexus-sdk

For full details, see the Skills Integration reference.

Avail Widgets Skills

The Avail Widgets repository ships skills that help agents scaffold and integrate the Nexus Widget for swaps, sends, and deposits.

# Install all Widgets skills
npx skills add availproject/nexus-elements
 
# Install a single skill
npx skills add https://github.com/availproject/nexus-elements --skill nexus-widget-swaps

For the full list of available skills, see MCP & Agent Skills. Browse all available skills at skills.sh/availproject/nexus-elements and skills.sh/availproject/nexus-sdk.

Summary for Agents

If you are an AI agent reading this page, here is the quickest path to Avail documentation:

Start with /llms.txt for an overview and quick reference
Fetch section spokes for focused content: /llms-da.txt or /llms-nexus.txt
Get individual pages by appending .md to any URL (e.g. /docs/nexus/get-started.md)
Use the JSON API at /api/markdown/{slug}?format=json for structured page data
Reference data is at /api/reference.json
Full SDK TypeDoc at availproject.github.io/nexus-sdk

How is this guide?

Gas Relay Deprecated

Feature

Access

Description

llms.txt hub

GET /llms.txt

Lightweight routing index with quick-reference links and page listing

Section spokes

GET /llms-da.txt, /llms-nexus.txt

Focused content dumps per product (fits within context windows)

Full dump

GET /llms-full.txt

All documentation as a single text file

.md suffix

Append .md to any page URL

Get any docs page as clean markdown

Content negotiation

Accept: text/markdown header

Request markdown from any docs URL via HTTP header

Markdown API

GET /api/markdown/{slug}

Programmatic markdown access with JSON option

Structured data

GET /api/reference.json

Networks, contracts, SDKs as machine-readable JSON

AI headers

Automatic

Content-Signal, X-Robots-Tag, and Vary on all AI responses

Agent detection

Automatic

Identifies Claude, ChatGPT, Cursor, Perplexity via User-Agent

Copy for LLM

Page sidebar

One-click copy of cleaned markdown for the current page

Ask AI

Page sidebar

Open page context in v0, ChatGPT, or Claude

MCP Server

shadcn MCP

Browse and install Avail Widgets via natural language

Agent Skills

skills.sh

Install Nexus SDK and Widgets skills for AI coding agents

# Plain markdown curl https://docs.availproject.org/api/markdown/nexus/get-started # JSON format (includes title, description, URL, and content) curl "https://docs.availproject.org/api/markdown/nexus/get-started?format=json"

Header

Value

Purpose

Content-Signal

ai-train=yes, search=yes, ai-input=yes

Signals content is available for AI training, search, and input

X-Robots-Tag

noindex

Prevents search engines from indexing raw markdown responses

Vary

accept

Tells CDNs to cache HTML and markdown representations separately

Search Documentation

AI-Friendly Features

Feature Overview

llms.txt Hub & Spoke Architecture

Section-Specific llms.txt

.md Suffix Access

Content Negotiation

Markdown API

Structured Reference Data

AI Headers

Agent Detection

Page Actions

MCP Server for Avail Widgets

Quick Setup

Add the Avail Widgets registry

Initialize the MCP server

Use natural language to install components

Agent Skills

Nexus SDK Skills

Avail Widgets Skills

Summary for Agents

Search Documentation

AI-Friendly Features

Feature Overview

llms.txt Hub & Spoke Architecture

Section-Specific llms.txt

.md Suffix Access

Content Negotiation

Markdown API

Structured Reference Data

AI Headers

Agent Detection

Page Actions

MCP Server for Avail Widgets

Quick Setup

Add the Avail Widgets registry

Initialize the MCP server

Use natural language to install components

Agent Skills

Nexus SDK Skills

Avail Widgets Skills

Summary for Agents