Reference
API specifications, apps, the CLI, setup, UI packages and Workers for the MDK stack
Overview
The Reference section holds the exact shapes MDK exposes: routes, messages, commands, configuration keys and component props. Reach for it when you already know the task and need one fact. Every page here uses the MDK vocabulary.
APIs
API overview
Both programmatic surfaces in one place: Gateway HTTP and the MDK Protocol
Gateway HTTP API
The HTTP reference and OpenAPI 3.1 document for the routes a Gateway serves
Protocol messages
The envelope schema, a worked request and response, and the actions the MDK Protocol carries
Apps
Command line
CLI reference
Every mdk command, its arguments, flags and defaults, grouped as mdk --help groups them
Glossary
Kernel
Setup
Environment requirements
The Node.js, npm, Git and network baseline every MDK guide assumes
Packages
Every package in the MDK monorepo, what each is for and how to get it
Stack file (mdk.yaml)
The minimal mdk.yaml the CLI loads, and which page teaches each block under spec
UI
Workers
Workers
Device protocol adapters that wrap vendor hardware APIs and expose them through the MDK Protocol
Supported Workers
The miner, container, power meter, sensor and mining pool Workers you can run today
Next steps
- Understand how the stack fits together: the narrative behind the surfaces this section specifies
- Run a demo site: see the Gateway, the Kernel and Workers serving data end to end