Mod Works toolkit and MCP

Myrlin Mod Works is the mod porting workflow that submits manifests to this API. This page says what exists for it today and what does not.

The modworks key preset

The modworks preset is the key made for the Mod Works integration. It holds 11 scopes, bound to one project of yours, with a default expiry of 30 days. An explicit expiresInDays overrides the default; the longest allowed is 365 days.

POST /api/keys
{
  "name": "mod job key",
  "preset": "modworks",
  "workspaceId": "<id of your project>"
}
  • It needs workspaceId, the id of an existing project you own. Without it the call is refused. Create the project first with PUT /projects/{slug}, using a session or another key.
  • Scopes: projects:read, projects:write, inputs:read, inputs:write, batches:read, batches:quote, batches:submit, batches:retry, batches:cancel, results:read, reviews:write. It holds no administrator scope.
  • The credit caps are 0 unless you set them, so the key can only run free batches until you raise them. See Limits on a key.
  • One key for one project: a bound key sees no other project of yours. Make a second key for a second mod.

What the toolkit is meant to do

The toolkit is designed to wrap the same flow shown in Examples: write a manifest, lint, quote, submit, wait, download, verify and review. It is a design, not a product you can install. Until it ships, use the routes directly or the standard library samples.

A manifest can carry a credit object with a releaseName and, only when it was measured, timeSavedMeasured. It is part of the manifest schema; see Manifest format.

MCP server

An MCP server would let an agent call the same operations as tools. It is coming and is not built, so there is no endpoint, package or tool list to document. An agent can use the HTTP routes today with a scoped key: read_only for status and submit_only or modworks for batches.