Cassflow logoCASSFLOW

Getting Started with CassFlow

Set up CassFlow in your IDE in under 10 minutes and start creating automated tests with AI.

Prerequisites

  • One of the supported IDEs: Cursor, Windsurf, or Claude Desktop
  • A CassFlow account (sign up at cassflow.com)

Step 1: Create Your API Key

First, you'll need to generate an API key to authenticate with CassFlow's MCP server.

  1. 1
  2. 2
    Click "Generate New API Key"
  3. 3
    Copy the generated key (it starts with "ck_" and is 32 characters long)
  4. 4
    Store it securely - you'll need it for the IDE configuration

Security Note

Keep your API key secure. It provides access to your CassFlow account and usage will be billed to you.

Step 2: Configure Your IDE

Choose your IDE below for specific setup instructions:

C
Cursor IDE Setup

  1. 1

    Open Cursor and go to Settings → Features → Model Context Protocol

  2. 2

    Click "Add Server" and paste this configuration:

    {
  "name": "cassflow",
  "url": "https://cassflow.com/.well-known/mcp.json",
  "apiKey": "your_api_key_here"
}
  3. 3
    Replace your_api_key_here with your actual API key
  4. 4
    Save the configuration and restart Cursor
  5. 5
    Look for the 🔨 hammer icon in your chat - this means CassFlow tools are available!

W
Windsurf IDE Setup

  1. 1
    Open Windsurf and look for the 🔨 hammer icon in the Cascade panel
  2. 2
    Click the hammer icon and select "Configure MCP Servers"
  3. 3

    Add this server configuration:

    {
  "name": "cassflow",
  "url": "https://cassflow.com/.well-known/mcp.json",
  "apiKey": "your_api_key_here"
}
  4. 4
    Replace your_api_key_here with your actual API key
  5. 5
    Save and restart Windsurf

🤖
Claude Desktop Setup

  1. 1
    Open Claude Desktop and go to Settings → Developer
  2. 2

    Create or edit your MCP config file:

    macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    Windows: %APPDATA%\Claude\claude_desktop_config.json

  3. 3

    Add this configuration to the file:

    {
  "mcpServers": {
    "cassflow": {
      "command": "node",
      "args": ["-e", "require('https').get('https://cassflow.com/.well-known/mcp.json?apiKey=your_api_key_here', r => r.pipe(process.stdout))"],
      "env": {}
    }
  }
}
  4. 4
    Replace your_api_key_here with your actual API key
  5. 5
    Restart Claude Desktop

Step 3: Test Your Connection

Once configured, verify that CassFlow is working correctly:

  1. 1
    Look for the 🔨 hammer icon in your IDE's chat interface
  2. 2
    Try asking: "What CassFlow tools are available?"
  3. 3
    You should see createFlow and runFlow tools listed

Success!

If you see the tools, CassFlow is properly connected and ready to use.

Testing Local Apps (Optional)

Test Your Local Development Server

If you're developing locally (localhost), install our tunnel CLI to make your app accessible to CassFlow:

Install the CLI:

npm install -g cassflow-cli

Create a tunnel to your local app:

cassflow-tunnel --port=3000 --apiKey=your_api_key --projectId=your_project_id

This creates a secure HTTPS tunnel so CassFlow can test your localhost application. The tunnel URL will be automatically used in your flows.

Available Tools & Resources

🔧 Tools

  • createFlow - Generate YAML test flows from natural language
  • runFlow - Execute flows with real-time streaming updates

📊 Resources

  • Projects - Organize your testing efforts
  • Flows - YAML test definitions
  • Runs - Execution history and results
  • RunEvents - Real-time streaming updates

What's Next?

Now that CassFlow is set up, you're ready to start creating automated tests!

Learn to Create FlowsGo to Dashboard