Work with an agent#

Use the docs bundled with the application's installed Marionette package. For framework changes, follow the repository's contributor guidance.

Find the installed contract#

Check the installed package name and version first: marionette is the v5 package; backbone.marionette is the legacy package. V5 core requires neither Backbone nor jQuery; Backbone Models and Collections integrate through optional adapters. For installed backbone.marionette 4.x, preserve v4 contracts unless upgrading; older releases need their own version-specific guidance. If both packages are installed, check which entrypoint the feature imports.

From the application directory, resolve the package the feature imports. For v5:

node -p "require.resolve('marionette/package.json')"

For the legacy package instead:

node -p "require.resolve('backbone.marionette/package.json')"

Read the selected package's version and use its matching documentation. The paths below apply only to v5 and are relative to the installed marionette package's docs/ directory. For rendering, observation or persistence changes, check the configured renderer or data provider. Choose one starting page or use an exact API lookup; follow additional references when the task needs their contract.

Shared API names such as View.extend, regions, triggers, modelEvents, and CollectionView remain valid in v5, but do not guarantee shared behavior: verify the v5 contract. For v4 upgrades, read the migration guide.

If installed docs are absent, obtain the exact release or known source revision. Current website docs may describe a different version.

Apply the contract#

Keep local interaction in its View when that fits the task. An asynchronous call alone does not require an Application. A View may save its own model when the configured data layer supplies that operation. @mnjs/data supplies observable Models and Collections; fetching and persistence require an API layer or another provider. It does not supply Model.save().

Use Application preparation for feature readiness and restart() to repeat it while retaining active UI. Apply the current result in onStart; construct retained shells once. Coordinate shared decisions and work that survives panel replacement at the lifetime that owns them. Read architecture when deciding that ownership.

Read method signatures, event payloads and cleanup for the APIs you change. Verify the affected interaction, including replacement, cancellation or teardown when relevant. A successful build does not establish those outcomes.

Local contract lookup#

Direct Markdown reading is supported. If using the installed skill's helper, choose one lookup from the application directory:

node <skill>/scripts/docs.mjs --section docs/api/view.md#local-interaction-and-feature-coordination

Replace <skill> with the installed or copied skill directory. A section link reads that contract directly. You can also select a named section with --page docs/api/shared/view-bindings.md --section 'UI bindings'. Use --symbol Export.member for signatures and primary section IDs in primarySections, --search 'query' when the location is unknown, or --page SOURCE for a full page. --list lists pages; it is optional. An external package store needs --package-root <physical-directory>.

A symbol result lists primary contract section IDs in primarySections and incidental code mentions in sections. Primary routes can span several sections. An empty primary list means no member route has been assigned. contracts retains all applicable section IDs and diagnostic codes, including general guidance. Pass a section ID to --section to read it.

The helper checks the bundled manifest and hashes and reports the installed version and source revision. These identify the docs read; they do not verify the implementation.

For skill/plugin installation or hosted MCP identity checks, follow application tooling.