mpt-extension-sdk 6.3.3

Extensions SDK for SoftwareONE Marketplace Platform

SDK Usage

This guide is the entry point for building an extension package on top of mpt-extension-sdk. Topic-specific examples live in smaller documents under sdk_usage/.

Usage Topics

• Application setup: install the SDK, shape an extension package, create ExtensionApp, include routers, and configure the runtime.
• Event routes: register task and non-task event handlers.
• Authenticated API routes: expose authenticated endpoints, validate bodies, read request/auth context, return API responses, and use pagination.
• UI plugs: register PlugRouter providers and reference static assets.
• Contexts and pipelines: adapt execution contexts and compose processing pipelines.
• Marketplace services: use ctx.mpt_api_service from handlers and pipeline steps.

Runtime Commands

Use the mpt-ext CLI command when running an extension built on top of the SDK:

mpt-ext run --local
mpt-ext run
mpt-ext meta generate
mpt-ext meta validate

• mpt-ext run --local starts the local FastAPI + uvicorn runtime.
• mpt-ext run writes meta.yaml, registers the extension instance, and starts the platform runtime with mrok/ziticorn.
• mpt-ext meta generate writes metadata derived from ext_app.to_meta_config().
• mpt-ext meta validate compares the checked-in meta.yaml with generated metadata, validates plug static assets, and writes meta.generated.yaml when validation fails.