Skip to content

OddKit docs audit: 7 new tool docs, updated prompts, IMPL status, consistency fixes#34

Merged
klappy merged 1 commit into
mainfrom
oddkit-docs/audit-overhaul-v2
Feb 13, 2026
Merged

OddKit docs audit: 7 new tool docs, updated prompts, IMPL status, consistency fixes#34
klappy merged 1 commit into
mainfrom
oddkit-docs/audit-overhaul-v2

Conversation

@klappy
Copy link
Copy Markdown
Owner

@klappy klappy commented Feb 13, 2026

Summary

  • Creates 7 missing tool docs (search, get, catalog, validate, preflight, version, cleanup_storage) — each documented from live oddkit v0.14.0 observed behavior
  • Updates epistemic guide prompt to reflect full 12-tool surface in 4 clusters (discovery, epistemic core, implementation bookends, maintenance)
  • Marks IMPL-A (explain) and IMPL-B (mode headers) as superseded, IMPL-content-addressed-caching as implemented
  • Updates modes.md with E0005 epoch and values-first framing, fixes input schemas and response shapes in 4 existing tool docs to match live system

Replaces #33 (auto-closed when #32 merged).

Test plan

  • Review each new tool doc against Writing Canon checklist (blockquote, summary, descriptive headers)
  • Verify response shapes match oddkit v0.14.0 actual responses (invoke each tool and compare)
  • Check cross-references in all 17 files — no broken links to archived/removed docs
  • Verify epistemic guide Full Tool Surface section lists all 12 actions
  • Confirm IMPL-A and IMPL-B supersession notes accurately describe what replaced them
  • After merge, run oddkit_search for "oddkit tool" — should return all 11 tool docs

Made with Cursor


Note

Low Risk
Docs-only changes (schemas, response examples, and status annotations) with no runtime behavior changes; primary risk is mismatched or misleading documentation if the observed tool shapes drift.

Overview
Updates OddKit documentation to match the current oddkit v0.14.0 tool surface and observed responses: adds new operator docs for oddkit_search, oddkit_get, oddkit_catalog, oddkit_preflight, oddkit_validate, oddkit_version, and oddkit_cleanup_storage, and revises existing tool docs (oddkit_orient, oddkit_gate, oddkit_encode, oddkit_challenge) to use the input-based schemas and the observed {action,result} response envelopes.

Refreshes guidance docs by expanding the prompts/epistemic-guide to describe all 12 tools in four clusters, updating modes.md with Epoch E0005 and current action names, and marking legacy implementation docs as superseded (IMPL-A, IMPL-B) while marking content-addressed caching as implemented (including the rename from invalidate_cache to cleanup_storage).

Written by Cursor Bugbot for commit 36091d5. This will update automatically on new commits. Configure here.

…e drift fixes

Gap 1: Created tool docs for search, get, catalog, validate, preflight,
version, cleanup_storage - each with oddkit:// URIs, observed response
shapes from live v0.14.0, behavioral rules, and canon references.

Gap 2: Updated epistemic guide prompt to document all 12 tools in 4
clusters (discovery, epistemic core, implementation bookends, maintenance).

Gap 3: Added file path alongside odd:// URI in epistemic-instructions.md.

Gap 4: Marked IMPL-A (explain) and IMPL-B (mode headers) as superseded.
Marked IMPL-content-addressed-caching as implemented.

Gap 5: Updated modes.md with E0005 epoch, values-first axiom reference,
and current tool names replacing historical Librarian/Promotions refs.

Gap 6: Updated input schemas and response shapes in orient, challenge,
gate, encode docs to match live observed behavior from oddkit v0.14.0.

Co-authored-by: Cursor <cursoragent@cursor.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying klappy-dev-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 36091d5
Status:🚫  Build failed.

View logs

@klappy klappy merged commit 97feb71 into main Feb 13, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant