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, register startup hooks, and configure the runtime.
Event routes: register task and non-task event handlers.
Schedule routes: register periodic work, read the schedule delivery, and follow the delivery protocol the Extension Framework drives.
Authenticated API routes: expose authenticated endpoints, validate bodies, read request/auth context, return API responses, and use pagination.
UI plugs: register PlugRouter providers, group plugs under nested navigation containers, declare modal (open-by-id) plugs, and reference static assets.
Contexts and pipelines: adapt execution contexts, compose pipelines, drive the step lifecycle and flow control, use pipeline hooks, and declare status transitions.
Immutable snapshots: treat MPT models as immutable, update parameters with the with_* helpers, and refresh after a write.
Error handling: raise typed step/pipeline errors and let the SDK map them to event responses.
Settings: the runtime, extension, and account settings layers and the environment-variable helpers.
Observability: SDK tracing, the azure-monitor extra, and extension-defined spans with trace_span.
CLI and metadata: the mpt-ext commands and meta.yaml generation/validation.
Marketplace services: use ctx.mpt_api_service from handlers and pipeline steps.

Runtime Commands

An extension built on the SDK is run through the packaged mpt-ext CLI. The commands and their contract are documented in CLI and metadata.

Metadata

Release files for mpt-extension-sdk 6.7.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mpt-extension-sdk 6.7.2
File	Size	Uploaded
mpt_extension_sdk-6.7.2.tar.gz	66.4 kB	Sep 2, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for mpt-extension-sdk 6.7.2
File	Interpreter	ABI	Platform	Reset
mpt_extension_sdk-6.7.2-py3-none-any.whl 113.1 kB Sep 2, 2026	Python 3	none	any	Details

Total release size: 179.5 kB

Release files / mpt_extension_sdk-6.7.2.tar.gz

Download URL	mpt_extension_sdk-6.7.2.tar.gz
Size	66.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`aa3c577ac37cae98a3c04595d71393adf306de6c81bf0b1588385137e512c988`
BLAKE2b-256 checksum How to use checksums	`48aa978c3402bdc59cfec7f66990d3d8acd27bfcc301939910e389ce0ef6dc61`
Upload date	Sep 2, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.7.22`

Release files / mpt_extension_sdk-6.7.2-py3-none-any.whl

Download URL	mpt_extension_sdk-6.7.2-py3-none-any.whl
Size	113.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a3d58de7141e4741833a1cf726a7fc8aef8953369fffa9e2c990b080b30348d3`
BLAKE2b-256 checksum How to use checksums	`0b23f60d9a7cccae84ee5f1710a8fd70cb062c692a87aa91c9a97c75f4bf5aa9`
Upload date	Sep 2, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`uv/0.7.22`