# boardy-tools — project documentation

Scanned by phdoc 0.1.0 on 2026-11-22 (Exocortical Epoch 95). Project root: /home/wbic16/phdoc-sweep/proj/boardy-tools/. Scanned at commit 7092bd1ac39561fc1a809e7c9f60d683ec863520. Every fact in this document was read from its own records: its manifests, its git log, and its source text. Nothing here was guessed.

This document holds: what the project depends on, who wrote it, how large and how complex it is, the state of its quality signals, the RFCs it declares, where its upstream repo lives, and a plain English note for every public method and command.

---

## Dependencies

No dependency manifest was found (no Cargo.toml, package.json, requirements.txt, or go.mod), so no dependencies are declared in a form the scanner reads.

---

## Authors

The git log holds 3 commits.

The author of record is **Will Bickford** — 3 commits folded into his account. Will's ruling (2026-11-22): all Exocortical authors fold into his account — "I speak for the cluster." The fold is presentation only: the git history is unchanged, and the per-persona detail is kept as annotation.

Annotation, by persona (all folded into Will Bickford):

- Will Bickford (his own identities) — 2 commits
- Emise — 1 commit

---

## Complexity

The measure is stated plainly, and no single score is made: lines are counted per file as total lines, blank lines, comment lines, and code lines (total minus blank minus comment). Functions are counted where the scanner reads them, and the largest functions are given by their span in lines.

- Markdown: 14 files, 1187 lines total, 294 blank, 10 comment, 883 code
- Python: 6 files, 1000 lines total, 143 blank, 46 comment, 811 code

All languages: 20 files, 2187 lines total, 1694 lines of code. Functions read: 44.

Largest files:

- 05-boot-manual.md — 338 lines
- receipts/boardy.py — 332 lines
- receipts/PLAYTEST.md — 288 lines
- receipts/benchmark.py — 224 lines
- receipts/boardy_mcp.py — 199 lines

Largest functions, by span in lines:

- main in receipts/benchmark.py — about 92 lines
- score_recovery in receipts/boardy.py — about 65 lines
- tool in receipts/test_client.py — about 63 lines
- boot in receipts/boardy.py — about 44 lines
- generate_candidates in receipts/boardy.py — about 41 lines

---

## Code quality signals

Each signal is named and shown with its evidence. A signal is a fact the scanner read, not a grade.

- Tests: 0 test functions counted in the source, across 2 files whose names mark them as test files.
- CI: no CI configuration was found in the project.
- Lint and format: no lint or format configuration file was found.
- TODO marks in the source: 0. FIXME marks: 0.
- Public items with a doc comment: 8 of 44 (18%).

---

## Declared RFCs

No rfcs.json was found in this project, so it declares no RFCs. This is a finding, not an error: the project has not made an RFC declaration.


---

## Upstream git repo

- Origin: /home/wbic16/github-archive/mirrors/boardy-tools.git
- Branch: exo
- Head commit: 7092bd1ac39561fc1a809e7c9f60d683ec863520
- Working tree: 1 changed paths

---

## Public methods and commands

Every public method and command the scanner found, each with a plain English note. A note says where its words came from: the code's own doc comment, the item's signature, the user's agent, or it is marked awaiting a summary.

- function `node_record` (receipts/benchmark.py:112) — Function node_record takes nid and gives back nothing; it does its work on what it is given.
- function `build_corpus` (receipts/benchmark.py:120) — Function build_corpus takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what
- function `main` (receipts/benchmark.py:133) — Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is g
- function `__init__` (receipts/boardy.py:55) — Function __init__ takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it 
- function `add_node` (receipts/boardy.py:60) — Function add_node takes self, nid, kind, attrs, coord=None and gives back nothing; it does its work on what it is given.
- function `add_edge` (receipts/boardy.py:63) — Function add_edge takes self, src, typ, dst, weight and gives back nothing; it does its work on what it is given.
- function `kind` (receipts/boardy.py:68) — Function kind takes self, nid and gives back nothing; it does its work on what it is given.
- function `edges_from` (receipts/boardy.py:72) — Function edges_from takes self, src, typ=None and gives back nothing; it does its work on what it is given.
- function `edges_to` (receipts/boardy.py:75) — Function edges_to takes self, dst, typ=None and gives back nothing; it does its work on what it is given.
- function `edge_set` (receipts/boardy.py:78) — Function edge_set takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it 
- function `parse_node_record` (receipts/boardy.py:92) — Function parse_node_record takes text and gives back nothing; it does its work on what it is given.
- function `boot` (receipts/boardy.py:114) — scrolls: {coord: text} merged from the problem+solution phexts.
- function `dense_counts` (receipts/boardy.py:158) — Function dense_counts takes g and gives back nothing; it does its work on what it is given.
- function `empty_family_edges` (receipts/boardy.py:166) — Every boot edge landing in an empty kind-pair family (manual step 7).
- function `forbidden_nodes` (receipts/boardy.py:176) — Function forbidden_nodes takes g and gives back nothing; it does its work on what it is given.
- function `score_recovery` (receipts/boardy.py:182) — gt_edges: list of (src, type, dst, weight) ground truth.
- function `find_route` (receipts/boardy.py:247) — Replayable route over stored edges only (traversed in either direction,
- function `invention_score` (receipts/boardy.py:275) — decisions: list of dicts with classification in {R, A, F}.
- function `generate_candidates` (receipts/boardy.py:292) — Function generate_candidates takes g and gives back nothing; it does its work on what it is given.
- function `fmt` (receipts/boardy_mcp.py:37) — Function fmt takes coord and gives back nothing; it does its work on what it is given.
- function `parse_phext` (receipts/boardy_mcp.py:41) — Explode phext text into {coordinate_tuple: scroll_text}.
- function `parse_coordinate` (receipts/boardy_mcp.py:64) — Function parse_coordinate takes text and gives back nothing; it does its work on what it is given.
- function `tool_load` (receipts/boardy_mcp.py:74) — Function tool_load takes args and gives back nothing; it does its work on what it is given.
- function `require_doc` (receipts/boardy_mcp.py:84) — Function require_doc takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what 
- function `tool_toc` (receipts/boardy_mcp.py:89) — Function tool_toc takes _args and gives back nothing; it does its work on what it is given.
- function `tool_fetch` (receipts/boardy_mcp.py:98) — Function tool_fetch takes args and gives back nothing; it does its work on what it is given.
- function `tool_search` (receipts/boardy_mcp.py:106) — Function tool_search takes args and gives back nothing; it does its work on what it is given.
- function `send` (receipts/boardy_mcp.py:140) — Function send takes msg and gives back nothing; it does its work on what it is given.
- function `result` (receipts/boardy_mcp.py:145) — Function result takes rid, value and gives back nothing; it does its work on what it is given.
- function `error` (receipts/boardy_mcp.py:149) — Function error takes rid, code, message and gives back nothing; it does its work on what it is given.
- function `handle` (receipts/boardy_mcp.py:153) — Function handle takes req and gives back nothing; it does its work on what it is given.
- function `main` (receipts/boardy_mcp.py:187) — Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is g
- function `fmt` (receipts/phext.py:15) — Function fmt takes coord and gives back nothing; it does its work on what it is given.
- function `serialize` (receipts/phext.py:19) — scrolls: dict {coord9 tuple: str} -> bytes, coordinates ascending.
- function `parse` (receipts/phext.py:39) — bytes -> dict {coord9 tuple: str} (every scroll, including empty ones).
- function `common_prefix` (receipts/phext.py:58) — Function common_prefix takes a, b and gives back nothing; it does its work on what it is given.
- function `log` (receipts/test_client.py:25) — Function log takes direction, obj and gives back nothing; it does its work on what it is given.
- function `check` (receipts/test_client.py:29) — Function check takes label, ok, detail="" and gives back nothing; it does its work on what it is given.
- function `main` (receipts/test_client.py:35) — Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is g
- function `call` (receipts/test_client.py:41) — Function call takes method, params=None and gives back nothing; it does its work on what it is given.
- function `notify` (receipts/test_client.py:53) — Function notify takes method and gives back nothing; it does its work on what it is given.
- function `tool` (receipts/test_client.py:59) — Function tool takes name, args and gives back nothing; it does its work on what it is given.
- function `fake_boot` (receipts/test_scorer.py:14) — Function fake_boot takes edges and gives back nothing; it does its work on what it is given.
- function `main` (receipts/test_scorer.py:22) — Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is g

---

## function — node_record

Found in receipts/benchmark.py at line 112.

Signature: `def node_record(nid):`

What it does: Function node_record takes nid and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — build_corpus

Found in receipts/benchmark.py at line 120.

Signature: `def build_corpus():`

What it does: Function build_corpus takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — main

Found in receipts/benchmark.py at line 133.

Signature: `def main():`

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — __init__

Found in receipts/boardy.py at line 55.

Signature: `def __init__(self):`

What it does: Function __init__ takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — add_node

Found in receipts/boardy.py at line 60.

Signature: `def add_node(self, nid, kind, attrs, coord=None):`

What it does: Function add_node takes self, nid, kind, attrs, coord=None and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — add_edge

Found in receipts/boardy.py at line 63.

Signature: `def add_edge(self, src, typ, dst, weight):`

What it does: Function add_edge takes self, src, typ, dst, weight and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — kind

Found in receipts/boardy.py at line 68.

Signature: `def kind(self, nid):`

What it does: Function kind takes self, nid and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — edges_from

Found in receipts/boardy.py at line 72.

Signature: `def edges_from(self, src, typ=None):`

What it does: Function edges_from takes self, src, typ=None and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — edges_to

Found in receipts/boardy.py at line 75.

Signature: `def edges_to(self, dst, typ=None):`

What it does: Function edges_to takes self, dst, typ=None and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — edge_set

Found in receipts/boardy.py at line 78.

Signature: `def edge_set(self):`

What it does: Function edge_set takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — parse_node_record

Found in receipts/boardy.py at line 92.

Signature: `def parse_node_record(text):`

What it does: Function parse_node_record takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — boot

Found in receipts/boardy.py at line 114.

Signature: `def boot(scrolls):`

What it does: scrolls: {coord: text} merged from the problem+solution phexts.

(Where these words came from: doc comment.)

---

## function — dense_counts

Found in receipts/boardy.py at line 158.

Signature: `def dense_counts(g):`

What it does: Function dense_counts takes g and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — empty_family_edges

Found in receipts/boardy.py at line 166.

Signature: `def empty_family_edges(g):`

What it does: Every boot edge landing in an empty kind-pair family (manual step 7).

(Where these words came from: doc comment.)

---

## function — forbidden_nodes

Found in receipts/boardy.py at line 176.

Signature: `def forbidden_nodes(g):`

What it does: Function forbidden_nodes takes g and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — score_recovery

Found in receipts/boardy.py at line 182.

Signature: `def score_recovery(boot_g, gt_edges):`

What it does: gt_edges: list of (src, type, dst, weight) ground truth.

(Where these words came from: doc comment.)

---

## function — find_route

Found in receipts/boardy.py at line 247.

Signature: `def find_route(g, src, dst):`

What it does: Replayable route over stored edges only (traversed in either direction,

(Where these words came from: doc comment.)

---

## function — invention_score

Found in receipts/boardy.py at line 275.

Signature: `def invention_score(decisions):`

What it does: decisions: list of dicts with classification in {R, A, F}.

(Where these words came from: doc comment.)

---

## function — generate_candidates

Found in receipts/boardy.py at line 292.

Signature: `def generate_candidates(g):`

What it does: Function generate_candidates takes g and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — fmt

Found in receipts/boardy_mcp.py at line 37.

Signature: `def fmt(coord):`

What it does: Function fmt takes coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — parse_phext

Found in receipts/boardy_mcp.py at line 41.

Signature: `def parse_phext(text):`

What it does: Explode phext text into {coordinate_tuple: scroll_text}.

(Where these words came from: doc comment.)

---

## function — parse_coordinate

Found in receipts/boardy_mcp.py at line 64.

Signature: `def parse_coordinate(text):`

What it does: Function parse_coordinate takes text and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — tool_load

Found in receipts/boardy_mcp.py at line 74.

Signature: `def tool_load(args):`

What it does: Function tool_load takes args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — require_doc

Found in receipts/boardy_mcp.py at line 84.

Signature: `def require_doc():`

What it does: Function require_doc takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — tool_toc

Found in receipts/boardy_mcp.py at line 89.

Signature: `def tool_toc(_args):`

What it does: Function tool_toc takes _args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — tool_fetch

Found in receipts/boardy_mcp.py at line 98.

Signature: `def tool_fetch(args):`

What it does: Function tool_fetch takes args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — tool_search

Found in receipts/boardy_mcp.py at line 106.

Signature: `def tool_search(args):`

What it does: Function tool_search takes args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — send

Found in receipts/boardy_mcp.py at line 140.

Signature: `def send(msg):`

What it does: Function send takes msg and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — result

Found in receipts/boardy_mcp.py at line 145.

Signature: `def result(rid, value):`

What it does: Function result takes rid, value and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — error

Found in receipts/boardy_mcp.py at line 149.

Signature: `def error(rid, code, message):`

What it does: Function error takes rid, code, message and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — handle

Found in receipts/boardy_mcp.py at line 153.

Signature: `def handle(req):`

What it does: Function handle takes req and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — main

Found in receipts/boardy_mcp.py at line 187.

Signature: `def main():`

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — fmt

Found in receipts/phext.py at line 15.

Signature: `def fmt(coord):`

What it does: Function fmt takes coord and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — serialize

Found in receipts/phext.py at line 19.

Signature: `def serialize(scrolls):`

What it does: scrolls: dict {coord9 tuple: str} -> bytes, coordinates ascending.

(Where these words came from: doc comment.)

---

## function — parse

Found in receipts/phext.py at line 39.

Signature: `def parse(data):`

What it does: bytes -> dict {coord9 tuple: str} (every scroll, including empty ones).

(Where these words came from: doc comment.)

---

## function — common_prefix

Found in receipts/phext.py at line 58.

Signature: `def common_prefix(a, b):`

What it does: Function common_prefix takes a, b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — log

Found in receipts/test_client.py at line 25.

Signature: `def log(direction, obj):`

What it does: Function log takes direction, obj and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — check

Found in receipts/test_client.py at line 29.

Signature: `def check(label, ok, detail=""):`

What it does: Function check takes label, ok, detail="" and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — main

Found in receipts/test_client.py at line 35.

Signature: `def main():`

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — call

Found in receipts/test_client.py at line 41.

Signature: `def call(method, params=None):`

What it does: Function call takes method, params=None and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — notify

Found in receipts/test_client.py at line 53.

Signature: `def notify(method):`

What it does: Function notify takes method and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — tool

Found in receipts/test_client.py at line 59.

Signature: `def tool(name, args):`

What it does: Function tool takes name, args and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — fake_boot

Found in receipts/test_scorer.py at line 14.

Signature: `def fake_boot(edges):`

What it does: Function fake_boot takes edges and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## function — main

Found in receipts/test_scorer.py at line 22.

Signature: `def main():`

What it does: Function main takes no inputs beyond the value it is called on, and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)

---

## Provenance

This documentation is produced for the export repo wbic16/phdoc (its chain of record lives at docs/boardy-tools/chain.phext) and for the doc site https://docs.phext.io. Both targets are the project's own configuration, held in its .phdoc.json as "export-repo" and "doc-site"; when a project does not name them, the defaults are wbic16/phdoc and https://docs.phext.io.
