rabit Specification

The protocol details

Manifest Schema

interface BurrowManifest {
  version: "1.0";
  title: string;
  description?: string;
  entries: BurrowEntry[];
}

type BurrowEntry = LinkEntry | BurrowRefEntry;

interface LinkEntry {
  type: "link";
  title: string;
  uri: string;
  mediaType?: string;
}

interface BurrowRefEntry {
  type: "burrow";
  title: string;
  uri: string; // URL to another .burrow.json
}
            

Discovery

Agents should look for `.burrow.json` in the root of a repository or website.