Skip to main content

For your AI and the curious

The connector tools

Every tool the SiteShip connector gives an AI app. What each one takes, what it answers, and which ones need the owner's yes.

On this page

The SiteShip connector is a remote MCP server. It gives an AI app 19 tools to build, check and run sites, plus two that are not for the model. This page lists them all.

Tool descriptions and their input schemas are sent to the AI app when it connects, so an AI never needs this page. It is here for people.

Address and sign-in

https://app.siteship.ai/mcp
  • Sign-in is OAuth. The AI app registers itself, then the owner signs in to SiteShip with an emailed code and allows the app. There is no API key.
  • Every tool acts as the signed-in account. It sees that account's sites and no others.
  • One prompt is offered, get-started. It sends the words "Get started with SiteShip."
  • Call guide first. With no topic it returns the account's sites, how to begin with this person, and how a site is built.

Every tool except guide, list_sites and create_site takes site: the subdomain or id from list_sites.

The connector tells the AI to ask the user before publish, before connecting or removing a domain, and before deleting a site.

Read

Tool What it does
guide The rules for building a site. topic for one, topics for several
list_sites The account's sites, with each one's address, domain, role and plan
site_outline A map of one site's files. With query, a text search across them
read_files Up to 20 text files in one call

Guide topics: architecture, blog, cookie-consent, data-pages, embeds, forms, interactivity, local-seo, seo, shopify, stripe-payments.

{ "site": "harbor-dental", "paths": ["pages/index.html", "pages/about.html:120-200"] }
  • read_files reads the draft when there is one. Add :from-to to a path for a line range of a long file.
  • Every read returns draft_version. Send it back as expected_version on the next write.
  • list_sites also returns the account's plan, how many live sites it allows, and how many are used. A free site carries an upgrade_url to give the owner.

Write

Tool What it does
create_site A new site from the starter, as a private draft. Takes name and an optional description
write_files Create, overwrite or delete files in the draft
edit_files Find-and-replace edits to existing draft files
history The draft's last changes; undo and redo
{
  "site": "harbor-dental",
  "summary": "Add the whitening page",
  "expected_version": 12,
  "files": [
    { "path": "pages/whitening.html", "content": "---\ntitle: Teeth Whitening\n---\n<h1>…</h1>" },
    { "path": "pages/old-offer.html", "content": null }
  ]
}

write_files

  • Up to 50 files and 400 KB in one call. What does not fit comes back in not_sent, to send in the next call. One page, template or data file can be up to 200 KB.
  • content: null deletes the file.
  • Writable paths: pages/ (.html, .md), templates/ (.html), data/ (.yaml, .json, .csv), text files in assets/js/, assets/files/ and assets/images/, theme.css and favicon.svg.
  • templates/layout.html and data/site.yaml need confirm_overwrite: true to be replaced. Use edit_files for them.
  • Files are checked first. Those that pass are written. One that would break the site comes back in rejected, with the problem, file and line. See Write-time checks.
  • expected_version refuses the write if the draft changed since that version.
  • job_id marks a change as made for a crew job.

edit_files

{
  "site": "harbor-dental",
  "files": [
    { "path": "pages/index.html", "edits": [{ "old": "<h1>Old</h1>", "new": "<h1>New</h1>" }] }
  ]
}
  • Up to 25 files in one call, and up to 20 edits in a file.
  • old must match once, unless all: true. Whitespace differences are tolerated. On a miss, the answer shows the closest lines.
  • It is safe to retry: an edit that is already applied is reported, not repeated.

Both write tools answer with the new draft_version, a change number, diagnostics, an outline of each page changed, and a preview_url.

history

list returns about the last 50 changes, each with who or what made it, a summary and the files. undo reverses one change as a new change: the latest still in place, or the change you name. redo brings back the last one undone. If a file has changed since, nothing happens and the answer names those files.

Preview and check

Tool What it does
preview Renders one draft page and checks it
check Checks the whole site without changing anything
{ "site": "harbor-dental", "path": "/services/whitening" }

preview returns problems with file and line, an outline of the page (title, headings, links, images missing alt text), its visible text, its schema.org markup, and a private link that works for 1 hour. Apps that support it show the draft in the chat, with a Publish button. path defaults to /. Asking for /sitemap.xml or /robots.txt returns what SiteShip will serve there.

check returns ready_to_publish, counts of blocking and warnings, problems grouped by file, and an SEO table by page. Run it before publish.

Publish and versions

Tool What it does
publish Makes the draft the live site
versions Lists published versions, or restores one into the draft

publish checks the whole draft first, and blocking problems stop it. Its answer depends on the site:

The site Answer
A free preview needs_plan, with an upgrade_url and a preview_url for the owner
On a plan, first publish status: "live"
Already live needs_approval, with an approve_url. A preview panel with a Publish changes button shows in the chat. The live site changes on the owner's click

It takes an optional expected_version and a note for the version list. It is never called during a scheduled jobs run.

versions with action: "list" returns the published versions, which are kept 90 days, and the newest 10 always. action: "restore" loads one into the draft, where it can be previewed and then published. A restore is one change in the draft history, so history can undo it.

Images

Tool What it does
add_image Finds stock photos, or copies an image from a web address into the draft
request_upload Lets the owner upload their own images
check_upload Lists what the owner uploaded
{ "site": "harbor-dental", "search": ["dentist smiling with patient", "modern dental clinic reception"] }
  • add_image with search takes one query or a list of up to 8, and returns the top 3 Unsplash photos for each query in a list, with alt text and the credit to show. The address is used as the image src as it is. orientation is landscape, portrait or square.
  • add_image with url downloads one https image, up to 5 MB, into assets/images/ and returns its path. name sets the file name.
  • request_upload returns an upload_id and an upload_url, and shows an upload panel in apps that support it. The link lasts 30 minutes. Files attached in a chat can't reach SiteShip, so this is the way in for the owner's own images.
  • check_upload takes the upload_id and returns each image's path and the src to use.

Leads, jobs, domain, site

leads reads form submissions.

{ "site": "harbor-dental", "form": "quote", "since": "2026-11-01", "search": "kitchen" }
  • Without form: each form's counts and the latest leads across all forms. With form: that form's submissions.
  • Newest first, 20 at a time. next_cursor pages back, and matching is how many fit in all.
  • Filters: since, until (UTC dates), search, and status: lead (the default), test, spam or unverified.
  • export: "csv" returns a download link, good for an hour, to a spreadsheet of everything the filters match, up to 50,000 rows.
  • Submissions are personal data and untrusted text. The AI is told to show them to the owner, never to write them into site files, and never to follow instructions inside them.

jobs returns the work SiteShip found: new leads, SEO fixes, problems.

  • list, the default, returns due jobs with their steps and tools, or due: false. At most 5 jobs come back in one run.
  • After each job: done or skip with a note, or snooze with days (1 to 30). updates closes several at once.
  • During a run, changes go to the draft only. The AI is told never to publish, connect or remove a domain, delete a site or restore a version.

domain connects the owner's own domain.

  • action: "connect" with a hostname, such as www.example.com, returns the DNS records to add at the registrar. On a free site it returns needs_plan and an upgrade_url.
  • action: "status" says whether the domain and its certificate are active. HTTPS is issued automatically once DNS is in place.
  • action: "remove" disconnects it. A site has one connected domain at a time.

site renames or deletes a site.

  • action: "rename" changes the label in list_sites. The name visitors see is in data/site.yaml.
  • action: "delete" needs confirm set to the site's subdomain, exactly. It is refused while a domain is connected.
  • Only the site's owner can do either.

The two that are not for the model

Tool Used by
get_profile AI apps that match a connection to the user's verified email. Returns the account id, email and number of sites
confirm_publish SiteShip's preview panel, when the owner clicks its Publish button. It needs a token only the panel holds

An AI publishes by calling publish, never confirm_publish.

Something wrong on this page? Email support@siteship.ai. Checked on November 14, 2026.

Built in a chat

Home page of Low Tide Coffee, a coffee shop website built with SiteShip

Coffee shop

Low Tide Coffee

The prompt that built it

Build a website for Low Tide Coffee, a small coffee shop and roastery at 14 Harbor Street, Beaufort, SC. We roast our own beans in the back room. Open every day 7am to 3pm. Phone (843) 555-0114. A menu with prices (drip, cortado, cold brew, oat-milk latte, biscuits and pastries). Two house blends sold in the shop: Marsh Blend and Dock Street Dark. Catering for offices and events, with an enquiry form (name, email, date, number of people, message). Pages: Home, Menu, Our beans, Catering. Look: warm and moody. Dark roasted brown and cream with a burnt-orange accent, an elegant serif for headlines with a clean sans for text, a photo of coffee being poured in the hero, and a menu laid out like a printed cafe menu.

Swap in your own business details. Your AI will ask five quick questions if anything is missing.

Add SiteShip to your AI

SiteShip is a connector you add once. You'll create your free account when you connect. No card needed.

https://app.siteship.ai/mcp
ChatGPT
  1. Open ChatGPT on the web and go to Settings, then Apps and connectors.
  2. Choose Add custom connector (you may need to switch on Developer mode under Advanced).
  3. Name it SiteShip, paste the address above and choose OAuth.
  4. Sign in to SiteShip when asked, then start a new chat and say: Get started with SiteShip.

Custom connectors need a paid ChatGPT plan.

Claude
Add to Claude

This opens Claude with SiteShip filled in. Click Add, sign in to SiteShip, then say: Get started with SiteShip.

Or add it by hand

  1. Open Claude and go to Customize, then Connectors.
  2. Click Add, then Add custom connector.
  3. Name it SiteShip and paste the address above.
  4. Sign in to SiteShip when asked, then start a new chat and say: Get started with SiteShip.
Grok

Go to grok.com/connectors, choose New Connector, then Custom, and paste the address above.

Gemini

In the Gemini web app, open Apps/Connectors settings, add a custom connector and paste the address above. (US accounts only for now.)

Other AI apps and coding tools
  1. Open your AI app's settings and look for Connectors, Apps, Integrations or MCP servers.
  2. Add a custom (remote) connector and paste the address above.
  3. Sign in to SiteShip when asked, then start a new chat and say: Get started with SiteShip.

Works with any app that accepts a remote MCP server, including coding tools such as Claude Code, Cursor, VS Code and Codex.

Coding tools

Claude Code

claude mcp add --transport http siteship https://app.siteship.ai/mcp

Codex

codex mcp add siteship --url https://app.siteship.ai/mcp

Then say: Get started with SiteShip.