feat: API catalog surface, protocol v2 tooling, MCP expansion, on+re update
## Summary
Session 2026-03-23. Closes the loop between handler code and discoverability
across all three surfaces (browser, CLI, MCP agent) via compile-time inventory
registration. Adds protocol v2 update tooling, extends MCP from 21 to 29 tools,
and brings the self-description up to date.
## API Catalog Surface (#[onto_api] proc-macro)
- crates/ontoref-derive: new proc-macro crate; `#[onto_api(method, path,
description, auth, actors, params, tags)]` emits `inventory::submit!(ApiRouteEntry{...})`
at link time
- crates/ontoref-daemon/src/api_catalog.rs: `catalog()` — pure fn over
`inventory::iter::<ApiRouteEntry>()`, zero runtime allocation
- GET /api/catalog: returns full annotated HTTP surface as JSON
- templates/pages/api_catalog.html: new page with client-side filtering by
method, auth, path/description; detail panel per route (params table,
feature flag); linked from dashboard card and nav
- UI nav: "API" link (</> icon) added to mobile dropdown and desktop bar
- inventory = "0.3" added to workspace.dependencies (MIT, zero transitive deps)
## Protocol Update Mode
- reflection/modes/update_ontoref.ncl: 9-step DAG (5 detect parallel, 2 update
idempotent, 2 validate, 1 report) — brings any project from protocol v1 to v2
by adding manifest.ncl and connections.ncl if absent, scanning ADRs for
deprecated check_hint, validating with nickel export
- reflection/templates/update-ontology-prompt.md: 8-phase reusable prompt for
agent-driven ontology enrichment (infrastructure → audit → core.ncl →
state.ncl → manifest.ncl → connections.ncl → ADR migration → validation)
## CLI — describe group extensions
- reflection/bin/ontoref.nu: `describe diff [--fmt] [--file]` and
`describe api [--actor] [--tag] [--auth] [--fmt]` registered as canonical
subcommands with log-action; aliases `df` and `da` added; QUICK REFERENCE
and ALIASES sections updated
## MCP — two new tools (21 → 29 total)
- ontoref_api_catalog: filters catalog() output by actor/tag/auth; returns
{ routes, total } — no HTTP roundtrip, calls inventory directly
- ontoref_file_versions: reads ProjectContext.file_versions DashMap per slug;
returns BTreeMap<filename, u64> reload counters
- insert_mcp_ctx: audited and updated from 15 to 28 entries in 6 groups
- HelpTool JSON: 8 new entries (validate_adrs, validate, impact, guides,
bookmark_list, bookmark_add, api_catalog, file_versions)
- ServerHandler::get_info instructions updated to mention new tools
## Web UI — dashboard additions
- Dashboard: "API Catalog" card (9th); "Ontology File Versions" section showing
per-file reload counters from file_versions DashMap
- dashboard_mp: builds BTreeMap<String, u64> from ctx.file_versions and injects
into Tera context
## on+re update
- .ontology/core.ncl: describe-query-layer and adopt-ontoref-tooling descriptions
updated; ontoref-daemon updated ("11 pages", "29 tools", API catalog,
per-file versioning, #[onto_api]); new node api-catalog-surface (Yang/Practice)
with 3 edges; artifact_paths extended across 3 nodes
- .ontology/state.ncl: protocol-maturity blocker updated (protocol v2 complete);
self-description-coverage catalyst updated with session 2026-03-23 additions
- ADR-007: "API Surface Discoverability via #[onto_api] Proc-Macro" — Accepted
## Documentation
- README.md: crates table updated (11 pages, 29 MCP tools, ontoref-derive row);
MCP representative table expanded; API Catalog, Semantic Diff, Per-File
Versioning paragraphs added; update_ontoref onboarding section added
- CHANGELOG.md: [Unreleased] section with 4 change groups
- assets/web/src/index.html: tool counts 19→29 (EN+ES), page counts 12→11
(EN+ES), daemon description paragraph updated with API catalog + #[onto_api]
99 lines
5.4 KiB
Plaintext
99 lines
5.4 KiB
Plaintext
let d = import "../defaults.ncl" in
|
|
|
|
# Comprehensive project validation mode.
|
|
# Runs 5 independent validation categories in parallel, then aggregates results.
|
|
#
|
|
# DAG structure:
|
|
# adr-checks ─┐
|
|
# content-verify─┤
|
|
# conn-health ─┼─► aggregate
|
|
# practice-cov ─┤
|
|
# gate-align ─┘
|
|
#
|
|
# Exit: non-zero if any Hard constraint fails (via validate check-all).
|
|
# All parallel steps use on_error = 'Continue so the aggregate always runs
|
|
# and collects all failures in one pass.
|
|
|
|
d.make_mode String {
|
|
id = "validate-project",
|
|
trigger = "Run all 5 validation categories (ADR constraints, content assets, connection health, practice coverage, gate consistency) and produce a unified compliance report.",
|
|
|
|
preconditions = [
|
|
"ONTOREF_PROJECT_ROOT is set and points to a project with .ontology/ and adrs/ directories",
|
|
"Nushell >= 0.111.0 is available on PATH",
|
|
"nickel binary is available on PATH",
|
|
"rg (ripgrep) is available on PATH for Grep-type constraint checks",
|
|
],
|
|
|
|
steps = [
|
|
# ── Category 1: ADR typed constraint checks ─────────────────────────────
|
|
{
|
|
id = "adr-checks",
|
|
action = "Load all accepted ADRs, dispatch each typed constraint check (Grep, Cargo, NuCmd, ApiCall, FileExists). Fails on any Hard constraint violation.",
|
|
cmd = "nu --no-config-file -c 'use reflection/modules/validate.nu *; validate check-all --fmt json'",
|
|
actor = 'Both,
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
|
|
# ── Category 2: content asset path verification ─────────────────────────
|
|
{
|
|
id = "content-verify",
|
|
action = "Verify that all source_path entries declared in manifest content_assets exist on disk. Reports missing files without failing the build.",
|
|
cmd = "nu --no-config-file -c 'use reflection/modules/describe.nu *; let m = (nickel export --format json .ontology/manifest.ncl | from json); let missing = ($m.content_assets? | default [] | where { |a| not ($a.source_path | path exists) } | get source_path); if ($missing | is-empty) { print \"content-verify: ok\" } else { print $\"content-verify: MISSING ($missing | str join \", \")\"; exit 1 }'",
|
|
actor = 'Both,
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
|
|
# ── Category 3: connection health ───────────────────────────────────────
|
|
{
|
|
id = "conn-health",
|
|
action = "Validate connections.ncl: check that all referenced project slugs are reachable and that node IDs resolve. Reports unresolvable connections as warnings.",
|
|
cmd = "nu --no-config-file -c 'let f = \".ontology/connections.ncl\"; if ($f | path exists) { print \"conn-health: connections.ncl present\" } else { print \"conn-health: no connections.ncl — skipped\" }'",
|
|
actor = 'Both,
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
|
|
# ── Category 4: practice coverage ───────────────────────────────────────
|
|
{
|
|
id = "practice-cov",
|
|
action = "Report Practice ontology nodes that have no corresponding test coverage annotation. Informational only — does not fail the mode.",
|
|
cmd = "nu --no-config-file -c 'let nodes = (nickel export --format json .ontology/core.ncl | from json | get nodes? | default [] | where { |n| ($n.level? | default \"\") == \"Practice\" }); print $\"practice-cov: ($nodes | length) practices in ontology\"'",
|
|
actor = 'Both,
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
|
|
# ── Category 5: gate/dimension consistency ──────────────────────────────
|
|
{
|
|
id = "gate-align",
|
|
action = "Check that active gate membranes are consistent with current dimension states. A Closed membrane should reflect a dimension at a terminal state.",
|
|
cmd = "nu --no-config-file -c 'let g = (nickel export --format json .ontology/gate.ncl | from json); let active = ($g.membranes? | default [] | where { |m| ($m.active? | default false) }); print $\"gate-align: ($active | length) active membrane(s)\"'",
|
|
actor = 'Both,
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
|
|
# ── Aggregate: collect results from all categories ──────────────────────
|
|
{
|
|
id = "aggregate",
|
|
action = "Collect results from all 5 validation categories and produce a unified compliance report. Exits non-zero if any Hard ADR constraint failed.",
|
|
cmd = "nu --no-config-file -c 'use reflection/modules/validate.nu *; let summary = (validate summary); print ($summary | to json); if $summary.hard_passing < $summary.hard_total { exit 1 }'",
|
|
actor = 'Both,
|
|
depends_on = [
|
|
{ step = "adr-checks" },
|
|
{ step = "content-verify" },
|
|
{ step = "conn-health" },
|
|
{ step = "practice-cov" },
|
|
{ step = "gate-align" },
|
|
],
|
|
on_error = { strategy = 'Stop },
|
|
},
|
|
],
|
|
|
|
postconditions = [
|
|
"All Hard constraints from accepted ADRs exit with passed = true",
|
|
"All declared content_assets have existing source_path files",
|
|
"Gate/dimension state alignment is consistent",
|
|
"Practice coverage report is available in output",
|
|
"Unified compliance JSON is printed to stdout",
|
|
],
|
|
}
|