Shiply
Official105 toolsby shiply
Deploy from Claude Code in one call. Write-enabled MCP host, flat price, sell the site you built.
Deploy web applications from Claude with built-in monetization capabilities.
Captured live from the server via tools/list.
publish_site
Publish files to the web → live URL at <slug>.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). 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.
Parameters (5)
- filesarrayrequired
site files; index.html required for a homepage
- spaModeboolean
serve index.html for unknown paths (client-side routing)
- claimTokenstring
UPDATE an existing anonymous site (from the original publish result)
- slugstring
UPDATE an existing site you own (requires Bearer key)
- titlestring
display title for the site
site_status
Check any shiply slug or custom hostname: TLS certificate (issuer, days left) + HTTPS probe. ready=true means live.
Parameters (1)
- targetstringrequired
slug (my-site) or hostname (www.example.com)
verify_site
Edge-check a shiply slug or custom hostname and return a structured readiness report: status (LIVE/PENDING), SSL details (valid, issuer, daysLeft), HTTP probe, and a presigned thumbnail URL when available. Use this after publishing to confirm the site is reachable.
Parameters (1)
- targetstringrequired
slug (my-site) or hostname (www.example.com)
list_sites
List the sites owned by this API key.
No parameters.
get_site
Site settings + version history for one of my sites.
Parameters (1)
- slugstringrequired
site slug, e.g. my-site
delete_site
PERMANENTLY delete a site and all stored files. Irreversible — confirm with the user first.
Parameters (1)
- slugstringrequired
site slug to delete
rollback_site
Re-point a site to any finalized version (rollback or roll-forward). Get version ids from get_site. Serving updates immediately.
Parameters (2)
- slugstringrequired
site slug to re-point
- versionIdstringrequired
finalized version id from get_site
list_versions
List a site's finalized deploys newest-first (id, createdAt, isLive, fileCount, bytes), capped at 20. Pair with rollback_site: pick a version id from here and re-point the site to it.
Parameters (1)
- slugstringrequired
site slug to list deploys for
set_handle
Rename a site to <handle>.shiply.now (3-30 chars, a-z 0-9 -). The old address 301-redirects for 30 days.
Parameters (2)
- slugstringrequired
current site slug
- handlestringrequired
new vanity handle, 3-30 chars a-z 0-9 -
duplicate_site
Server-side copy of an owned site under a new slug — instantly live. Copies files + title; does NOT copy access settings, domains, or data. Great for iterating on variants.
Parameters (2)
- slugstringrequired
site slug to copy
- titlestring
display title for the new copy (defaults to source title)
promote_site
Copy the EXACT live bytes of one owned site (srcSlug — your preview) into another owned site (destSlug — your production site / custom domain), no rebuild. Dest keeps its slug, domains, and access settings; only the served bytes change.
Parameters (2)
- srcSlugstringrequired
- destSlugstringrequired
set_link
Path-mounting: serve an owned target site at a path on an owned host site (host/docs -> target). location is a path like "docs", or "__root__" for the host root. Both sites must be owned by you. Pass remove=true to unmount.
Parameters (4)
- hostSlugstringrequired
slug of the owned host site
- locationstringrequired
path to mount at, e.g. "docs", or "__root__" for the host root
- targetSlugstring
slug of the owned site to serve there (required unless remove=true)
- removeboolean
unmount instead of mounting
set_site_access
Protect an owned site (paid plans). mode 'public' (anyone), 'password' (supply password), or 'restricted' (supply allowedEmails and/or allowedDomains — only those can request a login code). Changing any setting signs out existing visitors.
Parameters (5)
- slugstringrequired
owned site slug to protect
- modestringrequired
public = anyone; password = supply password; restricted = supply allowedEmails/allowedDomains
- passwordstring
required when mode='password'
- allowedEmailsarray
allowlisted emails when mode='restricted'
- allowedDomainsarray
allowlisted email domains when mode='restricted'
export_account
Return a JSON bundle of the user's profile, sites, Site Data, drives, and metadata (secrets excluded). Data portability.
No parameters.
whoami
Who am I? Returns the signed-in account: email, @handle, plan + limits, counts of sites/domains/drives, and connected DNS providers. Call this first to orient before managing sites or domains.
No parameters.
get_account_status
Get the signed-in account's plan, capabilities, and upgrade URL. Call this FIRST when figuring out what features you have access to — it tells you exactly what's available and what's blocked. The upgrade_url is human-clickable; show it in chat when a feature requires a higher plan. Returns plan id + name + subscription status, hard limits (sites, databases, custom domains, drives), and a capability matrix listing every gated feature (workers_lite, databases_neon_postgres, custom_domains, etc.) with whether you have access and the minimum plan needed.
No parameters.
list_drives
List the user's private cloud Drives (id, name).
No parameters.
create_drive
Create a private cloud Drive (plan-limited).
Parameters (1)
- namestringrequired
display name for the new drive
drive_list_files
List files in a Drive (driveId = drv_…, or "default"). Optional prefix filter.
Parameters (2)
- driveIdstringrequired
drive id (drv_…) or "default"
- prefixstring
only list files under this path prefix
drive_put_file
Write a file into a Drive (driveId = drv_… or "default"). content is utf8 or base64. Use for agent memory, notes, context, assets.
Parameters (4)
- driveIdstringrequired
drive id (drv_…) or "default"
- pathstringrequired
destination path inside the drive, e.g. notes/context.md
- contentstringrequired
file contents (utf8 text, or base64 when encoding=base64)
- encodingstring
default utf8; base64 for binary
drive_delete_file
Delete a file from a Drive.
Parameters (2)
- driveIdstringrequired
drive id (drv_…) or "default"
- pathstringrequired
path of the file to delete
publish_from_drive
Snapshot a Drive (or a prefix of it) into a new live site at <slug>.shiply.now. Files copied server-side.
Parameters (3)
- driveIdstringrequired
drive id (drv_…) or "default"
- titlestring
display title for the new site
- prefixstring
only snapshot files under this path prefix
set_profile
Create or update the user's public portfolio at <handle>.shiply.now (handle 3-30 chars a-z0-9-). enable shows the profile; autoAdd auto-lists new sites. Use after publishing to give the user a shareable portfolio.
Parameters (3)
- handlestring
public handle, 3-30 chars a-z 0-9 -; profile lives at <handle>.shiply.now
- enableboolean
show (true) or hide (false) the public profile
- autoAddboolean
auto-list newly published sites on the profile
feature_site
Toggle whether an owned, public site appears in the public shiply Explore gallery (https://shiply.now/explore). Only public-access sites are eligible.
Parameters (2)
- slugstringrequired
owned, public site slug
- showbooleanrequired
true to feature on Explore, false to remove
set_variable
Upsert a key/value in the user's encrypted variable store (UPPER_SNAKE name, ≤8 KiB value). Use for API keys the user's sites/agents need, e.g. SUPABASE_URL.
Parameters (2)
- namestringrequired
variable name, UPPER_SNAKE_CASE, e.g. SUPABASE_URL
- valuestringrequired
value to store (encrypted, ≤8 KiB)
list_variables
List the encrypted variables. Values are masked unless reveal=true.
Parameters (1)
- revealboolean
return plaintext values instead of masked
delete_variable
Remove one variable by name.
Parameters (1)
- namestringrequired
variable name to delete
data_list_collections
List collections declared in an owned site's .shiply/data.json with current record counts. Empty list means the site has no manifest yet — scaffold one with `shiply data init`.
Parameters (1)
- slugstringrequired
owned site slug
data_query
Page records from an owned site's collection, newest-first. limit ≤ 200 (default 50). cursor from a previous response's nextCursor.
Parameters (4)
- slugstringrequired
owned site slug
- collectionstringrequired
collection name from data_list_collections
- limitinteger
max records to return, ≤200 (default 50)
- cursorstring
nextCursor from a previous response's page
data_insert
Insert one record into a collection. Goes through the same public visitor endpoint a browser would use — manifest access.insert decides whether it is allowed. Use to seed waitlist data, test forms end-to-end, etc.
Parameters (3)
- slugstringrequired
owned site slug
- collectionstringrequired
collection name to insert into
- recordobjectrequired
the record fields to insert as key/value pairs
data_export_collection
Return up to `limit` records (default 1000, max 5000) from a collection — for snapshotting into agent context. For larger sets use the CLI: `shiply data export <slug> <collection>`.
Parameters (3)
- slugstringrequired
owned site slug
- collectionstringrequired
collection name to export
- limitinteger
max records to return (default 1000, max 5000)
add_domain
Serve a site on a domain the user owns. Returns the CNAME to add (hostname → cname.shiply.now); the certificate issues automatically once DNS resolves. Poll with check_domain.
Parameters (2)
- hostnamestringrequired
full hostname to serve, e.g. www.example.com
- slugstringrequired
owned site slug to serve there
add_custom_domain
Register a registrable domain (e.g. example.com) the user owns and detect its DNS provider. Returns the provider and whether one-click connect is available. Then attach sites with add_subdomain.
Parameters (1)
- domainstringrequired
registrable domain you own, e.g. example.com
add_subdomain
Serve an owned site at <subdomain>.<domain> (use subdomain "@" or "" for the apex — apex needs a provider with CNAME flattening/ALIAS, e.g. Cloudflare). Auto-registers the parent domain. Returns the CNAME record to add (host -> cname.shiply.now); the certificate issues automatically once DNS resolves. Poll with check_domain.
Parameters (3)
- domainstringrequired
registrable parent domain, e.g. example.com
- subdomainstringrequired
subdomain label, or "@"/"" for the apex
- slugstringrequired
owned site slug to serve there
set_primary_subdomain
Mark a hostname as the primary (canonical) URL for its site. Sibling hostnames (apex + www both pointed at the same site) start 301-redirecting to it, preserving path + query. The host-side fix for the duplicate-content SEO problem. The first subdomain you add for a site is primary by default; call this only when you need to switch.
Parameters (2)
- domainstringrequired
registered custom domain, e.g. example.com
- hostnamestringrequired
full hostname to make primary, e.g. www.example.com
list_custom_domains
List registered custom domains grouped with their subdomains, each subdomain's site and status, and the detected provider.
No parameters.
connect_provider
Start one-click DNS connect for a registered custom domain. For Cloudflare-hosted domains this returns an authorize URL — SHOW THE USER the url as a clickable link; after they authorize, records are written automatically. For other providers, add the records manually.
Parameters (1)
- domainstringrequired
registered custom domain to connect, e.g. example.com
sync_dns
For a connected custom domain, (re)write the CNAME records for all its subdomains automatically and report what changed. For unconnected domains, returns the records to add manually.
Parameters (1)
- domainstringrequired
registered custom domain to sync, e.g. example.com
check_custom_domain
Check whether a custom domain's subdomains are live: re-polls Cloudflare cert status + probes DNS/TLS/HTTPS on each subdomain. Poll this after connect_provider / add_subdomain to confirm the domain is serving. Returns per-subdomain status + tls + http + ready.
Parameters (1)
- domainstringrequired
registered custom domain to check, e.g. example.com
remove_custom_domain
Remove a registered custom domain and all its subdomains; they stop serving immediately.
Parameters (1)
- domainstringrequired
registered custom domain to remove, e.g. example.com
list_domains
List connected custom domains with status.
No parameters.
check_domain
Refresh certificate status + live TLS/HTTPS probe for a connected domain (by id from list_domains).
Parameters (1)
- idstringrequired
connected domain id from list_domains
remove_domain
Remove a connected domain (by id). It stops serving immediately.
Parameters (1)
- idstringrequired
connected domain id from list_domains
get_analytics
Daily page views per site for the last 30 days.
No parameters.
create_test
Provision a demand test in one call: deploys a landing page with a native email-capture form and creates a confirmed-subscriber segment. Returns testId + live siteUrl. Share the siteUrl to collect signups; each signup gets a double-opt-in confirmation. Read progress with get_test_status.
Parameters (5)
- ideastringrequired
the product/idea name
- headlinestringrequired
landing-page headline
- substring
subheadline / supporting line
- ctastring
call-to-action button label
- pricestring
price to display, e.g. "$29/mo"
list_tests
List your demand tests with signups + confirmed counts.
No parameters.
get_test_status
ONE consolidated object: page funnel (views, signups, confirmed, conversion) ⊕ email events (delivered/opened/clicked/bounced) ⊕ a computed verdict. The single place to check progress — never query email separately.
Parameters (1)
- testIdstringrequired
demand test id from create_test / list_tests
send_broadcast
Send a campaign to this test's confirmed (double-opt-in) subscribers — the "we're live" email. An unsubscribe link is added automatically. Fails if there are no confirmed subscribers yet.
Parameters (4)
- testIdstringrequired
demand test id whose confirmed subscribers to email
- subjectstringrequired
email subject line
- htmlstringrequired
email HTML body (unsubscribe link added automatically)
- textstring
plain-text fallback body
resend_confirmation
Re-send the double-opt-in confirmation to a signup that has not confirmed yet.
Parameters (2)
- testIdstringrequired
demand test id the signup belongs to
- emailstringrequired
the unconfirmed signup email to re-send to
verify_claim
Confirm a pairing code shown in the user's browser at https://shiply.now/claim/<slug>?pair=1. Use ONLY in the agent session that originally published the site — it reads the claimToken from .shiply.json in the current working directory and proves to Shiply that this agent session is authorised to claim the site. After verification the user is auto-redirected to /welcome and the site binds to their account.
Parameters (1)
- codestringrequired
the SHIPLY-XXXXXXXX code in the user's browser
list_inbox
List the user's email inbox threads (outbound demand-test sends + inbound replies / unsubscribes / complaints / bounces). Filter by tag.
Parameters (3)
- filterstring
default all
- limitinteger
max threads to return, ≤200
- offsetinteger
number of threads to skip (pagination)
read_thread
Return the thread metadata + all messages in chronological order. Use list_inbox first to get a threadId.
Parameters (1)
- threadIdstringrequired
thread id from list_inbox
summarize_thread
One-paragraph summary of the thread, oriented to the most actionable signal (interest, complaint, question, unsubscribe).
Parameters (1)
- threadIdstringrequired
thread id from list_inbox
reply_to_thread
Send an email reply on an existing thread. Goes FROM the original recipient address (the <slug>@shiply.now alias the sender used) and TO the original sender. Threaded via RFC 5322 In-Reply-To so Gmail/Outlook group it with the original. Subject defaults to 'Re: <original>' when omitted. Cap at 20,000 chars. Use after read_thread to make sure you're replying to the right conversation.
Parameters (3)
- threadIdstringrequired
thread id from list_inbox to reply on
- bodystringrequired
reply body, ≤20,000 chars
- subjectstring
subject; defaults to 'Re: <original>'
mark_thread_read
Zero the unread counter for a thread. Useful after the agent has read but not acted. read_thread already calls this implicitly; use this explicitly when you want to clear unread without re-fetching the thread body.
Parameters (1)
- threadIdstringrequired
thread id from list_inbox to mark read
archive_thread
Soft-archive the thread (sets archivedAt). Hidden from the default inbox view; surface again with list_inbox filter=archived. Reverse with unarchive_thread.
Parameters (1)
- threadIdstringrequired
thread id from list_inbox to archive
unarchive_thread
Restore an archived thread (clears archivedAt). It reappears in the default inbox list. Pair with list_inbox filter=archived to find archived threadIds first.
Parameters (1)
- threadIdstringrequired
archived thread id to restore
forward_thread
Forward a message from a thread (default: the most recent message) to a NEW recipient with an optional intro note. Body is composed as note + standard '---------- Forwarded message ----------' quote of the original. Goes from the thread's existing shiply alias so replies still route through the inbox. Subject defaults to 'Fwd: <original>'.
Parameters (5)
- threadIdstringrequired
thread id from list_inbox to forward from
- tostringrequired
new recipient email address
- messageIdstring
specific message to forward (default: most recent)
- subjectstring
subject; defaults to 'Fwd: <original>'
- notestring
intro note prepended above the forwarded quote
list_test_inbox_addresses
Return every active demand test's reply / inbound address (<slug>@<sitesDomain>). Use this when you need to TELL someone where to email — e.g. drafting a reply or sharing a test's contact address. Mail sent to these aliases lands in /dashboard/inbox tied to the test.
No parameters.
list_unsubscribes
Shortcut for list_inbox with filter=unsubscribes — shows every thread tagged as an opt-out request.
Parameters (1)
- limitinteger
max threads to return, ≤200
list_suppressions
Return the user's suppression list — addresses (and full domains) that shiply skips when sending. Bounces, complaints, manual user adds, and AI-detected unsubscribes all land here.
No parameters.
add_suppression
Add an address (or whole domain) to the user's suppression list. Future confirmations and broadcasts will skip it across every test. Use kind='email' for a single address, kind='domain' for everyone @example.com.
Parameters (3)
- kindstringrequired
'email' for one address, 'domain' for everyone @example.com
- valuestringrequired
e.g. 'spammy@example.com' or 'competitor.com'
- notesstring
optional reason / note for the suppression
remove_suppression
Delete one suppression by id. Use list_suppressions first to find the id.
Parameters (1)
- suppressionIdstringrequired
suppression id from list_suppressions
list_complaints
Return threads tagged as complaints (spam reports) OR bounces (recipient rejected). Read these before any further sending.
No parameters.
list_projects
List the dev's customer-intake projects (newest first). Optional filters: status (draft|intake_open|brief_ready|brief_failed|archived), q (case-insensitive match on label or customer email), limit (default 100). Use to triage what's in flight before opening a specific project.
Parameters (3)
- statusstring
filter by project status
- qstring
case-insensitive match on label or customer email
- limitinteger
max projects to return (default 100)
create_project
Spin up a new customer-intake project on the dev's account. Returns the project row plus intakeUrl — the public link the customer fills out (10-step wizard). If customerEmail is provided, shiply also emails them the intake invite. Use originatedFromSiteId to link a project to an existing site (e.g. 'redesign this site').
Parameters (4)
- labelstringrequired
project name shown in the dev dashboard
- customerNamestring
the customer's name
- customerEmailstring
customer email; if set, shiply emails them the intake invite
- originatedFromSiteIdstring
link this project to an existing site (e.g. a redesign)
get_project
Read one of the dev's projects by id — includes label, status, customer details, intake responses, AI brief, drive folder. Use before update_brief / regenerate_brief.
Parameters (1)
- idstringrequired
project id
update_brief
Overwrite the project's working brief (jsonb). Hard-capped at 500 KB. Use to revise the AI-generated brief by hand; the original AI output is preserved separately in briefAiOriginal so you can always compare. Does not change status.
Parameters (2)
- idstringrequired
project id
- briefobjectrequired
the full replacement brief object (jsonb, ≤500 KB)
regenerate_brief
Re-run the MiniMax/Anthropic brief generator from the project's current intake_responses and persist the result. Flips status to brief_ready on success or brief_failed on error. Use after the customer edits answers post-submit, or when the first AI attempt failed.
Parameters (1)
- idstringrequired
project id to re-run the brief for
archive_project
Move a project to status='archived'. Hidden from the default dashboard list. Optional reason is shown on the project page. Restore later with restore_project.
Parameters (2)
- idstringrequired
project id to archive
- reasonstring
optional reason shown on the project page
restore_project
Move an archived project back to status='draft' so it reappears in the active list. Idempotent on non-archived projects? No — server rejects the transition unless the project is currently archived.
Parameters (1)
- idstringrequired
archived project id to restore
list_project_files
Return the customer-uploaded files for one project (path, size, contentType, createdAt). Empty when no drive folder exists yet (no uploads). Use to inspect what intake assets the customer attached.
Parameters (1)
- idstringrequired
project id whose uploaded files to list
resend_intake_invite
Re-fire the 'your developer sent you a project intake' email to the project's customer. Throws invalid_request if the project has no customerEmail (the dev needs to set one via the dashboard first — customer email isn't agent-patchable). Use when the customer says they didn't receive the link.
Parameters (1)
- idstringrequired
project id to re-send the intake invite for
list_listings
Return every marketplace listing the seller owns (any status: draft, live, paused, sold). Includes site slug and current price. Use to see what's for sale across the account.
No parameters.
create_listing
Publish (or upsert) a marketplace listing for an owned site. Requires Stripe Connect set up (status='ready' — see get_connect_status). priceCents = whole-dollar between 100 and 999900. termsMode='standard' uses shiply's template; 'custom' requires termsCustom ≥50 chars. jurisdiction is required (e.g. 'California, USA').
Parameters (7)
- siteSlugstringrequired
slug of the owned site to list
- priceCentsintegerrequired
whole-dollar price in cents, 100–999900
- pitchstring
short sales pitch, ≤280 chars
- termsModestringrequired
'standard' uses shiply's template; 'custom' requires termsCustom
- termsCustomstring
custom terms text, ≥50 chars, required when termsMode='custom'
- jurisdictionstringrequired
governing jurisdiction, e.g. 'California, USA'
- statusstring
publish state (default draft)
update_listing
Patch a listing by siteSlug — change price, pitch, terms, jurisdiction, or status (draft|live|paused). Sold listings cannot be edited. Status transitions enforced server-side. Use to pause sales or drop the price.
Parameters (7)
- siteSlugstringrequired
slug of the listed site to patch
- priceCentsinteger
new whole-dollar price in cents, 100–999900
- pitchany
new sales pitch (null to clear)
- termsModestring
'standard' template or 'custom' terms
- termsCustomany
new custom terms text (null to clear)
- jurisdictionstring
governing jurisdiction, e.g. 'California, USA'
- statusstring
new listing status
delete_listing
Take a listing off the public marketplace by moving it to status='draft'. Marketplace v1 keeps the row so analytics + future re-listing work — there's no hard delete. Sold listings can't be modified. Use to stop accepting offers without losing pricing history.
Parameters (1)
- siteSlugstringrequired
slug of the listed site to unpublish
list_my_sales
Return every marketplace order for sites the user sold (incl. pending, paid, refunded, failed, disputed). Most recent first. Use to surface revenue + which orders are still inside the 30-day refund window (refundExpiresAt > now).
Parameters (1)
- limitinteger
max orders to return (default 100, max 500)
list_my_orders
Return every marketplace order the user PURCHASED. Most recent first. Shows the acquired site, paid amount, and whether the order is still inside the 30-day refund window. Use to recap what the user owns by purchase.
Parameters (1)
- limitinteger
max orders to return (default 100, max 500)
refund_order
Issue a full refund on a paid order the user sold. Must be inside the 30-day refund window (server enforces). Triggers a Stripe refund; the webhook flips the order to 'refunded' and reverts site ownership to the seller. Idempotent on already-refunded orders.
Parameters (2)
- orderIdstringrequired
id of the paid order to refund (from list_my_sales)
- reasonstring
optional refund reason
get_connect_status
Return the seller's Stripe Connect state: not_started | in_progress | pending_verification | ready | disabled. When status != 'ready' the user can't list sites. Includes a one-shot onboardingUrl (if not_started or in_progress) and dashboardUrl (if ready). Refreshes from Stripe on every call.
No parameters.
list_sending_domains
Return every BYO sending domain the user has added (id, domain, fromAddress, status: pending|verified|failed, DNS records). Use to inspect verification state or find the id of a domain to verify/remove.
No parameters.
add_sending_domain
Register a domain the user owns for outbound demand-test sends. Returns DNS records (SPF, DKIM, MX) to add at the DNS provider. After DNS propagates, call verify_sending_domain. Cannot be a shiply.now subdomain.
Parameters (1)
- domainstringrequired
e.g. mail.yourbrand.com
verify_sending_domain
Trigger Resend to re-check the domain's DNS records, persist the new status. Call after adding the DNS records returned by add_sending_domain. Status flips to 'verified' once SPF + DKIM + MX all check out.
Parameters (1)
- idstringrequired
sending domain id from list_sending_domains
remove_sending_domain
Delete a BYO sending domain. Any demand tests bound to it fall back to the managed shiply sender. Also GCs the underlying Resend domain. Irreversible — re-adding requires re-verifying DNS.
Parameters (1)
- idstringrequired
sending domain id from list_sending_domains
contract_draft
Draft a contract from a brief_ready project. Auto-fills 8 fields from the AI brief, Stripe Connect default currency, and dev profile. Returns the contract row with status='draft' so the dev can review fields before sending. After this, edit fields via PATCH /api/v1/contracts/{id} (no MCP edit tool yet), then call contract_send to fire it.
Parameters (1)
- projectIdstringrequired
Project to draft a contract for
contract_send
Send a draft contract to the customer. Validates all 8 fields are non-empty, computes content_hash, flips project to contract_sent, fires the customer email. Same handler works for amendment drafts — sending an amendment does not move project state.
Parameters (1)
- contractIdstringrequired
draft contract id to send (from contract_draft)
contract_amend
Create an amendment to a SIGNED parent contract. Scope delta required; fee delta and target date optional. Returns the draft amendment for editing before send — call contract_send with the returned amendment id to fire it. Cannot amend an amendment (amend the parent instead).
Parameters (4)
- parentContractIdstringrequired
id of the SIGNED parent contract to amend
- scopeDeltastringrequired
What's changing — visible to customer.
- feeDeltaCentsinteger
Optional fee adjustment in cents. Can be negative for descope.
- targetCompletionDatestring
Optional ISO date (YYYY-MM-DD) for revised completion.
contract_pdf
Get the signed contract PDF as a base64-encoded download. PDF includes the contract, signature certificate, and any signed amendments. Returns { filename, contentType, base64 }. Errors with conflict:contract_not_signed if the parent contract has not been signed yet.
Parameters (1)
- contractIdstringrequired
signed contract id (parent or amendment) to render as PDF
contract_status
Read the current state of a contract: status, sent_at, viewed_at, signed_at, signer info, content_hash, plus any amendments. Use this to check whether a customer has signed yet. Returns { contract, amendments } — the contract row matches GET /api/v1/contracts/{id}.
Parameters (1)
- contractIdstringrequired
contract id to read state for
deploy_function
Deploy a Worker function to a site. The function runs on every request to <slug>.shiply.now and can receive webhooks, run on cron triggers, and access bindings (D1, secrets, env vars). Requires Developer plan. Use when the user wants webhook receivers, cron jobs, or a backend for their site.
Parameters (4)
- slugstringrequired
site slug to deploy the function to
- sourcestringrequired
the Worker source code
- langstring
source language (default js)
- cronsarray
cron triggers to register, ≤20
get_function
Return the deployed function source + metadata for a site, or null if no function deployed.
Parameters (1)
- slugstringrequired
site slug whose function to fetch
remove_function
Remove the deployed Worker function from a site (and all its routes, secrets, and cron triggers). Site falls back to static-only serving. Irreversible.
Parameters (1)
- slugstringrequired
site slug whose function to remove
set_secret
Set a CF Worker secret on a site's deployed function. Value is encrypted-at-rest and accessible as env.<NAME> inside the worker. Use for Stripe keys, Resend API keys, etc.
Parameters (3)
- slugstringrequired
site slug whose function gets the secret
- namestringrequired
secret name, UPPER_SNAKE_CASE; available as env.<NAME>
- valuestringrequired
secret value (encrypted at rest), ≤8 KiB
list_secrets
List secret names (values not returned) for a site's deployed function.
Parameters (1)
- slugstringrequired
site slug whose secret names to list
remove_secret
Remove a secret from a site's deployed function. The binding disappears on next request.
Parameters (2)
- slugstringrequired
site slug whose function holds the secret
- namestringrequired
secret name to remove
list_crons
List cron triggers for a site's deployed function. Each cron is (path, schedule, lastRunAt).
Parameters (1)
- slugstringrequired
site slug whose cron triggers to list
set_cron
Set or update a cron trigger on a site's deployed function. Schedule is crontab syntax (UTC). Path is the URL the cron handler should fire on (for the worker's scheduled() handler context).
Parameters (3)
- slugstringrequired
site slug whose function gets the cron
- pathstringrequired
URL path the cron handler fires on
- schedulestringrequired
crontab schedule in UTC, e.g. "0 * * * *"
remove_cron
Remove a cron trigger from a site's deployed function.
Parameters (2)
- slugstringrequired
site slug whose cron to remove
- pathstringrequired
URL path of the cron to remove
get_function_logs
Read recent runtime logs for a site's per-site Worker (console output, request summaries, exceptions) from Cloudflare Workers Observability — 7-day retention, newest first. Use this to debug a deployed function: each event has timestamp, level, message, outcome, statusCode, requestId, and CPU/wall time. Also returns a CF dashboard deep-link.
Parameters (3)
- slugstringrequired
site slug whose function logs to read
- limitinteger
max events to return (default 50)
- sinceinteger
look back this many minutes (default 60, max 10080 = 7 days)
send_email
Send an email from <slug>.shiply.now's managed sender. The site can send transactional/notification email — no SMTP setup. Rate-limited and spam-checked; replies route back to the site inbox.
Parameters (5)
- slugstringrequired
site slug to send from (<slug>.shiply.now sender)
- tostringrequired
recipient email address
- subjectstringrequired
email subject line
- htmlstringrequired
email HTML body
- textstring
plain-text fallback body
list_site_inbox
Read the email threads (received, sent, web captures) for the agent's sites. Optionally scoped to one site by slug.
Parameters (1)
- slugstring
limit to one site by slug; omit for all sites
set_mailbox
Turn a Site Data collection into a mailbox: double opt-in, owner notifications, sending domain, branding. Call once per (site, collection) to configure how captured leads are handled.
Parameters (7)
- slugstringrequired
site slug the collection belongs to
- collectionstringrequired
Site Data collection to turn into a mailbox
- doubleOptInboolean
require email confirmation before a contact is active
- notifyOwnerboolean
email the owner on each new capture
- notifyTostring
address to send owner notifications to
- sendingDomainIdstring
BYO sending domain id to send from
- brandingobject
branding applied to mailbox emails
list_mailbox_contacts
List captured contacts for a (site, collection) mailbox, optionally filtered by status (signed_up/confirmed/unsubscribed). Returns email, status, confirmedAt, createdAt, and captured fields.
Parameters (3)
- slugstringrequired
site slug the mailbox belongs to
- collectionstringrequired
mailbox collection name
- statusstring
filter contacts by status
send_mailbox_broadcast
Send a one-shot broadcast to the confirmed (double-opt-in) subscribers of a (site, collection) mailbox. Spam-checked; unsubscribe footer auto-added. Fails if no confirmed subscribers exist yet.
Parameters (5)
- slugstringrequired
site slug the mailbox belongs to
- collectionstringrequired
mailbox collection whose confirmed audience to email
- subjectstringrequired
email subject line
- htmlstringrequired
email HTML body (unsubscribe footer added automatically)
- textstring
plain-text fallback body
README not available yet.
Install
Remote endpoint
Streamable HTTPHosted server - connect over the network, no local install.
https://shiply.now/mcpclaude_desktop_config.json
{
"mcpServers": {
"shiply": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://shiply.now/mcp"
]
}
}
}Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.