Skip to content
Muse Code Developer Docs
Developer Preview

Reference

Use these pages to look something up by name: a method, a type, a manifest field, a command flag, a diagnostic code. The guides explain how the pieces fit; the reference enumerates them. Three of the four sets below are generated from the source and the schema bundle the host ships, so they describe exactly the version this site was built from; the plugin reference is written by hand and checked against the same release.

SDK reference

Section titled “SDK reference”

The public entry point of @muse-code/sdk, generated from its own source: the client and session classes, every options object, the error classes, the fold and item store, and the handler and transport interfaces.

If you are writing a client, start from MuseClient and Session in either set and follow the links out to the wire types they wrap.

Plugin reference

Section titled “Plugin reference”

Written for plugin authors and for anyone reading a validator report.

  • Manifest: every field of .muse-plugin/plugin.json, with types, defaults, limits and the identifier grammar.
  • Hook events and payloads: the events a hook can bind to, what each puts on stdin, the output schema, exit codes and size caps.
  • The muse plugins command: every verb, flag, output line and --json shape, plus the panel that covers the same actions.
  • Validation diagnostics: every code validate, install, list and inspect can print, and what to do about each.

Wire protocol reference

Section titled “Wire protocol reference”

The Muse Session Protocol as the host speaks it, one page per item, generated from the schema bundle so that names, fields and error codes are the ones a running host reports.

  • Methods: every request a client can send and the host can send back.
  • Notifications: every one-way message.
  • Errors: the typed error vocabulary.
  • Types: every shared structure the methods and notifications use.
  • Capabilities and Reserved identifiers: what the handshake negotiates and which ids are never yours to choose.

Not sure of the name yet?

Section titled “Not sure of the name yet?”

Start from the guide for what you are doing, and follow its links into the reference: