AgentKit Studio
Reference

Reference

Source-generated contract reference: 139 operations, 198 error codes, 132 environment names, 56 make targets.

What this chapter is

This chapter is the machine-readable contract of AgentKit Studio: enums, field names, error codes, operation ids, environment names and commands. Every number here is extracted from source by docs-site/scripts/extract-reference.mjs; none of it is typed by hand.

cd docs-site
node scripts/extract-reference.mjs          # regenerate all 22 pages
node scripts/extract-reference.mjs --check  # CI: fails when source moved but pages did not

After changing an enum, error code or operation list under src/, rerun the script; otherwise --check fails CI.

Page index

PageWhat you will findCountSource
Runtime and entity contractCapability matrix, entity identifiers and validation codes of the 3 runtimes3 runtime typessrc/runtime-contract.mjs
Control protocolPurpose and Host handler of every operation id139 operations · 25 domainssrc/contracts/operations.mjs
ConfigurationEvery key and default in the four configuration files4 manifestssrc/product.json
Environment variablesConfigurable, platform-injected and do-not-set tiers132 namessrc/**
Template schemaField constraints and rejected shapes of a team template7 codessrc/team-template-contract.mjs
Plugin catalog schemaCatalog document shape, merge rules and builtin rows18 fields · 3 rowssrc/dsh-plugin-catalog.mjs
Deployment state machineStates, UI labels, polling and attention19 statessrc/client/state/deployment.mjs
Error codesTop 30 actions plus a namespace index198 codessrc/**
Commandsmake targets, prerequisites and check scripts56 make · 100 verifyMakefile
Session eventsWhen events fire, how they pair, what persists16 events · 3 framessrc/host/dsh-session-contract.mjs

Read by role

You areStart withWhy
Integratorsoperations · errorsCall control operations by id and branch on error codes.
Plugin authorsplugin-catalog · templatesWrite a market row or a team template.
Operatorsenvironment · deployment-states · commandsSet environment variables, read deployment state, run gates.
Triageerrors · session-eventsLocate by error code, then reproduce from the event stream.

Extraction rules

RuleBehaviour
Contract constantsImported from the source module, never copied as literals
Error codescode: '...' literals under src/** plus STUDIO_WIRE_ERRORS
EnvironmentUnion of process.env.X, env.X and *_ENV_NAMES constant arrays
Source locationFirst occurrence as file:line, file relative to the repo root
RedactionCommit SHAs, release origins and internal model code names become placeholders

Developer entry points

ItemSource
Generatordocs-site/scripts/extract-reference.mjs
Operation contractsrc/contracts/operations.mjs
Wire errorssrc/contracts/definitions.mjs

Related tests:

Test fileLocation
desktop-module-graph.test.mjstests/desktop-module-graph.test.mjs
studio-wire-contracts.test.mjstests/studio-wire-contracts.test.mjs
host-dispatcher.test.mjstests/host-dispatcher.test.mjs
host-route-contracts.test.mjstests/host-route-contracts.test.mjs

On this page