SolidPing

Official

Overview Schema Source Related Servers Discussions Admin

Create check

create_check

Create a monitoring check for HTTP, TCP, DNS, databases and more, then get its uid, slug and placement back. Validate the config first to catch errors and avoid slug conflicts.

Instructions

Create a new monitoring check and return it (uid, slug, placement, resolved periods). If you don't know what config shape a given type expects, call list_check_types with type first to fetch a working starting config, then use validate_check to dry-run before creating. An enabled check starts running on its next tick and opens an incident after its confirmation period; pass enabled:false to create it paused. A duplicate slug is rejected with a conflict, never merged — use update_check to change an existing check. Requires the mcp scope (mcp:read tokens are refused) and at least the user role in the organization.

Input Schema

TableJSON Schema

Name	Required	Description
`name`	No	Human-readable name, e.g. "API production". Auto-generated from URL if omitted.
`slug`	No	URL-friendly slug (3-20 lowercase letters/digits/hyphens), e.g. "api-prod". Auto-generated if omitted.
`type`	No	Check type. Allowed: http, tcp, icmp, dns, heartbeat, email, domain, ssl, smtp, udp, ssh, pop3, imap, websocket, postgresql, ftp, sftp, js, mysql, redis, mongodb, mssql, oracle, clickhouse, grpc, kafka, mqtt, a2s, minecraft, rabbitmq, snmp, docker, browser, freebox_line, dnsbl, sip, kubernetes, ntp, rdp, vnc, prometheus, private-location, crawl, health. Inferred from config if omitted.
`config`	Yes	Check-specific config. Shape depends on type. Example for http: {"url": "https://example.com", "method": "GET"}. Use list_check_types with type to discover the shape for other types.
`labels`	No	Key-value labels for organization and filtering, e.g. {"env":"production","team":"api"}.
`period`	No	Check interval as HH:MM:SS, e.g. "00:00:30" for 30 seconds, "00:01:00" for 1 minute (default).
`enabled`	No	Whether the check should run. Default true.
`regions`	No	Region slugs to pin the check to, e.g. ["eu-west-1","us-east-1"]. An explicit list means placement "pinned": the check runs from exactly these regions and is never moved. When omitted, the check is placed automatically (placement "auto"): the scheduler picks regionCount healthy regions from the org's default_regions, then the system default, then every other declared region, and moves the check off a region that goes dark. (An org whose own default_regions names a private location keeps pinned checks on those defaults.)
`placement`	No	"pinned" or "auto". Omit to infer it: regions given means pinned, otherwise auto. "auto" cannot be combined with regions. Private (@) regions are pinned-only.
`failQuorum`	No	Multi-region quorum: how many of the check's regions must be failing, for the confirmation period, before it is down and an incident opens. "all", "majority" or a whole number such as "2" (clamped to the region count). The default is all regions for 1-2 regions and a majority for 3+. Fewer failing regions than the quorum is a "regional issue": the check shows warning and no incident opens. "all" keeps the per-result rule: any passing region resets the confirmation. Omit for the default.
`regionPool`	No	Automatic placement only: the cloud region slugs the scheduler may choose from, e.g. ["paris","gravelines"]. Omit for any cloud region. Implies placement auto.
`description`	No	Free-text description shown in the UI.
`regionCount`	No	Automatic placement only: how many regions run the check (default 2, capped by the eligible regions and the org's checks-per-minute limit; the response carries a PLACEMENT_REGION_COUNT_REDUCED warning when reduced). Implies placement auto.
`checkGroupUid`	No	Assign the check to a check group (UID or slug), e.g. "core-services".
`recoveryPeriodSeconds`	No	Wall-clock seconds the check must stay UP before auto-resolving an incident. Any failure inside the window resets the recovery clock. 0 = resolve immediately. Range 0–86400. Default 120.
`confirmationPeriodSeconds`	No	Wall-clock seconds to wait after the first failure before opening an incident. 0 = open immediately on the first failure. Range 0–86400 (one day). Default 120.

Output Schema

TableJSON Schema

Name	Required	Description
`uid`	Yes	Check UID.
`name`	No	Human-readable name.
`slug`	No	URL-friendly slug.
`type`	No	Check type, e.g. "http".
`config`	No	Check-specific configuration for the type.
`labels`	No	Key-value labels.
`period`	No	Check interval as HH:MM:SS.
`status`	No	Synthesized status: up, down, validating, created or degraded.
`enabled`	No	Whether the check runs.
`regions`	No	Regions the check runs from.
`createdAt`	No	RFC3339 creation timestamp.
`placement`	No	"pinned" or "auto".
`description`	No	Free-text description.
`lastResultAt`	No	RFC3339 timestamp of the newest real result.
`checkGroupUid`	No	Check group UID, when the check belongs to a group.
`statusChangedAt`	No	RFC3339 timestamp of the last status change.

Schema Changelog

Changes observed during successful MCP inspections.

Changed8 schema fields changedv0.38.5Oct 15, 2026

changedInput schema / properties / config / description

Previous value: -"Check-specific config. Shape depends on type. Example for http: {\"url\": \"https://example.com\", \"method\": \"GET\"}. Use get_check_type_samples to discover the shape for other types."New value: +"Check-specific config. Shape depends on type. Example for http: {\"url\": \"https://example.com\", \"method\": \"GET\"}. Use list_check_types with type to discover the shape for other types."

addedInput schema / properties / failQuorum

Added value: +{
+  "description": "Multi-region quorum: how many of the check's regions must be failing, for the confirmation period, before it is down and an incident opens. \"all\", \"majority\" or a whole number such as \"2\" (clamped to the region count). The default is all regions for 1-2 regions and a majority for 3+. Fewer failing regions than the quorum is a \"regional issue\": the check shows warning and no incident opens. \"all\" keeps the per-result rule: any passing region resets the confirmation. Omit for the default.",
+  "type": "string"
+}

addedInput schema / properties / placement

Added value: +{
+  "description": "\"pinned\" or \"auto\". Omit to infer it: regions given means pinned, otherwise auto. \"auto\" cannot be combined with regions. Private (@) regions are pinned-only.",
+  "type": "string"
+}

addedInput schema / properties / regionCount

Added value: +{
+  "description": "Automatic placement only: how many regions run the check (default 2, capped by the eligible regions and the org's checks-per-minute limit; the response carries a PLACEMENT_REGION_COUNT_REDUCED warning when reduced). Implies placement auto.",
+  "type": "integer"
+}

addedInput schema / properties / regionPool

Added value: +{
+  "description": "Automatic placement only: the cloud region slugs the scheduler may choose from, e.g. [\"paris\",\"gravelines\"]. Omit for any cloud region. Implies placement auto.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

changedInput schema / properties / regions / description

Previous value: -"Region slugs to run the check from, e.g. [\"eu-west-1\",\"us-east-1\"]. Defaults to all org regions when omitted."New value: +"Region slugs to pin the check to, e.g. [\"eu-west-1\",\"us-east-1\"]. An explicit list means placement \"pinned\": the check runs from exactly these regions and is never moved. When omitted, the check is placed automatically (placement \"auto\"): the scheduler picks regionCount healthy regions from the org's default_regions, then the system default, then every other declared region, and moves the check off a region that goes dark. (An org whose own default_regions names a private location keeps pinned checks on those defaults.)"

changedInput schema / properties / type / description

Previous value: -"Check type. Allowed: http, tcp, icmp, dns, ssl, heartbeat, domain. Inferred from config if omitted."New value: +"Check type. Allowed: http, tcp, icmp, dns, heartbeat, email, domain, ssl, smtp, udp, ssh, pop3, imap, websocket, postgresql, ftp, sftp, js, mysql, redis, mongodb, mssql, oracle, clickhouse, grpc, kafka, mqtt, a2s, minecraft, rabbitmq, snmp, docker, browser, freebox_line, dnsbl, sip, kubernetes, ntp, rdp, vnc, prometheus, private-location, crawl, health. Inferred from config if omitted."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "checkGroupUid": {
+      "description": "Check group UID, when the check belongs to a group.",
+      "type": "string"
+    },
+    "config": {
+      "description": "Check-specific configuration for the type.",
+      "type": "object"
+    },
+    "createdAt": {
+      "description": "RFC3339 creation timestamp.",
+      "type": "string"
+    },
+    "description": {
+      "description": "Free-text description.",
+      "type": "string"
+    },
+    "enabled": {
+      "description": "Whether the check runs.",
+      "type": "boolean"
+    },
+    "labels": {
+      "description": "Key-value labels.",
+      "type": "object"
+    },
+    "lastResultAt": {
+      "description": "RFC3339 timestamp of the newest real result.",
+      "type": "string"
+    },
+    "name": {
+      "description": "Human-readable name.",
+      "type": "string"
+    },
+    "period": {
+      "description": "Check interval as HH:MM:SS.",
+      "type": "string"
+    },
+    "placement": {
+      "description": "\"pinned\" or \"auto\".",
+      "type": "string"
+    },
+    "regions": {
+      "description": "Regions the check runs from.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "slug": {
+      "description": "URL-friendly slug.",
+      "type": "string"
+    },
+    "status": {
+      "description": "Synthesized status: up, down, validating, created or degraded.",
+      "type": "string"
+    },
+    "statusChangedAt": {
+      "description": "RFC3339 timestamp of the last status change.",
+      "type": "string"
+    },
+    "type": {
+      "description": "Check type, e.g. \"http\".",
+      "type": "string"
+    },
+    "uid": {
+      "description": "Check UID.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "uid"
+  ],
+  "type": "object"
+}

First observedv0.32.1Sep 26, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations only cover readOnly/openWorld/idempotent/destructive hints, and the description adds substantial context beyond them: an enabled check starts on its next tick and opens an incident after its confirmation period, duplicate slugs are rejected with a conflict and never merged, and creation requires the mcp scope with at least the user role (mcp:read tokens refused). This is rich behavioral disclosure; it stops short of 5 only because rate limits or exact failure payloads are not described.

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

Conciseness5/5

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

Front-loads the core action and return values in the first sentence, then layers prerequisites, lifecycle behavior, error semantics and required scopes in descending priority. Five sentences, no filler; each carries a distinct fact an agent needs.

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 16-parameter mutation with nested config, the description covers the gaps structured data cannot: scope/role prerequisites, duplicate-slug conflict behavior, the paused-creation path, and the recommended discovery/validation workflow. An output schema exists and describes return values, so the brief return summary is sufficient.

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

Parameters3/5

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

Schema description coverage is 100% and the schema already documents every parameter in depth, including placement/regions interaction, quorum rules and period ranges. The description reinforces 'enabled:false creates it paused' and the type/config dependency, but adds no syntax or format detail the schema does not already carry, so the baseline 3 applies.

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?

States a specific verb and resource ('Create a new monitoring check'), plus the scope of what is returned (uid, slug, placement, resolved periods). It explicitly names update_check as the tool for modifying existing checks, so an agent can separate it from its siblings without reading either schema.

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?

Gives explicit sequencing guidance: call list_check_types with the type first to get a working config shape, then validate_check to dry-run before creating. It also states the alternative (update_check) and the condition that selects it (changing an existing check), and explains the enabled:false escape hatch for creating paused.

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