Imported from voxgig-sdk/intercom-sdk (
js/src/feature/debug/AGENTS.md). Install upstream withnpx skills add voxgig-sdk/intercom-sdk --skill debug. Copyright stays with the author.
DebugFeature — Agent Guide
Request/response capture ring buffer for debugging (v0.0.1).
A feature is a pipeline extension: an object of hooks that fire at named
stages of every entity operation (load, list, create, update, remove) and of
the SDK/entity lifecycle. Features are how you inspect or modify the request
pipeline without forking the SDK. This directory holds the generated
runtime for the debug feature in the JavaScript target — do
not edit it by hand; change its template/model in .sdk/ and regenerate.
Active by default: no (config.options.active
in the model). It only runs when explicitly enabled (e.g. the test feature is switched on for test mode).
Hooks it fires
PreDonePreRequestPreResponsePreUnexpected
Each active hook runs at its pipeline stage in feature-registration order, so a later feature can override an earlier one.
Where it is defined
| Part | Path |
|---|---|
| Model definition | .sdk/model/feature/debug.aon (name, title, version, config.options.active, the hook map, per-language deps) |
| Registered in | .sdk/model/feature/feature-index.aon (@"debug.aon") |
| Runtime template | .sdk/tm/js/src/feature/debug/ (copied here on generate; FEATURE_Name/FEATURE_VERSION substituted) |
(Paths are relative to the project root — four levels up from here.)
Customising this feature
- Turn hooks on/off: edit the
hookmap in.sdk/model/feature/debug.aon(<Stage>: active: true|false). - Change default activation: set
config.options.activein the same file. - Dependencies: edit
deps.<lang>in the same file. - Behaviour: edit the runtime template under
.sdk/tm/js/src/feature/debug/, then regenerate.
After any change: cd ../../../../.sdk && npm run generate (add
npm run build first if you changed a component). If a regenerated file
shows a literal FEATURE_Name/ProjectName, delete it and regenerate.
To author a new feature, copy this one's model + template shape — see the project guide and the JavaScript guide.