Inputs

Your AI agent needs the suites, the machines and this documentation. The table below shows the inputs each kind of request requires.

✓ required. A (number) marks an input required only for some requests of that kind, for example:

1. The suite repositories, when an analysis goes into the test code or fixes what it found.
2. The endpoints file, when a test is added and run at once.
3. The endpoints file, when an analysis has to know which operating system a machine runs.
4. The endpoints file, when a scheduled prompt runs the tests it added or analyzes their results.

Creating a suite from the documentation of the system under test needs no repository.

Suite repositories

Clone the suites your AI agent may run or extend into the folder it works from, for example the network suite repository described on the Network Suite page. To start a new suite from the documentation of the system under test, an empty folder is enough.

Endpoints file

Register the lab machines in the controller's Endpoints panel and press Save. The file it writes is the list of machines your AI agent works from. Put it in the run folder, beside the suite repositories. The Technical details page shows its format.

Orcraft instructions link

Give your AI agent this link: https://orcraft.app/agent-instructions/. The page behind it is written for the AI agent: it links every page of this documentation the AI agent needs and states the rules of working with a suite.

Practical instructions file

The practical arrangement is an instructions file the AI agent reads at the start of every request, such as CLAUDE.md, AGENTS.md or GEMINI.md, in the folder it works from. It holds the link and the paths of your machine, so that no request has to repeat them. Replace every line of the Paths section with your own.

# Orcraft

Before any Orcraft request, read https://orcraft.app/agent-instructions/ and the pages it links.

## Paths (example - replace every line with your own)

- Suite repositories: `~/orcraft/orcraft-test-suite-network`, `~/orcraft/orcraft-test-suite-maze`
- Run folder: `~/orcraft/orcraft-runs`
- Endpoints file: `~/orcraft/orcraft-runs/endpoints.json`
- Python with the orcraft package installed: `~/orcraft/venv/bin/python`
- Nuttcp Tool Package field: `~/orcraft/tools/nuttcp`

A required field whose value is not in the code, such as the folder of a tool package, is listed in the Paths section as well. Otherwise the AI agent asks for it.