DESIGN.md@docsA
DESIGN.md@docs from openbkn-ai/bkn-sdk is a DESIGN.md file: the design rules coding agents follow in that repo.
mdr add openbkn-ai/bkn-sdk/docs/DESIGN.md@git:20260701.c863b0ePins git:20260701.c863b0e in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 14 of 14 checks passed
- Kind
- DESIGN.md file
- Repository
- openbkn-ai/bkn-sdk
- Path
docs/DESIGN.md- Versions recorded
- 2
- Latest version
- git:20260701.c863b0e, committed Jul 1, 2026
- First version recorded
- Jun 3, 2026
- Size
- 1,263 bytes
- Repository stars
- 26
- License
- Apache-2.0
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Design
`@openbkn/bkn-sdk` optimizes for **one coherent surface** over the BKN platform: the same domain logic backs both the `openbkn` CLI and the importable SDK, so a behavior is implemented once and exposed twice.
What we optimize for:
- **Unification** — one package, one CLI, one auth/config model. No split between "user SDK" and "admin CLI".
- **Thin edges, typed core** — argv and HTTP responses are validated at the boundary (`zod`); the middle is plain typed functions.
- **Predictable defaults** — list `limit` 30, query `limit` 50, `--json` everywhere it makes sense; overridable, never surprising.
- **Slim over complete** — a deliberate rewrite of the legacy SDK + operator CLI, not a port. Drop dead surface; keep what users actually call. No TUI, minimal deps, smallest code that works.
- **Trivial to import** — `import { ... } from "@openbkn/bkn-sdk"` yields a typed client with no import-time side effects; the CLI is just a thin shell over the same functions.
- **Agent-readable** — clear names, indexed docs, stable command tree, so coding agents and humans navigate the same way.
…Read the whole file at its exact version.
How to install
mdr add openbkn-ai/bkn-sdk/docs/DESIGN.md@sha256:37e13d4a614d455fThe line at the top of this page pins the label git:20260701.c863b0e, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_ollz3ciwwcduan5r)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jun 3, 2026 and Jul 1, 2026, about one every 28 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260701.c863b0e latest | 2026-07-01 | c863b0e | 1,263 B | A | view · diff |
| git:20260603.a881b4d | 2026-06-03 | a881b4d | 1,265 B | A | view |
Audit of the latest version
- pass: Size between 200 bytes and 200 KB (1263 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
openbkn-ai/bkn-sdk · 26 stars · license Apache-2.0 · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ollz3ciwwcduan5r GET https://markdownregistry.com/api/v1/resolve?ref=openbkn-ai/bkn-sdk/docs/DESIGN.md GET https://markdownregistry.com/api/v1/blob/37e13d4a614d455fd0d3e56da8aaa792d8523c0ae88048f3a7595f907e388ef1
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: what DESIGN.md is and how agents use it · which agent file does what.
More from openbkn-ai/bkn-sdk
Every file in openbkn-ai/bkn-sdk