Skip to main content
Glama

Publish a site

publish_site
Idempotent

Publish files to the web → live URL at .shiply.now. UPDATING: never create a new site for changes — re-call with claimToken (anonymous sites) or slug (sites you own with a Bearer key) and the SAME URL gets the new version. Unchanged files are hash-skipped server-side, so re-publishing (including retrying a failed publish) is cheap — always update the same site rather than creating a new one. Works WITHOUT auth (anonymous: 24h lifetime, returns claimToken/claimUrl — SAVE THEM). With a Bearer shp_ key sites are permanent. ≤50 files / 2 MB inline; bigger: REST flow per https://shiply.now/llms.txt. index.html serves at /. spaMode for client-side routing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugNoUPDATE an existing site you own (requires Bearer key)
filesYessite files; index.html required for a homepage
titleNodisplay title for the site
clientNooptional: file this under a client (the publish/site is grouped in their customer view)
spaModeNoserve index.html for unknown paths (client-side routing)
agentNameNolabel shown during the automatic account re-auth flow
claimTokenNoUPDATE an existing anonymous site (from the original publish result)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / agentName
      Added value: +{
      +  "description": "label shown during the automatic account re-auth flow",
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / client
      Added value: +{
      +  "description": "optional: file this under a client (the publish/site is grouped in their customer view)",
      +  "properties": {
      +    "clientCompany": {
      +      "description": "client's company (used when creating)",
      +      "type": "string"
      +    },
      +    "clientEmail": {
      +      "description": "client email — create-or-find by this",
      +      "format": "email",
      +      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      +      "type": "string"
      +    },
      +    "clientId": {
      +      "description": "an existing client id (skips lookup)",
      +      "format": "uuid",
      +      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +      "type": "string"
      +    },
      +    "clientName": {
      +      "description": "client's name (used when creating)",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed4 schema fields changed
    • addedInput schema / properties / files / items / properties / content / description
      Added value: +"file contents (utf8 text, or base64 when encoding=base64)"
    • addedInput schema / properties / spaMode / description
      Added value: +"serve index.html for unknown paths (client-side routing)"
    • addedInput schema / properties / title / description
      Added value: +"display title for the site"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "result": {}
      +  },
      +  "required": [
      +    "result"
      +  ],
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the idempotentHint annotation, the description discloses anonymous 24h lifetime, the need to save claimToken/claimUrl, hash-skipping of unchanged files, retry cheapness, inline size limits, and index.html/spaMode serving behavior. This is substantial behavioral context that the annotation alone does not provide.

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 dense but well-organized, front-loading the core purpose and then using clear labels (UPDATING, Works WITHOUT auth, ≤50 files) to separate concerns. Every sentence carries actionable information with no filler.

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?

Despite the tool's complexity (7 params, nested objects, auth modes, output schema), the description covers the essential operational context: URL scheme, update semantics, authentication modes, limits, fallback REST flow, and routing behavior. The output schema and 100% parameter schema coverage handle the remaining details.

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 the baseline is 3. The description adds meaningful semantics on top: the distinction between claimToken and slug for updating, permanent vs anonymous sites, inline size limits, and the behavior of index.html and spaMode. It does not redundantly restate parameter names.

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 opens with a specific verb and resource ('Publish files to the web') and a concrete outcome (live URL at <slug>.shiply.now). It clearly distinguishes the update behavior from creating a new site, which separates it from sibling tools like publish_from_drive or create_project.

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?

It gives explicit when-to-use guidance: never create a new site for changes, always re-call publish_site with claimToken or slug. It also names an alternative for oversized payloads ('bigger: REST flow per https://shiply.now/llms.txt') and explains the auth/no-auth conditions for choosing the right invocation.

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