1. MCP Server
  • Getting Started
  • Locations
    • Location Attributes
      MARKDOWN
    • Photo specifications for your business location
      MARKDOWN
    • Star and Unstar Photos
      MARKDOWN
    • Create a new business location
      POST
    • Update business location
      POST
    • List all locations
      GET
    • List particular locations
      GET
    • Search locations
      GET
    • Get locations by store codes
      GET
    • Get Photos by Location IDs
      GET
    • Upload Photos to a Location
      POST
    • Check Bulk Photo Upload Status
      GET
    • Star/Unstar Location Photos
      POST
    • Delete Location Photos
      POST
    • Archive multiple locations
      POST
    • Cancel scheduled location archival
      POST
    • Activate archived locations
      POST
    • List Active Subscriptions
      GET
    • Get a list of supported countries and their states
      GET
    • Get SubCategories and AdditionalCategories
      GET
    • Get Site Details for Your Plan
      GET
    • Location Indexing Rate
      GET
  • Organizing locations
    • Organizing locations
      MARKDOWN
    • Create a new folder
      POST
    • List all folders
      GET
    • List all folders under an account in hierarchical structure
      GET
    • Get details of a folder
      GET
    • Rename a folder
      POST
    • Add locations to a folder
      POST
    • Remove locations from a folder
      POST
    • Delete a folder
      POST
    • List locations under a folder
      GET
    • List all tags
      GET
    • List locations by tags
      GET
    • Add location to a tag
      POST
    • Remove location from a tag
      POST
  • User Management
    • User Attributes
    • Create User with Role
    • List Users
    • List Users by ID
    • Add Locations to User
    • Add User and folder
    • List User Roles
    • Add folders to user
    • List User Resources
    • Update a User
    • Remove Folders for User
    • Remove Locations for User
  • Grid Rank
    • Local Rank Grid
    • Create Rank Grid Report
    • Fetch All Grid Reports for Location
    • Fetch Rank Grid Report By ID
  • Review Campaigns
    • Review Campaign Info Attributes
    • Create a review campaign
    • Add customers to a review campaign
    • List review campaigns
    • List review campaign customers
  • Listings
    • Listings
    • Listing Status Webhooks
    • Get premium listings
    • Get voice listings for a location
    • Get duplicate listings for a location
    • Get all duplicate listings for an account
    • Mark listings as duplicates
    • Mark listings as not duplicates
    • Get AI listings
  • Connected Accounts
    • Connected Accounts
    • Connect Google Profile to Account
    • Connect Facebook Page to Account
    • List all connected accounts
    • List folders under a Google account
    • Create GMB Listing
    • Disconnect GMB Profile
    • Disconnect Facebook Account
    • Fetch Connected Account Details
    • Trigger New Matches
    • List Connection Suggestions
    • Fetch Connected Account Listings
    • Confirm Connected Account Matches
    • Connect a location with a listing of a connected account
    • Disconnect Location from Listing
    • create location from connected account listing
  • Rankings
    • Rankings Analytics Attributes
    • Add keywords
    • List Keywords
    • Get keywords performance
    • Archive a keyword
    • Get Rollup Keyword Performance
    • Get Rankings Distribution By Time
  • Profile Analytics
    • Profile Analytics
    • Get Bing Analytics
    • Get Facebook Page Analytics
    • Get Google My Business Analytics
  • Reviews
    • Reviews
    • Review Sources
      • Get a list of interaction sources for location
      • Get a list of interaction sources for account
      • Add / Edit interaction source
    • Fetch all interactions
    • List Interactions by IDs
    • Respond to an Interaction
    • Edit Response for Interaction
    • Archive Response for Interaction
    • Get Interaction Analytics
    • Add Review Widget
    • Edit Review Widget
    • Rollup Review API
  • Automations
    • Temporary Close Location with a reopening date
  • Error Codes
    • ERROR CODES
  • MCP Server
    • Synup MCP
  • Schemas
    • Schemas
      • FolderSchema
        • Schemas
          • ListFoldersResponse
          • FolderInfo
      • LocationResponseSchema
      • LocationResponseErrorSchema
      • SubCategory
      • SubscriptionsResponse
      • CreateFolderRequest
      • FolderNode
      • ListingsResponse
      • LocationListResponse
      • ConnectGoogleInput
      • ConnectFacebookInput
      • DisconnectGoogleRequest
      • TriggerMatchesRequest
      • FetchListingsRequest
      • ConfirmMatchesRequest
      • ConnectListingRequest
      • DisconnectListingRequest
      • ConnectedAccountDetailsResponse
      • ConnectionSuggestionsResponse
      • Keyword
      • Keyword
      • Keyword
      • UnauthorizedError
      • UnauthorizedError
      • UnauthorizedError
      • UnauthorizedError
      • InsightMetric
      • InsightMetric
      • CreateGridReportInput
      • AllGridReportsResponse
      • GridReportResponse
      • CreateUserInput
      • UsersResponse
      • UsersResponse
      • UsersByIdsResponse
      • AnalyticsOverview
      • Interaction
      • Interaction
      • InteractionsResponse
      • ResponseInteraction
      • AddLocationsInput
      • UserRole
      • UserRole
      • CreateReviewCampaignRequest
      • ReviewCampaignsResponse
      • ReviewCampaignCustomersResponse
      • PremiumListing
      • Subscription
      • CreateFolderResponse
      • Listing
      • ConnectGoogleResponse
      • ConnectFacebookResponse
      • DisconnectGoogleResponse
      • ConnectedAccount
      • TriggerMatchesResponse
      • ConfirmMatchesResponse
      • ConnectListingResponse
      • DisconnectListingResponse
      • Error
      • Error
      • BadRequestError
      • BadRequestError
      • BadRequestError
      • NotFoundError
      • UnauthorizedError
      • UnauthorizedError
      • CreateGridReportResponse
      • GridReport
      • GridReport
      • CreateUserResponse
      • PageInfo
      • PageInfo
      • UserDetail
      • AnalyticsTimeline
      • Response
      • Response
      • PageInfo
      • AddLocationsResponse
      • Pagination
      • Pagination
      • CustomerInput
      • ReviewCampaign
      • ReviewCampaignInfo
      • Tag
      • SearchResponse
      • LocationPhoto
      • CustomAttribute
      • Folder
      • Site
      • ConnectedAccountsResponse
      • LocationListing
      • ListingRecord
      • ConnectionSuggestion
      • NotFoundError
      • NotFoundError
      • RankPoint
      • RankPoint
      • CreatedUser
      • UserEdge
      • UserEdge
      • SiteWiseAnalytics
      • InteractionEdge
      • LocationAddStatus
      • LandingPageTemplate
      • EmailTemplate
      • ReviewCampaignCustomer
      • LocationEdge
      • Error
      • FetchListingsResponse
      • LocationInfo
      • User
      • User
      • MetricWithDelta
      • Interaction
      • EmailTemplate
      • SmsTemplate
      • SuggestedLocationInfo
      • SMSTemplate
      • CampaignStat
      • PageInfo
      • ReviewSite
      • BusinessHours
      • AddCustomersRequest
    • Business hours
    • paymentMethods
    • Contact Support
  1. MCP Server

Synup MCP

Introduction#

Synup MCP provides a unified Model Context Protocol (MCP) interface to manage locations, reviews, social media, rankings, and campaigns through AI agents.

What is MCP?#

MCP (Model Context Protocol) is an open standard that enables AI assistants to connect directly to external data sources and tools through a secure, standardized interface. Synup MCP gives you secure, authenticated access to your Synup data through natural language, enabling AI assistants (such as Claude Code, Cursor, Windsurf) to retrieve location details, analyze ranking performance, review citation status, and generate insights directly from your account. The connection is HTTP streamable and authenticated via headers.

Core Details#

Endpoint: https://mcp-agent.synup.com/mcp
Protocol: Model Context Protocol (MCP) - HTTP Streamable
Authentication: API Key + Access Mode Headers
Tools Available: 120+ total
Supported Assistants: Claude Code, Cursor, Windsurf

Getting Started#

Before You Begin#

Ensure you have:
✅ An active Synup account
✅ An API key (from Settings → Integrations)
✅ One of these installed: Claude Code, Cursor, or Windsurf

Claude Code#

Run this command in your terminal:
After this open Claude Code and run /mcp to activate the MCP server.
Replace YOUR_API_KEY_HERE with your API key from Settings → Integrations.

Cursor#

One-click install: Add Synup MCP to Cursor
Manual config — Edit ~/.cursor/mcp.json:
{
  "mcpServers": {
    "synup": {
      "url": "https://mcp-agent.synup.com/mcp",
      "type": "http",
      "headers": {
        "X-api-key": "YOUR_API_KEY_HERE",
        "X-access-mode": "write"
      }
    }
  }
}

Windsurf#

Manual config:
macOS/Linux: ~/.codeium/windsurf/mcp_config.json
Windows: %USERPROFILE%\.codeium\windsurf\mcp_config.json
{
  "mcpServers": {
    "synup": {
      "url": "https://mcp-agent.synup.com/mcp",
      "type": "stdio",
      "disabled": false,
      "headers": {
        "X-api-key": "YOUR_API_KEY_HERE",
        "X-access-mode": "write"
      }
    }
  }
}
Activate & Test
Replace YOUR_API_KEY_HERE with your API key from Settings → Integrations, then restart your AI editor. You're ready to start using Synup MCP!

Authentication#

How to Authenticate#

Every request must include two required headers:
HeaderTypeDescription
X-api-keystringAPI key from Settings → Integrations
X-access-modeenumwrite (full access) or read (query-only)

Getting Your API Key#

1.
Log in to your Synup account
2.
Navigate to Settings → Integrations
3.
Create a new API Key or copy your existing key
4.
Keep it secure (treat like a password)

Access Modes#

write — Full read/write access (create, update, delete operations)
read — Query-only access (recommended for testing)

What Can You Do?#

Synup MCP enables you to leverage your Synup data through conversational AI. Here's what you can accomplish:
Location Management — Query, filter, and manage your business locations
Review Management — Pull reviews from all platforms, respond at scale, track sentiment
Keyword Tracking — Monitor rankings across Google Search and Maps
Geographic Visibility — Analyze grid-based local search presence
Citations — Check publisher listings, identify inconsistencies, index/ citations
Review Campaigns — Create and launch email/SMS campaigns to collect reviews
Social Media — Post to Google Business Profile and Facebook, schedule content
Competitive Intelligence — Compare rankings, reviews, and engagement vs. competitors
Portfolio Insights — Compare performance across all locations, identify priorities
Reporting — Generate performance summaries and actionable reports

Example Prompts#

Use these prompts to quickly get started with the Synup MCP. Copy and paste into Claude Code, Cursor, or Windsurf.
1.
Review Monitoring & Response
Agent monitors reviews across Google, Facebook, Yelp. It drafts on-brand replies, flags critical reviews in Slack, and tracks sentiment trends over time.
2.
Grid Rank Action Plan
Agent scans heat-maps across all locations, identifies underperforming geographic zones, auto-adds target keywords to tracking, and schedules social posts in weak zones to boost visibility.
3.
Social Media Automation
Agent pulls event info from your calendar, drafts location-specific copy, routes to Slack for approval, then publishes across channels on schedule.
4.
Review Campaign Triggers
Agent reads transaction data from CRM or Google Sheets, segments customers by purchase type, launches targeted campaigns, tracks conversion, and reports results in Notion.
5.
Competitive Intelligence
Agent tracks competitor rankings, review velocity, and posting frequency. It alerts you when competitors change strategy and suggests counter-moves.

Troubleshooting Tips#

API key not working?
Verify the header format is exact: X-api-key: YOUR_KEY (no extra spaces). Regenerate the key in Settings → Integrations if unsure.
MCP server won't connect?
Check that the URL is https://mcp-agent.synup.com/mcp and restart your AI editor after updating config.
Getting empty results?
Confirm the location ID exists by running get_all_locations. Location IDs are Base64 strings like Location:12345.
Queries timing out?
For 100+ locations, use pagination with the after cursor or query smaller date ranges (7 days vs 90 days).
Headers not recognized?
Verify JSON syntax in your config file (missing commas or quotes cause parse errors). Restart the MCP server after edits.
Only partial data returned?
Check pagination. Large result sets return first 50 by default—use the after cursor from pageInfo to fetch the next page.
Authentication failures on reconnect?
Restart your IDE completely, not just the editor window. Config changes sometimes require a full restart.

Ready to get started? Install Synup MCP, authenticate with your API key, and begin automating your local business management with AI.
Modified at 2026-04-08 17:55:54
Previous
ERROR CODES
Next
ListFoldersResponse
Built with