Development¶
Local Setup¶
The package uses a src/ layout; the Typer entry point is
cspilot.cli:app.
Design Boundaries¶
- Deterministic tools perform file and executable work.
- Workflows compose existing deterministic tools.
- Agent tools wrap implemented functions and return JSON-serializable data.
- The planner emits JSON tool plans; the executor runs only registered tools.
- The verifier and reporter inspect returned data without using an LLM to create scientific values.
Adding Capabilities¶
When adding a tool or workflow:
- Keep external execution in deterministic Python code.
- Return explicit status, paths, and parsed values.
- Add agent exposure only when the deterministic implementation is stable.
- Add tests for failure states and result serialization.
- Update documentation according to Updating Documentation.
Documentation¶
Documentation dependencies are available through:
The user-facing pages in docs/ should describe only implemented commands and
mark roadmap work as planned.