Arrey Documentation

Build with editable AI tools that stay documented by default

This is the user-facing reference for Arrey. Every tool page is generated from your registry manifest and README, so docs evolve as your tools evolve.

Registry tools

Source of truth

`registry/*/manifest.json` + `README.md`

Last sync

4/16/2026, 10:04:08 PM

Quickstart

$ npx arrey@latest init

$ npx arrey@latest add summarize

$ npx arrey@latest add extract

Installation

Initialize once, then add tools as needed. Arrey writes source files into your project so you keep full ownership and can customize behavior directly.

Configuration

provider:

name: openai

model: gpt-4o-mini

tools:

installed: [summarize, extract]

summarize:

provider:

model: gpt-4o

Your First Tool

extract

Extracts key facts from text, files, and URLs in configurable output formats.

summarize

Summarizes text, files, and URLs into configurable formats. Handles long documents via semantic chunking.

transcribe

Transcribes audio from URLs with optional cleanup and provider-aware configuration.

How Tools Work

Every tool follows the same canonical layout: `index.ts`, `prompt.ts`, `manifest.json`, and `README.md`. This enables consistent execution and predictable documentation generation.

The ctx Object

`ctx` gives each tool completion, streaming, chunking, validation, memory, and composition primitives through one runtime interface.

Provider System

Swap providers without rewriting your tools. OpenAI, Anthropic, Ollama, Azure, and custom implementations are supported through a shared contract.

Tool Composition

Combine primitives into specialized workflows while preserving transparent, editable source code in your own project.