Set up
Runs on your computer. Pick your agent and operating system.
This project does not publish an install method we can turn into a config. Follow the README instead.
README
synced Oct 25, 2026What FrootAI provides
FrootAI is a vendor-neutral context-wiring system for AI delivery. The FAI Protocol defines how reusable primitives are assembled into complete, evaluated Solution Plays without coupling the architecture to one model, cloud, or agent framework.
| Public building block | Current catalog | Purpose |
|---|---|---|
| Solution Plays | 101 | Complete architecture, DevKit, TuneKit, SpecKit, infrastructure, and evaluation contracts |
| Agents | 238 | Specialized roles with explicit responsibilities and constraints |
| Instructions | 176 | Scoped coding, architecture, governance, and operational policies |
| Skills | 333 | Reusable procedures, domain knowledge, and delivery playbooks |
| Hooks | 11 | Lifecycle guardrails and deterministic checks |
| Plugins | 77 | Installable bundles of compatible primitives |
| Knowledge modules | 25 | FROOT learning path from foundations through production |
Catalog counts come from the committed Factory catalog and are validated in CI.
Start with an outcome
The fastest path is to choose a Solution Play, install its Agentic OS assets, and adapt the included architecture and evaluation gates.
- Discover — compare Solution Plays or search the Solution Accelerator.
- Define — inspect the Play architecture, security boundaries, cost direction, and Well-Architected alignment.
- Develop — use the packaged agents, instructions, skills, prompts, hooks, and MCP configuration.
- Govern — validate the FAI manifest and retain evidence for every automated decision.
- Verify and improve — run evaluation gates, review failures, and tune configuration before deployment.
flowchart LR
D["Discover"] --> F["Define"] --> B["Develop"] --> G["Govern"] --> V["Verify and improve"]
Install a delivery surface
Published artifacts are the supported installation boundary for distribution products.
| Surface | Install | Current release |
|---|---|---|
| FrootAI MCP | npx -y frootai-mcp | 6.1.1 |
| FrootAI CLI | npx -y frootai@6.2.0 | 6.2.0 |
| VS Code | code --install-extension frootai.frootai-vscode | 6.7.3 |
| Python SDK | pip install frootai==5.1.0 | 5.1.0 |
| Python MCP | pip install frootai-mcp==6.1.0 | 6.1.0 |
MCP configuration
{
"servers": {
"frootai": {
"command": "npx",
"args": ["-y", "frootai-mcp"]
}
}
}
Use the MCP setup guide for VS Code, Claude, Cursor, Docker, Python, and hosted read-only access.
Container availability and immutable image tags are published on the FrootAI packages page. Pin an explicit version or digest before production use.
Existing deployments that reference ghcr.io/frootai/frootai-mcp should verify package visibility and migrate to a published immutable tag or digest before changing production configuration.
The FAI Protocol
A Solution Play is wired by fai-manifest.json. The manifest resolves compatible primitives, shared knowledge, guardrails, configuration, infrastructure, and evaluation requirements.
{
"schemaVersion": "1.0.0",
"play": "01-enterprise-rag",
"primitives": {
"agents": ["./.github/agents/builder.agent.md"],
"instructions": ["./.github/instructions/security.instructions.md"],
"skills": ["./.github/skills/evaluate-rag/SKILL.md"]
},
"evaluation": {
"required": true
}
}
Public repository scope
This repository is the public home for the FAI Protocol, schemas, conformance assets, community primitives, Solution Plays, learning content, examples, governance, and public integration contracts.
Distribution products and hosted services are released through controlled delivery pipelines. Historical or transitional implementation directories that remain in this repository are not the release authority and will be addressed only through compatibility-gated migrations. No consumer-facing path should be removed without replacement contracts and release-continuity validation.
See Repository Scope for the durable public/private boundary.
Repository map
agents/ Public agent primitives
instructions/ Scoped instruction primitives
skills/ Reusable skills and bundled references
hooks/ Lifecycle and policy hooks
plugins/ Community-distributed primitive bundles
workflows/ Agentic workflow definitions
solution-plays/ Complete public architecture contracts
fai-protocol/ FAI Protocol specification
schemas/ Machine-readable contracts
conformance/ Protocol compatibility fixtures and results
docs/ FROOT knowledge modules
cookbook/ Composition recipes
workshops/ Hands-on learning material
orchard/ Public registry, schemas, and community submissions
Trust and engineering standards
- Evidence over claims — catalog and conformance results are generated and checked.
- Least privilege — integrations use explicit permissions and bounded tool access.
- No secret material — never commit credentials, private keys, customer data, or production configuration.
- Versioned contracts — schema and manifest changes require compatibility review.
- Reproducible delivery — published artifacts are versioned and validated before release.
- Responsible AI — security, safety, reliability, cost, and observability are part of the architecture contract.
Report vulnerabilities privately through SECURITY.md. Do not open a public security issue.
Contributing
Contributions are welcome for public protocol work, schemas, documentation, primitives, Solution Plays, recipes, workshops, and community registry content.
Before opening a pull request:
- Read CONTRIBUTING.md and GOVERNANCE.md.
- Follow the Code of Conduct.
- Keep changes inside the documented public repository scope.
- Add validation or conformance evidence where the contract changes.
- Use the issue and pull-request templates so reviews remain reproducible.
For help, see SUPPORT.md. For planned public work, see ROADMAP.md.
License
The public protocol, catalog, and community material in this repository are available under the MIT License, unless a contained file or third-party component states otherwise. Hosted services and separately distributed products may have additional terms documented with those services or artifacts.