Zuper's Model Context Protocol (MCP) Server

Zuper offers a Model Context Protocol (MCP) server enabling AI assistants and other applications to access the Zuper platform from beyond the Zuper interface. This server provides a way to interact with your Zuper workspace through various AI platforms and tools that support MCP.

Available Tools

Zuper MCP server offers over 15+ tools including:

Job Tools

• list_jobs - List and filter jobs in Zuper with advanced filtering capabilities
• get_job_details - Get details of a specific job by ID
• update_job - Update an existing job
• get_job_notes - Get notes for a specific job by job UID with optional sorting
• list_job_categories - List all job categories with UIDs, statuses, and settings
• get_job_category - Get details of a specific job category by category UID

Invoice Tools

• list_invoices - List and filter invoices in Zuper using advanced filter rules
• get_invoice_details - Get details of a specific invoice by ID
• update_invoice - Update an existing invoice

Estimate Tools

• list_estimates - List and filter estimates in Zuper using advanced filter rules
• get_estimate_details - Get details of a specific estimate by ID
• update_estimate - Update an existing estimate

Analytics Tools

• get_job_team_stats - Get job team statistics for a specified date range
• get_job_stats_status_generic - Get generic job status statistics for a specified date range
• get_job_stats_category - Get job statistics by category for a specified date range

Connecting to Zuper MCP Server

You can connect to our MCP server natively via Claude Integration, or by using the mcp-remote module in Cursor, Windsurf, and other MCP compatible clients. Zuper MCP server is available at: https://mcp.zuperpro.com/sse

Our MCP Server requires authentication with your Zuper account to use. When connecting, you will be prompted to authorize the application to access your Zuper data. You can also connect by sending authorization headers under x-api-key to the MCP server.

Setup Instructions

Cursor

1. Open Cursor Settings - CTRL/CMD + Shift + J
2. Select MCP
3. Click on Add new global MCP server
4. Add the following

{
  "mcpServers": {
    "zuper": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.zuperpro.com/sse", "--header", "x-api-key: ${ZUPER_API_KEY}", "--header", "x-account-region: ${ZUPER_API_REGION}"],
      "env": {
        "ZUPER_API_KEY": "...",
        "ZUPER_API_REGION": "..."
      }
    }
  }
}

Note: If MCP is not working for you, please check the Cursor version you are using. Some Cursor versions have known issues with MCP server connectivity and tool discovery. We recommend using Cursor v2.2, which works reliably. Until Cursor resolves this issue, you may need to downgrade.

Windsurf

1. Open Windsurf Settings - CTRL/CMD + Shift + J
2. Go to Cascade -> MCP servers
3. Click on Add Server -> Add custom server
4. Add the following,

{
  "mcpServers": {
    "zuper": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.zuperpro.com/sse", "--header", "x-api-key: ${ZUPER_API_KEY}", "--header", "x-account-region: ${ZUPER_API_REGION}"]
    },
    "env": {
      "ZUPER_API_KEY": "...",
      "ZUPER_API_REGION": "..."
    }
  }
}

ChatGPT Agent

1. Step 1: Create a Workflow

   Visit OpenAI Agent Builder and create a new workflow.

2. Configure the “My Agent” Node

   Select the "My agent" node and configure it to connect with the Zuper MCP Server. (Refer to pictures below)

3. Step 3: Enter Connection Details

   You’ll be prompted to provide the following information (Refer below picture):

URL: https://mcp.zuperpro.com/sse
Label: Zuper_MCP
Description: Zuper MCP Server
Authentication: Custom Headers

Under Custom Headers, add the following key-value pairs:

Available Regions: us-west-1c, us-east-1, ap-south-1, ap-southeast-2, eu-central-1

To determine which region applies to your account, please refer to the documentation below: https://developers.zuper.co/docs/getting-started#what-is-my-base-api-url

The API response includes a field named dc_name, which represents your data center region (for example, us-west-1c).
Use this value when setting up MCP.

4. Step 4: Complete Connection

   Once configured, your agent will successfully connect to Zuper MCP.

Troubleshooting

• If authentication fails, ensure you are using the correct header names — x-api-key and x-account-region
• If authentication fails, ensure your API key is valid & API region is set right
• Ensure your MCP client supports SSE-based servers (not Streamable HTTP)
• Check that your client can handle header based authentication flows
• As of now Zuper MCP is not supported in Claude.ai