cleveragents/cleveragents-core
4
0
Fork 3
Code Issues 6.0k Pull Requests 115 Actions Packages Projects Releases Wiki Activity

docs(spec): align checkpoint trigger names and config key path with implementation

Browse Source 
Fixes two spec-implementation discrepancies identified in issue #5009:

1. Checkpoint trigger names: rename on_tool_write → before_tool_execute and
   on_tool_write_complete → after_tool_execute to match the implementation in
   src/cleveragents/tool/runner.py and src/cleveragents/application/services/
   config_service.py. The implementation names are more precise — they describe
   the execution phase rather than implying only write tools trigger them
   (though the implementation correctly gates them on write tools).

2. Config key path: correct the Configuration Reference table entry from
   sandbox.checkpoint.auto-create-on to core.checkpoints.auto-create-on,
   matching both the implementation (config_service.py line 482) and the
   inline spec at line 19449. Also update the default values in the table
   to use the corrected trigger names.

Closes #5009
This commit is contained in:
HAL 9000
2026-04-09 02:56:50 +00:00
committed by drew
parent 8a38c4a578
commit 4a68e02107
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/specification.md
+1 -1
View File
@@ -30887,7 +30887,7 @@ Keys are organized by their top-level group. Within each group, the full dot-pat
| `sandbox.checkpoint.enabled` | boolean | `true` | `CLEVERAGENTS_CHECKPOINT_ENABLED` | Whether checkpointing is enabled globally. When `true`, the Execute phase creates checkpoints before write operations, enabling rollback. When `false`, checkpointing is skipped (requires `require_checkpoints: false` in the automation profile). **Project-scopable.** |
| `sandbox.checkpoint.dir` | string | `<core.data-dir>/checkpoints` | `CLEVERAGENTS_CHECKPOINT_DIR` | Directory where plan execution checkpoints are stored. Each plan gets a subdirectory named by its ULID. |
| `sandbox.checkpoint.max-per-plan` | integer | `50` | `CLEVERAGENTS_CHECKPOINT_MAX` | Maximum number of checkpoints retained per plan. When exceeded, the oldest checkpoints are pruned (keeping the first and most recent). |
| `sandbox.checkpoint.auto-create-on` | list | `["before_tool_execute", "after_tool_execute", "on_subplan_spawn", "on_error"]` | `CLEVERAGENTS_CHECKPOINT_AUTO_CREATE_ON` | List of automatic checkpoint triggers. `before_tool_execute` fires before each write-tool execution, `after_tool_execute` fires after, `on_subplan_spawn` fires before first subplan execution attempt, `on_error` fires when the Execute phase fails. Set to `[]` to disable all automatic checkpoints. |
| `core.checkpoints.auto-create-on` | list | `["before_tool_execute", "after_tool_execute", "on_subplan_spawn", "on_error"]` | `CLEVERAGENTS_CHECKPOINT_AUTO_CREATE_ON` | List of automatic checkpoint triggers. `before_tool_execute` fires before each write-tool execution, `after_tool_execute` fires after, `on_subplan_spawn` fires before first subplan execution attempt, `on_error` fires when the Execute phase fails. Set to `[]` to disable all automatic checkpoints. |
##### `audit.*` — Audit Logging