Data Structure Protocol (DSP)
DSP builds a dependency graph of project entities in a .dsp/ directory. Each entity (module, function, external dependency) gets a UID, description, import list, and export index. The graph answers: what exists, why it exists, what depends on what, and who uses what.
DSP is NOT documentation for humans or AST dump. It captures meaning (purpose), boundaries (imports/exports), and reasons for connections (why).
Agent Prompt
Embed this context when working on a DSP-tracked project:
This project uses DSP (Data Structure Protocol). The
.dsp/directory is the entity graph of this project: modules, functions, dependencies, public API. It is your long-term memory of the code structure.Core rules:
- Before changing code — find affected entities via
dsp-cli search,find-by-source, orread-toc. Read theirdescriptionandimportsto understand context.- When creating a file/module — call
dsp-cli create-object. For each exported function —create-function(with--owner). Register exports viacreate-shared.- When adding an import — call
dsp-cli add-importwith a briefwhy. For external dependencies — firstcreate-object --kind externalif the entity doesn't exist yet.- When removing import / export / file — call
remove-import,remove-shared,remove-entityrespectively. Cascade cleanup is automatic.- When renaming/moving a file — call
move-entity. UID does not change.- Don't touch DSP if only internal implementation changed without affecting purpose or dependencies.
- Bootstrap — if
.dsp/is empty, traverse the project from root entrypoint via DFS on imports, documenting every file.Key commands:
dsp-cli init dsp-cli create-object <source> <purpose> [--kind external] [--toc ROOT_UID] dsp-cli create-function <source> <purpose> [--owner UID] [--toc ROOT_UID] dsp-cli create-shared <exporter_uid> <shared_uid> [<shared_uid> ...] dsp-cli add-import <importer_uid> <imported_uid> <why> [--exporter UID] dsp-cli remove-import <importer_uid> <imported_uid> [--exporter UID] dsp-cli remove-shared <exporter_uid> <shared_uid> dsp-cli remove-entity <uid> dsp-cli move-entity <uid> <new_source> dsp-cli update-description <uid> [--source S] [--purpose P] [--kind K] dsp-cli get-entity <uid> dsp-cli get-children <uid> [--depth N] dsp-cli get-parents <uid> [--depth N] dsp-cli search <query> dsp-cli find-by-source <path> dsp-cli read-toc [--toc ROOT_UID] dsp-cli get-stats
Using the CLI
The script is at scripts/dsp-cli.py relative to this skill directory.
python <skill-path>/scripts/dsp-cli.py [--root <project-root>] <command> [args]
--root defaults to current working directory. All paths in arguments are repo-relative.
Core Concepts
- Code = graph. Nodes are Objects and Functions. Edges are
importsandshared/exports. - Identity by UID, not file path. Path is an attribute; renames/moves don't change UID.
- "Shared" creates an entity. If something becomes public (exported), it gets its own UID.
- Import tracks both "from where" and "what". One code import may create two DSP links: to the module and to the specific shared entity.
- Full import coverage. Every imported file/asset must be an Object in
.dsp— code, images, styles, configs, everything. whylives next to the imported entity in itsexports/directory (reverse index).- Start from roots. Each root entrypoint has its own TOC file.
- External deps — record only.
kind: external, no deep dive intonode_modules/site-packages/etc. Butexports indexworks — shows who imports it.
UID Format
- Objects:
obj-<8 hex>(e.g.,obj-a1b2c3d4) - Functions:
func-<8 hex>(e.g.,func-7f3a9c12)
UID marker in source code — comment @dsp <uid> before declaration:
// @dsp func-7f3a9c12
export function calculateTotal(items) { ... }
# @dsp obj-e5f6g7h8
class UserService:
Workflows
Setting Up DSP
- Run
dsp-cli initto create.dsp/directory. - Identify root entrypoint(s) —
package.jsonmain, framework entry, etc. - Run bootstrap (DFS from root). See bootstrap.md.
Creating Entities (when writing new code)
- Create module:
dsp-cli create-object <path> <purpose> - Create functions:
dsp-cli create-function <path>#<symbol> <purpose> --owner <module-uid> - Register exports:
dsp-cli create-shared <module-uid> <func-uid> [<func-uid> ...] - Register imports:
dsp-cli add-import <this-uid> <imported-uid> <why> [--exporter <module-uid>] - External deps:
dsp-cli create-object <package-name> <purpose> --kind external
Navigating the Graph (when reading/understanding code)
- Find entity by file:
dsp-cli find-by-source <path> - Search by keyword:
dsp-cli search <query> - Read TOC:
dsp-cli read-toc→ get all UIDs, thenget-entityfor details - Dependency tree down:
dsp-cli get-children <uid> --depth N - Dependency tree up:
dsp-cli get-parents <uid> --depth N - Impact analysis:
dsp-cli get-recipients <uid>— who depends on this entity - Path between entities:
dsp-cli get-path <from> <to>
Updating (when modifying code)
- Purpose changed:
dsp-cli update-description <uid> --purpose <new> - File moved:
dsp-cli move-entity <uid> <new-path> - Import reason changed:
dsp-cli update-import-why <importer> <imported> <new-why>
Deleting (when removing code)
- Import removed:
dsp-cli remove-import <importer> <imported> [--exporter UID] - Export removed:
dsp-cli remove-shared <exporter> <shared> - File/module deleted:
dsp-cli remove-entity <uid>(cascading cleanup)
Diagnostics
dsp-cli detect-cycles— circular dependenciesdsp-cli get-orphans— unused entitiesdsp-cli get-stats— project graph overview
When to Update DSP
| Code Change | DSP Action |
|---|---|
| New file/module | create-object + create-function + create-shared + add-import |
| New import added | add-import (+ create-object --kind external if new external dep) |
| Import removed | remove-import |
| Export added | create-shared (+ create-function if new function) |
| Export removed | remove-shared |
| File renamed/moved | move-entity |
| File deleted | remove-entity |
| Purpose changed | update-description |
| Internal-only change | No DSP update needed |
References
- Storage format —
.dsp/directory structure, file formats, TOC - Bootstrap procedure — initial project markup (DFS algorithm)
- Operations reference — detailed semantics of all operations with import examples