Skip to main content

Documentation Index

Fetch the complete documentation index at: https://aixyz.sh/llms.txt

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

Adds a human-readable plain text page to your AixyzApp showing agent name, description, version, and skills. 
import { IndexPagePlugin } from "aixyz/app/plugins/index-page";

await server.withPlugin(new IndexPagePlugin());

​
Behavior

Registers a GET handler at the given path that responds with text/plain content: 
My Agent
========

Description: A helpful travel agent
Version: 0.1.0

Skills:

1. Search Flights
   ID: search-flights
   Description: Search for flights between airports
   Tags: travel, flights
   Examples:
   - Find flights from SFO to LAX
The output includes:
  • Agent name and a separator line
  • Description and version from config
  • Skills list with IDs, descriptions, tags, and examples (if configured)

​
Usage

The auto-generated server registers the IndexPagePlugin automatically at "/". In a custom server, register it explicitly:
app/server.ts
import { AixyzApp } from "aixyz/app";
import { IndexPagePlugin } from "aixyz/app/plugins/index-page";

const server = new AixyzApp();

// Mount at root (default)
await server.withPlugin(new IndexPagePlugin());

await server.initialize();

export default server;