Skip to main content

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mpt_extension_sdk-6.3.4.tar.gz (53.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mpt_extension_sdk-6.3.4-py3-none-any.whl (92.3 kB view details)

Uploaded Python 3

File details

Details for the file mpt_extension_sdk-6.3.4.tar.gz.

File metadata

  • Download URL: mpt_extension_sdk-6.3.4.tar.gz
  • Upload date:
  • Size: 53.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.22

File hashes

Hashes for mpt_extension_sdk-6.3.4.tar.gz
Algorithm Hash digest
SHA256 6c211faed22ac10162f512a3b414146f667c7695c0ca8e97b3a056c735526e2f
MD5 eb6a5cd824b00a2553f116bd81b3f5d0
BLAKE2b-256 b1efba815ca9748911dc73df59737e61ef7a01ca1bf41c7f7af7180b7b7cdf02

See more details on using hashes here.

File details

Details for the file mpt_extension_sdk-6.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mpt_extension_sdk-6.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f1d3aa23e750bc13f38541cde93fb10891af68180cbb508ffc8c4e041eca9f65
MD5 f1e2ae74125fc38859e0f725b176ecce
BLAKE2b-256 63e0d17850c693e1524810190f130b2168661cace460dcb77eb55904e1849b77

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page