Skip to content

@aster/platform-sdk

Canonical package README synced from packages/platform-sdk/README.md.

Canonical source: packages/platform-sdk/README.md · Edit the source file

Deliberate platform SDK surface for authors building spaces, provider packages, Roles, Processors, and protocol-bound capability integrations.

Install

Terminal window
npm install @aster/platform-sdk

Usage

import {
Plugin,
Processor,
Protocols,
Service,
Space,
tool,
} from "@aster/platform-sdk"
export const summarize = tool({
name: "summarize",
description: "Summarize the active context.",
input: {},
async run() {
return "Done"
},
})
export default Space.make({
slug: "writing",
name: "Writing",
requires: [Protocols.memoryProtocol.require()],
})

Surface

@aster/platform-sdk is the platform authoring entrypoint. It exposes:

  • @aster/authoring for Plugin.make, Service.make, provider helpers, scaffolding-adjacent types, and the tool factory exposed there.
  • A curated space declaration surface for Space.make, the space DSL, requirement helpers, and space module types.
  • @aster/services/protocols for the protocol registry, Protocol.make, protocol references, conformance helpers, and generated protocol modules.
  • @aster/processor for Processor.make v2, the context/tool/event/session- lease/settlement ports, and the conformance-certified template harness.

The client SDK is separate: @aster/sdk owns gateway clients, runtime sockets, AsterClient, and AsterApp. It does not re-export platform authoring factories.