MCP Server (IDE Integration)
Installation

Installation

Get TestSprite MCP Server up and running in your IDE in under 2 minutes.

Prerequisites

Before installing TestSprite MCP Server, ensure you have:

Get Your API Key

First, you'll need a TestSprite API key for any installation method:

  1. Sign in to your TestSprite Dashboard (opens in a new tab)
  2. Navigate to API Keys under Settings
  3. Click "New API Key"
  4. Copy your API key (you'll need it for installation)

Check Your NodeJS Installation

Before proceeding with installation, verify you have Node.js version 22 or higher:

  1. Open your terminal (PowerShell or Command Prompt on Windows, Terminal on Mac/Linux)
  2. Check your Node.js and npm versions:
node --version
npx --version
  1. Verify Node.js is >= 22 (e.g., v22.1.0) and npx is >= 10 (e.g., 10.2.4)

If you don't have Node.js 22+ and npx 10+ installed:

  • Download the latest version from nodejs.org (opens in a new tab)
  • Install following the installer instructions
  • Restart your terminal and verify again with node --version and npx --version

Note: TestSprite MCP Server requires Node.js 22 or higher to function properly.

One-Click Installation (Cursor)

The easiest way to install TestSprite MCP Server in Cursor:

  1. Get your API key (see above)
  2. Click the one-click install link - Install TestSprite MCP Server
  3. Enter your API key in Cursor
  4. Start testing!

Manual Installation

Configure Your IDE

For Cursor

  1. Open Cursor Settings (cmd/ctrl + shift + j)
  2. Navigate to Tools & Integration
  3. Click Add custom MCP
  4. Add the following configuration:
{
  "mcpServers": {
    "TestSprite": {
      "command": "npx",
      "args": ["@testsprite/testsprite-mcp@latest"],
      "env": {
        "API_KEY": "your-api-key"
      }
    }
  }
}

For Claude Code

  1. Navigate to your project directory in terminal:

    cd /path/to/your/project
  2. Paste the installation command into your terminal:

    claude mcp add TestSprite --env API_KEY=your_api_key -- npx @testsprite/testsprite-mcp@latest
  3. Replace your_api_key with your actual TestSprite API key

  4. Run the installation command

  5. Verify the installation by running this command in your project directory:

    claude mcp list

    You should see:

    TestSprite: npx @testsprite/testsprite-mcp@latest - ✓ Connected

    Note: Installing the MCP server this way adds TestSprite only to Claude Code under the current project directory. If you're using Claude Code in another project directory, you'll need to add the MCP server again. For installing the MCP server under different scopes (e.g. global), refer to the Claude Code MCP documentation (opens in a new tab).

For VSCode

  1. Open the Command Palette (cmd/ctrl + shift + p)
  2. Run the MCP: Add Server command
  3. Choose Command (stdio) installation type
  4. Type npx @testsprite/testsprite-mcp@latest for Command to run
  5. Type TestSprite for the MCP server identifier/name
  6. Choose the scope where you want the MCP server to be configured
  7. Add the env configuration:
{
  "mcpServers": {
    "TestSprite": {
      "command": "npx",
      "args": ["@testsprite/testsprite-mcp@latest"],
      "env": {
        "API_KEY": "your-api-key"
      }
    }
  }
}

For Other MCP-Compatible IDEs

Add this configuration to your MCP settings:

{
  "mcpServers": {
    "TestSprite": {
      "command": "npx",
      "args": ["@testsprite/testsprite-mcp@latest"],
      "env": {
        "API_KEY": "your-api-key"
      }
    }
  }
}

Installation Verification

For Cursor

Check if the green dot shows up on the TestSprite MCP server icon, and the tools have been loaded successfully.

For VSCode

After installation, click the start button above the TestSprite MCP entry in the mcp.json file you have jsut confifured. If the server started with no errors and all the tools have been loaded, you have installed the MCP server successfully.

Success Indicators

check_circle Your AI assistant can see TestSprite MCP tools
check_circle No "command not found" errors
check_circle Ready to start testing your projects

Quick Test

Try prompting: "Help me test this project with TestSprite" - your assistant should offer to use TestSprite MCP tools.

Uninstallation

To remove TestSprite MCP Server:

  1. Remove the configuration from your IDE's MCP settings
  2. Restart your IDE

Next Steps

check_circle Installation Complete!

Now you're ready to run your first test. Continue to Your First Test to see TestSprite MCP Server in action.