Designer
Developer
Plugin
DevOps
ContractsWhy documentation for agents?
Traditional documentation explains concepts to humans. The Agent Kit takes a different approach — it provides precise, specification-style instructions that AI agents can follow mechanically. Each role gets only the information relevant to its task, reducing hallucination and keeping agents within their boundaries.
The Agent Kit is generated into the agent-kit/ folder in your project root by running jay-stack setup followed by jay-stack agent-kit. Setup initializes your project's services; agent-kit then executes plugin generators against those live services to produce contracts that reflect your project's actual configured state. The result isn't generic documentation — it's a machine-readable manifest of what your project can do right now.
What's in the Kit
Plugins Index
plugins-index.yaml
The master discovery index. Lists every installed plugin's contracts, actions, services, contexts, routes, and CLI commands. This is how an agent finds out what's available — a single machine-readable manifest for the entire project.
Materialized Contracts
materialized-contracts/
Static contracts copied and dynamic contracts generated by executing plugin code against your project's live services. These aren't just docs — they're the actual tag schemas, data types, and props that agents bind to when writing templates and components.
References
references/
Plugin-generated reference data from your project's data sources — product catalogs, collection schemas, media indexes. Agents use these to produce realistic, grounded content instead of placeholder data.
Role Guides
designer/developer/plugin/devops/
Each role gets its own directory with an INSTRUCTIONS.md entry point and topic-specific guides — template syntax, routing, component state, deployment, and more. Agents read only the guides relevant to their role.
How Agents Use It
Discover
Read plugins-index.yaml and the role's INSTRUCTIONS.md to learn what's available and how to work with it.
Understand
Read materialized contracts for exact tag schemas, data types, and prop definitions. Read references for real project data — product catalogs, collection schemas.
Execute
Write code that follows the contracts. Run CLI commands like jay-stack action for live data discovery and code generation.
Validate
Run jay-stack validate to check correctness. When validation fails, the agent-kit guides explain the fix — a feedback loop back to the contracts and patterns.
Browse by Role
These guides are published here for the curious human. AI agents read them directly from the agent-kit/ folder in your project root, generated locally by the CLI.
Designer
Creates .jay-html pages and templates. Binds to contract data using template syntax — data bindings, conditions, loops, and refs. Styles pages with CSS.
Developer
Creates page components, defines page contracts, configures routing, and sets up project services. Builds the full-stack logic — unburdened from HTML or CSS.
13 guides →
Plugin Developer
Creates reusable headless components packaged as plugins. Defines contracts, actions, services, and CLI commands that other projects consume.
20 guides →
DevOps
Handles production builds, deployment configuration, serving modes, and cache invalidation. Manages the Two-Server Architecture.
6 guides →
Contracts
The central binding concept. Contracts are the source of truth that connects plugin logic to designer templates — the agent-kit materializes them into a discoverable form. Covers YAML syntax, page and component contracts, linked contracts, and graduated examples.
5 guides →Extensible by plugins. The agent-kit isn't static framework docs — plugins can extend it with their own role-specific guides. When you install a plugin, its guides are automatically included in the kit alongside the framework's own documentation, growing the kit with your project.