Muse Code SDK

# Muse Code SDK

TypeScript SDK and developer documentation for building clients that drive
[Muse Code](https://meta-models.github.io/muse-code-sdk) agent sessions over
the Muse Session Protocol (MSP).

**Read the docs:** <https://meta-models.github.io/muse-code-sdk>

## Install from npm

```sh
npm install @muse-code/sdk
```

Requires Node.js 20 or newer. The package has **zero runtime dependencies**
and ships its own TypeScript declarations. Start with the
[quickstart](https://meta-models.github.io/muse-code-sdk/guides/quickstart/).

The SDK is a **Developer Preview**: it is published pre-1.0 and carries no
stability promise yet — minor releases may change APIs while the surface
settles.

## What is in this repository

- **`main` — the source of `@muse-code/sdk`**, together with the protocol
  declarations, examples and fixtures it needs to build and test on its own.
- **`gh-pages` — the built Muse Code Developer Docs**: the wire-protocol
  reference, the SDK reference, and the guides and cookbook that go with them.

```
clients/sdk-ts/         @muse-code/sdk — the facade, its QA harness and test suite
clients/msp-ts/         @muse-code/msp — the generated MSP wire types
clients/sdk-quickstart/ the executable quickstart journey the docs render
clients/sdk-cookbook/   the executable cookbook recipes the docs render
schema/msp/             the committed protocol declarations, stable manifest and
                        recorded conformance transcripts the tests replay
```

### Build from source

Requires Node.js 20 or newer (CI uses 22). From the repository root:

```sh
npm install     # links the workspace packages; installs the pinned TypeScript
npm run build   # tsc --build
npm test        # builds, then runs the node:test suites
```

The suite passes in a standalone checkout except for the arms in
`clients/sdk-ts/test/muse-serve-child.test.ts` and
`clients/sdk-ts/test/spawn-handshake.test.ts`, which spawn a real `muse` host
binary that is not part of this repository. Those fail by design without one —
anything else is a genuine failure, so please report it.

To typecheck the committed protocol declarations on their own:

```sh
scripts/check-msp-ts-typecheck.sh
```

### License

Released under the **MIT License** — see [`LICENSE`](LICENSE).

### This source is mirrored, not developed here

`publish-anchor.json` names the exact upstream commit each copy cam