Skip to content

BuildRequest

A project’s files, sent to be validated or deployed into a namespace. The SDKs and the mt CLI build this from a project folder for you.

Kind: an object, used in requests.

FieldTypeRequiredDescription
isDeploybooleanyesTrue to deploy the definitions if the build succeeds; false only to validate them. Constraints: required (empty or whitespace-only strings are rejected).
agentsBuildRequestItem[]yesAgent files (agents/). Constraints: required (empty or whitespace-only strings are rejected).
capsulesBuildRequestItem[]yesCapsule files (capsules/). Constraints: required (empty or whitespace-only strings are rejected).
connectorsBuildOpenApiAndMcpRequestyesConnector files (connectors/). Constraints: required (empty or whitespace-only strings are rejected).
externalOperationsBuildOpenApiAndMcpRequestyesTool files (external-operations/). Constraints: required (empty or whitespace-only strings are rejected).
interactionsBuildInteractionsRequestyesInteraction files (interactions/). Constraints: required (empty or whitespace-only strings are rejected).
appsBuildRequestApp[]yesApps (apps/), one entry per app folder. Constraints: required (empty or whitespace-only strings are rejected).
codePipelinesBuildRequestCodePipeline[]yesCode pipeline definitions (code-pipelines/), sent as JSON. Constraints: required (empty or whitespace-only strings are rejected).
codePipelineHooksmap<string,BuildRequestApp> | nullOptional Cogniscript hooks for code pipelines (code-pipeline-hooks/), keyed by the pipeline’s name.
loomsBuildRequestItem[] | nullOptional named looms (looms/<name>.mtr).
resourceFilesResourceFileReferencesyesThe shared prompts and JSON files the other files read with @prompt and @json. Constraints: required (empty or whitespace-only strings are rejected).
{
"isDeploy": false,
"agents": [
{
"name": "...",
"filename": "...",
"lines": []
}
],
"capsules": [
{
"name": "...",
"filename": "...",
"lines": []
}
],
"connectors": {
"openApi": [
{}
],
"modelContextProtocol": [
{}
]
},
"externalOperations": {
"openApi": [
{}
],
"modelContextProtocol": [
{}
]
},
"interactions": {
"oneShot": [
{}
],
"roundRobin": [
{}
],
"managed": [
{}
]
},
"apps": [
{
"name": "...",
"metadata": {},
"code": []
}
],
"codePipelines": [
{
"name": "...",
"filename": "...",
"json": "..."
}
],
"codePipelineHooks": {
"key": {
"name": "...",
"metadata": {},
"code": []
}
},
"looms": [
{
"name": "...",
"filename": "...",
"lines": []
}
],
"resourceFiles": {
"prompts": [
{}
],
"json": [
{}
]
}
}