Home / openbkn-ai / bkn-sdk · docs/DESIGN.md · GitHub

DESIGN.md@docs designA

DESIGN.md@docs is agent-read markdown (design) from openbkn-ai/bkn-sdk.

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns 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

Latest version
mdr add openbkn-ai/bkn-sdk/docs/DESIGN.md@git:20260701.c863b0e
Exact content
mdr add openbkn-ai/bkn-sdk/docs/DESIGN.md@sha256:37e13d4a614d455f

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_ollz3ciwwcduan5r.svg)](https://markdownregistry.com/a/art_ollz3ciwwcduan5r)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
git:20260701.c863b0e latest2026-07-01 c863b0e 1,263 BA view · diff
git:20260603.a881b4d2026-06-03 a881b4d 1,265 BA view

Audit of the latest version

A  14 of 14 checks passed. Deterministic, no model, same answer every run.
  • 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

GitHub

openbkn-ai/bkn-sdk · 17 stars · license Apache-2.0 · pushed 2026-09-23 · 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 agent 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.

More from openbkn-ai/bkn-sdk

AGENTS.md agents
openbkn-ai/bkn-sdk · AGENTS.md
git:20260921.39b42cd · audit A · 17 stars
create-bkn skill
openbkn-ai/bkn-sdk · skills/create-bkn/SKILL.md · Guides creation of BKN (Business Knowledge Network) definition files following v2.0.1 spec. Covers network…
git:20260918.d7f989a · audit A · 17 stars
k8s-network skill
openbkn-ai/bkn-sdk · skills/create-bkn/references/examples/k8s-network/SKILL.md
git:20260701.fda7ed8 · audit C · 17 stars
create-skill skill
openbkn-ai/bkn-sdk · skills/create-skill/SKILL.md · Guides authoring of an OpenBKN Skill package (SKILL.md + references) that declares which knowledge-network capabilities…
git:20260918.d7f989a · audit A · 17 stars
demand-deliverability-assessment skill
openbkn-ai/bkn-sdk · skills/create-skill/references/examples/demand-deliverability-assessment/SKILL.md · Use when a user asks whether a product demand (an existing forecast or a new order) can be delivered on knowledge…
git:20260912.e67922d · audit A · 17 stars
openbkn skill
openbkn-ai/bkn-sdk · skills/openbkn/SKILL.md · 操作 BKN(Business Knowledge Network)平台的统一 CLI `openbkn` —— 知识网络 构建/查询(Schema:对象/关系/行动类型、指标、概念组;实例与语义搜索;…
git:20260918.d7f989a · audit A · 17 stars

Every file in openbkn-ai/bkn-sdk

Other files named DESIGN.md@docs

DESIGN.md@docs design
geekjourneyx/md2wechat-skill · docs/DESIGN.md
git:20260319.1e4d509 · audit A · 3,669 stars
DESIGN.md@docs design
1ay1/agentty · docs/DESIGN.md
git:20260716.46a37fd · audit A · 603 stars
DESIGN.md@docs design
mvschwarz/openrig · docs/DESIGN.md
git:20260511.2c2e6ba · audit A · 362 stars
DESIGN.md@docs design
vintlin/skill-flow · docs/DESIGN.md · A compact macOS operations workspace built from layered neutral surfaces, user-selectable accents, reusable group…
beta · audit A · 261 stars
DESIGN.md@docs design
cassette-editor/oh-my-cassette · docs/DESIGN.md · A browser-based video editor with an AI co-editor, tuned like a colorist's grading suite.
git:20260725.e99cff3 · audit A · 153 stars
DESIGN.md@docs design
shellishack/infinite-pokemon · docs/DESIGN.md
git:20260914.2f240d9 · audit A · 136 stars
DESIGN.md@docs design
viy1204/recruiting-copilot · docs/DESIGN.md
git:20260827.5ea0afa · audit A · 77 stars
DESIGN.md@docs design
ghalebdweikat/winnow · docs/DESIGN.md
git:20260919.57b20c5 · audit A · 74 stars

Browse by kind, by grade A, or by owner.