thefactory-tools
v0.1.6
Published
Tools runtime and utilities for TheFactory agents, including standardized tool interfaces, schema generation, code analysis via Tree-sitter, and supporting utilities.
Maintainers
Readme
Multi-Agent Development Workflow
This repository implements a multi-agent development workflow with tools for reading/writing files, managing stories and features, running tests, and exposing these as chat-callable tools.
- Source code lives under src/
- Stories and artifacts live under .stories/
- Documentation lives under docs/
See docs/FILE_ORGANISATION.md for a complete overview of the project structure and tool composition. For architecture and coding practices, see docs/CODE_STANDARD.md.
Getting Started
- Install dependencies:
npm install - Build:
npm run build - Test:
npm test
Testing
High-quality, comprehensive tests are vital to this project. Aim for close to 100% coverage where practical. Tests should validate inputs/outputs, cover edge cases, and never force meaningless code changes just to pass.
- See docs/TESTING.md for full testing guidance, patterns, and standards.
- Refer to docs/CODE_STANDARD.md for coding standards that extend to test code as well.
Contributing
- Review docs/CODE_STANDARD.md before contributing; keep your changes consistent with the established architecture and standards.
- Follow the established patterns for adding new toolsets (create a factory under src/tools, export functions, and compose them in src/tools/tools.ts).
- If exposing a tool to chat, add a descriptor to src/tools/chatTools.ts and update the dispatcher. Ensure data entering/leaving endpoints is validated and add tests accordingly.
License
MIT (or project-specific license)
