Skip to main content
Glama

create_check

Create a check. kind is http, api, dns, tcp, heartbeat, or mcp. Call usage first: it gives min_interval_seconds, max_regions, and max_endpoints (how many active checks the plan allows). Up rules: kind http with expected_status_codes [200] (the default) counts any response below 500 as up, so a 404 or a bot-protection 403 is up; kind api, or any other list of codes, must match exactly. heartbeat takes no target or regions; the result has ping_url, shown only this once, for the job to call with curl -fsS when it finishes (append /fail to report a failure). server (Linux machines with the QuickStatus.dev server agent) takes no target or regions; the result has install_command, shown only this once: run it as root on each Linux server to enroll it. It holds the enrollment token, so do not paste it into files or chat logs. A new server check has rules for CPU and memory above 90% for 10 minutes and any disk above 90%; rules are edited in the console. mcp runs initialize and tools/list against an MCP server URL. Each parameter's description gives its allowed values and default. Request headers, request body, and HTTP auth stay in the console.

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": {
      "name": "<name>"
    },
    "name": "create_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
kindNohttp, api, dns, tcp, heartbeat, mcp, or server.http
nameYesDisplay name. Blank comes from the target; a blank heartbeat is named Heartbeat, so pass a name that says which job it watches.
portNoTCP port (1 to 65535). Required for kind tcp; other kinds reject it.
targetNohttp/api/mcp: a full URL (https://...). dns: a domain name. tcp: a hostname or IP only, no scheme or port (pass port separately). heartbeat and server: leave empty.
regionsNoRegion codes from list_regions, for example us-west-1. Omit for the default region. At most max_regions from usage. heartbeat and server take none.
site_idNoStatus page id for linking. Pass with site_slug and component_id.
site_slugNoStatus page slug for linking. Pass with site_id and component_id.
dns_serverNoResolver host or IP, optionally with :port. Empty uses the default resolver. dns only.
verify_sslNoFail the check when the TLS certificate is invalid or expired. Default true.
http_methodNoGET (default), POST, PUT, PATCH, DELETE, or HEAD. http and api only.
min_membersNoserver only: the check goes down when fewer machines than this are reporting. Default 1. At most max_server_members from usage (Free 1, Pro 25, Scale 100).
slow_metricNototal (default: the whole response) or ttfb (time to first byte).
tcp_payloadNoText to send after connecting. tcp only.
component_idNoStatus page component to link. Pass with site_id and site_slug.
dns_protocolNoudp (default) or tcp. dns only.
alert_on_lostNoserver only: also warn for each machine that stops reporting without leaving cleanly. Default false.
body_containsNoText that must appear in the response body (first 64 KB). http and api only.
incident_modeNoFor a linked check: off, auto (publish incidents), or review (store a draft a person approves before it is published).
tcp_ip_familyNoipv4 (default) or ipv6. tcp only.
cert_warn_daysNo7, 14, or 30: warn that many days before an https certificate expires, then once more at each smaller step (14 warns at 14, 7, and 1 day). 0 turns it off. create_check defaults to 14 for https targets; omitted leaves it unchanged on update_check, except that a change to an http:// target clears it and a change from http:// to https:// sets 14. Ignored for http:// targets and for dns and tcp on create; dns and tcp reject it on update.
display_metricsNoFor a linked check: show response time on the public status page.
dns_record_typeNoA (default), AAAA, CNAME, TXT, MX, NS, or CAA. dns only.
timeout_secondsNoSeconds to wait for a response, 1 to 60. Default 10.
follow_redirectsNoFollow redirects. Default true. http and api only.
interval_secondsNoSeconds between runs (heartbeat: how often the job pings; server: how often each machine reports, at least 60). At least the plan minimum (min_interval_seconds from usage, for example 300 on Free) and at most 86400. Default: the plan minimum.
slow_threshold_msNohttp, api, and mcp: a successful run slower than this many ms marks the check slow. The check stays current_status up with degraded_since set, sends a slow alert, and does not count as downtime. 0 turns it off. Off unless set on create_check; omitted leaves it unchanged on update_check.
mcp_expected_toolsNomcp only: tool names that must appear in tools/list. Tools are listed, never called.
alert_email_enabledNoEmail the workspace owner on down and recovery. Default true. Heartbeats alert after 1 missed or failed ping; other kinds after 3 failed runs in a row, and recover after 1 success.
dns_expected_valuesNoAnswers that must be present, for example an IP for A or '10 mail.example.com' for MX. dns only.
group_grace_secondsNoserver only: seconds the check may stay below min_members before it goes down, so a reboot or rolling deploy does not alert. Default 300; 0 means at once.
tcp_expected_outcomeNoconnect (default: up when the port accepts) or fail (up when it refuses). tcp only.
alert_destination_idsNoAlert destination ids from list_alert_destinations (Slack, webhook, and so on).
expected_status_codesNoStatus codes that count as up. Default [200]. For kind http, exactly [200] means any response below 500 is up; any other list, such as [200, 201], must match exactly. Kind api always matches exactly.
incident_auto_resolveNoFor a linked check: resolve the incident when the check recovers.
alert_incident_enabledNoFor a linked check: open one status incident per outage (or flapping period).
heartbeat_grace_secondsNoheartbeat only: extra seconds after the expected ping before it counts as missed. 0 means no grace; up to 86400. Default: the same as interval_seconds.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / min_members / description
      Previous value: -"server only: the check goes down when fewer machines than this are reporting. Default 1. At most max_server_members from usage (Free 1, Pro 25)."New value: +"server only: the check goes down when fewer machines than this are reporting. Default 1. At most max_server_members from usage (Free 1, Pro 25, Scale 100)."
  2. Changed7 schema fields changed
    • addedInput schema / properties / alert_on_lost
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "server only: also warn for each machine that stops reporting without leaving cleanly. Default false.",
      +  "title": "Alert On Lost"
      +}
    • addedInput schema / properties / group_grace_seconds
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "server only: seconds the check may stay below min_members before it goes down, so a reboot or rolling deploy does not alert. Default 300; 0 means at once.",
      +  "title": "Group Grace Seconds"
      +}
    • changedInput schema / properties / interval_seconds / description
      Previous value: -"Seconds between runs (for heartbeat: how often the job pings). At least the plan minimum (min_interval_seconds from usage, for example 300 on Free) and at most 86400. Default: the plan minimum."New value: +"Seconds between runs (heartbeat: how often the job pings; server: how often each machine reports, at least 60). At least the plan minimum (min_interval_seconds from usage, for example 300 on Free) and at most 86400. Default: the plan minimum."
    • changedInput schema / properties / kind / description
      Previous value: -"http, api, dns, tcp, heartbeat, or mcp."New value: +"http, api, dns, tcp, heartbeat, mcp, or server."
    • addedInput schema / properties / min_members
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "server only: the check goes down when fewer machines than this are reporting. Default 1. At most max_server_members from usage (Free 1, Pro 25).",
      +  "title": "Min Members"
      +}
    • changedInput schema / properties / regions / description
      Previous value: -"Region codes from list_regions, for example us-west-1. Omit for the default region. At most max_regions from usage. heartbeat takes none."New value: +"Region codes from list_regions, for example us-west-1. Omit for the default region. At most max_regions from usage. heartbeat and server take none."
    • changedInput schema / properties / target / description
      Previous value: -"http/api/mcp: a full URL (https://...). dns: a domain name. tcp: a hostname or IP only, no scheme or port (pass port separately). heartbeat: leave empty."New value: +"http/api/mcp: a full URL (https://...). dns: a domain name. tcp: a hostname or IP only, no scheme or port (pass port separately). heartbeat and server: leave empty."
  3. Changed36 schema fields changed
    • addedInput schema / properties / alert_destination_ids / description
      Added value: +"Alert destination ids from list_alert_destinations (Slack, webhook, and so on)."
    • addedInput schema / properties / alert_email_enabled / description
      Added value: +"Email the workspace owner on down and recovery. Default true. Heartbeats alert after 1 missed or failed ping; other kinds after 3 failed runs in a row, and recover after 1 success."
    • addedInput schema / properties / alert_incident_enabled / description
      Added value: +"For a linked check: open one status incident per outage (or flapping period)."
    • addedInput schema / properties / body_contains / description
      Added value: +"Text that must appear in the response body (first 64 KB). http and api only."
    • addedInput schema / properties / cert_warn_days
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "7, 14, or 30: warn that many days before an https certificate expires, then once more at each smaller step (14 warns at 14, 7, and 1 day). 0 turns it off. create_check defaults to 14 for https targets; omitted leaves it unchanged on update_check, except that a change to an http:// target clears it and a change from http:// to https:// sets 14. Ignored for http:// targets and for dns and tcp on create; dns and tcp reject it on update.",
      +  "title": "Cert Warn Days"
      +}
    • addedInput schema / properties / component_id / description
      Added value: +"Status page component to link. Pass with site_id and site_slug."
    • addedInput schema / properties / display_metrics / description
      Added value: +"For a linked check: show response time on the public status page."
    • addedInput schema / properties / dns_expected_values / description
      Added value: +"Answers that must be present, for example an IP for A or '10 mail.example.com' for MX. dns only."
    • addedInput schema / properties / dns_protocol / description
      Added value: +"udp (default) or tcp. dns only."
    • addedInput schema / properties / dns_record_type / description
      Added value: +"A (default), AAAA, CNAME, TXT, MX, NS, or CAA. dns only."
    • addedInput schema / properties / dns_server / description
      Added value: +"Resolver host or IP, optionally with :port. Empty uses the default resolver. dns only."
    • addedInput schema / properties / expected_status_codes / description
      Added value: +"Status codes that count as up. Default [200]. For kind http, exactly [200] means any response below 500 is up; any other list, such as [200, 201], must match exactly. Kind api always matches exactly."
    • addedInput schema / properties / follow_redirects / description
      Added value: +"Follow redirects. Default true. http and api only."
    • addedInput schema / properties / heartbeat_grace_seconds
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "heartbeat only: extra seconds after the expected ping before it counts as missed. 0 means no grace; up to 86400. Default: the same as interval_seconds.",
      +  "title": "Heartbeat Grace Seconds"
      +}
    • addedInput schema / properties / http_method / description
      Added value: +"GET (default), POST, PUT, PATCH, DELETE, or HEAD. http and api only."
    • addedInput schema / properties / incident_auto_resolve / description
      Added value: +"For a linked check: resolve the incident when the check recovers."
    • addedInput schema / properties / incident_mode / description
      Added value: +"For a linked check: off, auto (publish incidents), or review (store a draft a person approves before it is published)."
    • addedInput schema / properties / interval_seconds / description
      Added value: +"Seconds between runs (for heartbeat: how often the job pings). At least the plan minimum (min_interval_seconds from usage, for example 300 on Free) and at most 86400. Default: the plan minimum."
    • addedInput schema / properties / kind / default
      Added value: +"http"
    • addedInput schema / properties / kind / description
      Added value: +"http, api, dns, tcp, heartbeat, or mcp."
    • addedInput schema / properties / mcp_expected_tools
      Added value: +{
      +  "anyOf": [
      +    {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "mcp only: tool names that must appear in tools/list. Tools are listed, never called.",
      +  "title": "Mcp Expected Tools"
      +}
    • addedInput schema / properties / name / description
      Added value: +"Display name. Blank comes from the target; a blank heartbeat is named Heartbeat, so pass a name that says which job it watches."
    • addedInput schema / properties / port / description
      Added value: +"TCP port (1 to 65535). Required for kind tcp; other kinds reject it."
    • addedInput schema / properties / regions / description
      Added value: +"Region codes from list_regions, for example us-west-1. Omit for the default region. At most max_regions from usage. heartbeat takes none."
    • addedInput schema / properties / site_id / description
      Added value: +"Status page id for linking. Pass with site_slug and component_id."
    • addedInput schema / properties / site_slug / description
      Added value: +"Status page slug for linking. Pass with site_id and component_id."
    • addedInput schema / properties / slow_metric
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "total (default: the whole response) or ttfb (time to first byte).",
      +  "title": "Slow Metric"
      +}
    • addedInput schema / properties / slow_threshold_ms
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "http, api, and mcp: a successful run slower than this many ms marks the check slow. The check stays current_status up with degraded_since set, sends a slow alert, and does not count as downtime. 0 turns it off. Off unless set on create_check; omitted leaves it unchanged on update_check.",
      +  "title": "Slow Threshold Ms"
      +}
    • addedInput schema / properties / target / default
      Added value: +""
    • addedInput schema / properties / target / description
      Added value: +"http/api/mcp: a full URL (https://...). dns: a domain name. tcp: a hostname or IP only, no scheme or port (pass port separately). heartbeat: leave empty."
    • addedInput schema / properties / tcp_expected_outcome / description
      Added value: +"connect (default: up when the port accepts) or fail (up when it refuses). tcp only."
    • addedInput schema / properties / tcp_ip_family / description
      Added value: +"ipv4 (default) or ipv6. tcp only."
    • addedInput schema / properties / tcp_payload / description
      Added value: +"Text to send after connecting. tcp only."
    • addedInput schema / properties / timeout_seconds / description
      Added value: +"Seconds to wait for a response, 1 to 60. Default 10."
    • addedInput schema / properties / verify_ssl / description
      Added value: +"Fail the check when the TLS certificate is invalid or expired. Default true."
    • changedInput schema / required
      Previous value: -[
      -  "name",
      -  "target",
      -  "kind"
      -]New value: +[
      +  "name"
      +]
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only say it is a non-destructive, non-idempotent write; the description adds the operationally important behavior: the heartbeat ping_url and server install_command are returned only once, the install command embeds an enrollment token that must not be pasted into files or chat, and alerting semantics differ for heartbeats (1 missed ping) vs other kinds (3 failed runs). That is real disclosure the annotations cannot carry.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then prerequisite, then per-kind notes in a scannable sequence; every paragraph carries operational content. It is dense and somewhat long for a description, with a few sentences (the up-rules paragraph) duplicating schema wording that could have been trimmed.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 36-parameter creation tool with no output schema, the description covers the plan-limit prerequisite, per-kind required/forbidden fields, and the shape of the create-only return values (ping_url, install_command). An agent has enough to construct a valid call and to warn the user about one-time secrets.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so per-parameter defaults and allowed values are already documented; the description's added value is cross-parameter rules the schema cannot express, such as "heartbeat takes no target or regions" and the http-vs-api up-rule distinction for expected_status_codes. Some of this restates schema text (cert_warn_days, slow_threshold_ms), which keeps it just short of a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource ("Create a check") and immediately enumerates the supported kinds (http, api, dns, tcp, heartbeat, mcp), which lets an agent tell this apart from update_check/delete_check/run_check siblings without opening a schema. The kind enumeration also signals the tool's polymorphic surface up front.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit prerequisite ("Call usage first: it gives min_interval_seconds, max_regions, and max_endpoints") and explicit out-of-scope items ("Request headers, request body, and HTTP auth stay in the console", "rules are edited in the console"). It also states per-kind applicability (heartbeat/server take no target or regions), so the agent knows which branches of the call are valid.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources