MCP Integration Guide

ShipKit exposes 30 MCP tools via a single HTTP endpoint. Connect your AI coding tool and control your SaaS operations through natural language.

Getting Your API Key

1. Sign in to your ShipKit dashboard
2. Go to Settings > API Keys
3. Click Create API Key, give it a name
4. Copy the key (shown only once) — it looks like sk_xxxxxxxxxxxxxxxx

Configuration

Claude Code / Cursor / Windsurf

Add to your project's .mcp.json:

{
  "mcpServers": {
    "shipkit": {
      "type": "http",
      "url": "https://your-shipkit-url/api/mcp",
      "headers": {
        "Authorization": "Bearer skyourapi_key"
      }
    }
  }
}

Alternative (URL param, deprecated but supported):

{
  "mcpServers": {
    "shipkit": {
      "type": "http",
      "url": "https://your-shipkit-url/api/mcp?apikey=skyourapikey"
    }
  }
}

Authentication

All tools/call requests require a valid API key. The key is validated and usage is incremented on each call.

---

MCP Tools Reference

Screenshot Tools

shipkitcreateproject

Create a new monitoring project.

Returns: Project object with id, name, baseurl, createdat.

---

shipkitaddconfig

Add a screenshot configuration to a project.

Returns: Config object with id, name, url, and all settings.

---

shipkit_capture

Capture a screenshot, compare with previous, optionally run AI analysis.

Returns: Capture result with captureid, imageurl, diff, ai_analysis.

---

shipkit_compare

Compare two captures and return visual diff results.

Returns: Diff result with changepercentage, changedpixels, diffimageurl, ai_analysis.

---

shipkitgetcaptures

Get historical captures for a screenshot config.

Returns: Array of capture objects ordered by most recent first.

---

AI Analysis Tools

shipkitanalyzechanges

AI analysis of visual changes between two screenshots.

Returns: { summary, severity, changes[], suggestions[] }

---

shipkitdiscoverpages

Crawl a website and find all important pages.

Returns: Array of discovered pages with url, title, importance_score.

---

shipkitcheckfreshness

Check which screenshot configs have stale captures.

Returns: Array of configs with isstale, lastcapturedat, hourssince_capture.

---

Documentation Tools

shipkitgeneratedocs

Generate a complete documentation suite from a URL.

Returns: Generated doc object with id, sections[].

---

shipkitupdatedocs

Check for changes and update documentation accordingly.

Returns: Update report with changesdetected, sectionsupdated[].

---

shipkittranslatedocs

Translate generated documentation to another language.

Returns: Translated doc object with id, language, sections[].

---

Publishing Tools

shipkitgetembed_url

Get a permanent public URL that always shows the latest screenshot.

Returns: { embed_url, token }

---

shipkitpublishto_github

Publish docs to a GitHub repo as a pull request.

Returns: { prurl, branchname, files_created }

---

shipkitpublishto_notion

Publish docs to a Notion workspace.

Returns: { pageids[], notionurl }

---

shipkitpublishto_gitbook

Publish docs to a GitBook space.

Returns: { spaceurl, pagescreated }

---

SaaS Maintenance Tools

shipkitgeneratechangelog

Generate a changelog from GitHub commits.

Returns: Structured changelog with entries[].

---

shipkitseoscan

Run an SEO analysis on a URL.

Returns: SEO report with score, issues[], recommendations[].

---

shipkitstatuscheck

Check service health and availability.

Returns: { status, version, aienabled, billingenabled }

---

Account Tools

shipkit_usage

View current month usage stats.

Returns: { plan, capturesused, captureslimit, mcpcallsused, mcpcallslimit }

---

shipkit_projects

List all projects owned by the authenticated user.

Returns: Array of projects with id, name, configcount, lastcapture_at.

---

Launch & Promote Tools

shipkitoptimizelanding

Analyze a landing page and return structured data for optimization.

Returns: { headings[], ctas[], metatags, contentblocks[], performance_hints[] }

---

shipkitscanlegal_data

Scan a product page for data collection patterns to draft legal documents.

Returns: { forms[], cookies[], thirdpartyscripts[], datacollectionpatterns[] }

---

shipkitfetchph_data

Extract product data for Product Hunt launch materials.

Returns: { productname, tagline, description, features[], screenshoturls[] }

---

shipkitfetchsocial_data

Get product info with platform-specific formatting guidelines.

Returns: { productinfo, platforms: { [name]: { charlimit, tone, format, guidelines } } }

---

shipkitfetchcomparison_data

Fetch your product and competitor data for comparison content.

Returns: { your_product, competitors[] }

---

shipkitgetlaunch_calendar

Get a launch calendar template with a 4-week timeline.

Returns: { platforms[], timeline[] }

---

Email & Support Tools

shipkitsearchdocs

Search hosted docs for building AI-powered support bots.

Returns: Array of { page_title, excerpt, path }.

---

shipkitgetwidget_code

Get embeddable JavaScript widget code for AI doc search on your website.

Returns: { scripttag, widgethtml }

---

Common Scenarios

1. "Generate documentation for my website"

Tell Claude:

"Use ShipKit to generate docs for https://myapp.com"

Claude will call:

1. shipkitdiscoverpages — find all important pages
2. shipkitgeneratedocs — generate full documentation
3. shipkitpublishto_github — publish as a PR to your repo

2. "Prepare my Product Hunt launch"

Tell Claude:

"I'm launching https://myapp.com on Product Hunt next Tuesday. Help me prepare."

Claude will call:

1. shipkitfetchph_data — extract product info and screenshots
2. shipkitgetlaunch_calendar — get a 4-week timeline
3. shipkitfetchsocial_data — get guidelines for each platform

Then Claude writes your tagline, description, first comment, and social posts using the returned data.

3. "Monitor my product for visual changes"

Tell Claude:

"Set up screenshot monitoring for https://myapp.com — track the homepage, pricing page, and docs."

Claude will call:

1. shipkitcreateproject — create a monitoring project
2. shipkitaddconfig (x3) — add configs for each page
3. shipkit_capture (x3) — take initial screenshots

4. "Write a Twitter launch post"

Tell Claude:

"Write a Twitter post announcing https://myapp.com"

Claude will call:

1. shipkitfetchsocial_data with platforms: ["twitter"] — get product info + Twitter guidelines

Then Claude writes the post using the returned data and platform constraints.

5. "Check my landing page"

Tell Claude:

"Analyze my landing page at https://myapp.com and suggest improvements"

Claude will call:

1. shipkitoptimizelanding — get structured page data
2. shipkitseoscan — check SEO issues

Then Claude provides optimization suggestions based on the returned data.

---

Protocol Details

ShipKit implements MCP over HTTP using JSON-RPC 2.0.

Endpoint: POST /api/mcp Supported methods:

• initialize — handshake, returns server info and capabilities
• notifications/initialized — client acknowledgment
• tools/list — returns all 30 tool definitions (no API key validation)
• tools/call — execute a tool (requires valid API key, increments usage)

Rate limit: 60 requests/minute per IP. Example raw request:

curl -X POST https://your-shipkit-url/api/mcp \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer skyourapi_key" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "shipkit_usage",
      "arguments": {}
    }
  }'

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{ \"plan\": \"pro\", \"capturesused\": 42, \"captureslimit\": 500 }"
      }
    ]
  }
}