TypeScript SDK
Use @stacklok-oss/mecatl-sdk to create sessions, run agents, handle approvals,
follow durable activity, and call the rest of the Mecatl API from TypeScript.
The package supports Node.js, Bun, and browser applications.
Start with Use the TypeScript SDK to run one prompt against a private offline daemon.
Choose a workflow
- Connect an application to use an operator-owned daemon from Node.js, Bun, or a browser.
- Run a private local daemon when a Node.js or Bun process
should own
mecated, or when a script needs onequery()call. - Work with sessions and runs to stream events, receive a terminal result, send controls, or include media in a prompt.
- Handle permissions and plans to resolve asks in application code and continue an approved plan.
- Resume durable activity to follow one run or a session's cross-run timeline from an application-owned cursor.
- Register callback tools to expose local Node.js or Bun handlers to sessions created by a private daemon.
The SDK also exposes typed namespaces for models, agents, skills, teams, schedules, learning, MCP inventory, and storage operations. See the TypeScript SDK API reference for the complete public surface.
Package entry points
| Import | Use it for |
|---|---|
@stacklok-oss/mecatl-sdk | Browser HTTP and SSE connections, injected transports, and transport-neutral types. |
@stacklok-oss/mecatl-sdk/node | Node.js and Bun gRPC connections, local daemons, one-shot queries, filesystem media helpers, and callback tools. |
@stacklok-oss/mecatl-sdk/gen | Generated protobuf-es messages and service descriptors for low-level calls and typed namespace requests. |