Create Monitor
create_monitorCreate a Monitor in a project, initially disabled. An enabled Monitor runs on its schedule, unattended. Its Cycles burn Fuel unless the account has a plan that includes monitoring, which covers them up to its limits. Enable it with enable_monitor at the "Read+Write+Execute" access level; below that level the tool is absent, and the user enables it in the Dashboard at the link the returned summary carries. Read the 'monitoring' topic before choosing a frequency or thresholds.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectId": "<projectId>",
"name": "<name>",
"scriptId": "<scriptId>",
"frequency": "<frequency>",
"engineIds": "<engineIds>"
},
"name": "create_monitor"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The monitor name. | |
| tags | No | Tag names; a name the team doesn't have yet becomes a new tag. Omit for no tags. | |
| scriptId | Yes | The id of the Script in this project the Monitor plays each Cycle. | |
| engineIds | Yes | The ids of the monitoring locations the Cycles run from, as list_monitoring_locations reports them; at least one is required. Monitoring locations are their own set, not the load test regions list_engines offers, and an unknown id is refused with an error naming the valid ones. | |
| frequency | Yes | How often a Cycle runs, in milliseconds: 60000 (one minute) to 86400000 (one day). | |
| projectId | Yes | ||
| thresholds | No | The acceptable-metric limits a Cycle is judged against, each optional within the object: responseTimeAverageMin/Max, responseTimeTotalMin/Max, cycleDurationMin/Max, timeToFirstByteMax, firstContentfulPaintMax, largestContentfulPaintMax, and totalBlockingTimeMax in milliseconds; cumulativeLayoutShiftMax as the unitless Web Vitals score; performanceScoreMin as the 0-100 floor. A limit left out of the object is not checked. | |
| failureThreshold | No | Consecutive failed Cycles before an Incident opens (1 to 128; default 1). | |
| recoveryThreshold | No | Consecutive passing Cycles before an open Incident closes (1 to 128; default 1). |