Implementation Notes — neokapi Framework
Implementation notes contain tactical details for the neokapi framework (Apache-2.0): SQL schemas, wire protocols, algorithm pseudocode, Go interface signatures, and other reference material. They exist alongside the Architecture Decisions, which describe the design choices; notes describe the implementation.
| Note | Parent AD | Content |
|---|---|---|
| Implementing Formats | AD-005 | Step-by-step guide for new format readers/writers |
| Skeleton Store | AD-005 | SkeletonStore binary format, streaming HTML support |
| Flow Steps Format | AD-006 | YAML step list, fan-out, script steps |
| Session-Scoped Tool Authoring | AD-006 | Guide for writing tools against BlockStore |
| Plugin Model | AD-007 | In-process registry contract for plugin binaries |
| Plugin Bridge Protocol | AD-007 | gRPC protocol, bridge descriptor |
| Kapi Project File | AD-008 | .kapi recipe schema and examples |
| TM Matching Algorithm | AD-009 | Tiered matching, TMX mapping |
| Terminology Data Model | AD-010 | Go structs, TermBase interface |
| MCP Tools Reference | AD-013 | Tool specs, input/output schemas |
| Tool & Data Model Rationale | AD-006 · AD-002 | Why stand-off overlays + annotations, a typed consumes/produces IO contract, a uniform unit iterator, and typed source/sink bindings |