Skip to content
Pilotoo
v0.1

0.1.0 Latest

ChangelogHow versions work

Concepts

Introduction

Section titled “Introduction”

Every page of this documentation uses the terms below in the same sense. Skim this page once, then come back when a word is unfamiliar.

Who is who

Section titled “Who is who”
Term Meaning
Host The product that embeds the kit. It provides identity, tools and the screen.
Kit The packages in this repository, taken together.
Operator Whoever runs the server and pays for the models. The operator owns the configuration folder.
Tenant The unit that owns conversations and agents on a shared server. Every query is scoped to it.
Instance One server process.

Extension points

Section titled “Extension points”
Term Meaning
Port An interface the kit declares and the host implements.
Registry A list in code the host adds entries to. It is the only gate that decides what is enabled.
Identity Who is calling: the caller, its tenant and its roles. Supplied by the host.
Transport How commands and events move between a client and a runtime. The app hands one to the client.

Agents and models

Section titled “Agents and models”
Term Meaning
Agent definition The description of an agent: name, prompt, model profile, tools, skills and knowledge.
Model profile A named model configuration: a provider:model_id reference plus parameters such as temperature.
Provider A named model endpoint: its kind, URL and the name of the environment variable that holds its key.
System agent An agent defined in a file in .pilotoo/. Shared by every tenant and read-only.
Agent template A common agent copied into each tenant once, then owned by the tenant.
Subagent Another agent an orchestrator delegates part of its work to.

Tools, skills and knowledge

Section titled “Tools, skills and knowledge”
Term Meaning
Server tool A function the agent can call, registered in code on the server and enabled per agent.
Client tool A function the agent can call that the client serves. The client declares it on every run. It is blocking when the run waits for the answer, or one-way when the run carries on.
Skill A SKILL.md document the agent reads on demand. It is read, never executed.
Knowledge Passages the host retrieves and packs into the prompt under a token limit.

Conversations

Section titled “Conversations”
Term Meaning
Thread (also conversation) The durable unit a run belongs to.
Run One execution of an agent on a thread, streamed as numbered events.
Gateway The server’s Socket.IO endpoint, which receives commands and streams runs back.
Envelope One numbered event of a run, addressed to its thread.
Interrupt A point where a run pauses for a human decision or a blocking client tool, and resumes later.

Next steps

Section titled “Next steps”