Skip to main content
Glama
Sign In
shiply — Static Site Hosting & Deployment

shiply — Static Site Hosting & Deployment

by stevejford
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

Check custom-domain readiness

check_custom_domain
Read-onlyIdempotent

Verify that a custom domain's DNS and SSL provisioning is complete. Returns ready:true when the site is live on that domain.

Instructions

Check whether a custom domain has finished provisioning (DNS + SSL). Returns ready:true once the site is serving on the domain. Read-only. Requires an API key.

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

Input Schema

NameRequiredDescriptionDefault
domainIdYesThe domain id returned by add_custom_domain.
apiKeyNoshiply API key (shp_…). Falls back to SHIPLY_API_KEY.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds value by specifying the return condition (ready:true) and the need for authentication, without contradicting the annotations.

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?

The description is two sentences that are succinct and front-loaded. Every sentence provides essential information without redundancy.

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

Completeness4/5

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

Given a simple tool with 2 parameters, no output schema, and good annotations, the description covers the main purpose, return indicator, and authentication requirement. It could mention potential error conditions but is generally complete.

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% with detailed parameter descriptions. The description adds minimal extra meaning beyond the schema, so a baseline of 3 is appropriate.

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?

The description clearly states the verb 'Check' and the resource 'custom domain provisioning', specifying the return condition 'ready:true once the site is serving'. It distinguishes itself from siblings like add_custom_domain and site_status.

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

Usage Guidelines4/5

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

The description indicates the requirement for an API key and mentions fallback to environment variable, providing clear context for usage. Although no explicit exclusions are given, the purpose is specific enough to guide when to use this tool versus alternatives.

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

Deploy Server

Other Tools