Skip to main content
By the end of this guide, you’ll have run your first automated test suite, seen AI generate comprehensive test plans, watched tests execute in the cloud, received detailed test reports, and applied automatic bug fixes.
Before starting, ensure you have TestSprite MCP Server installed and your IDE open.

​
Step 1: Prepare Your Project

Start Your Application - Make sure your application is running locally:
Example
# For frontend applications (examples)
npm run dev          # Usually runs on port 3000, 5173, or 8080
 
# For backend applications (examples)
node index.js        # Usually runs on port 8000, 3001, or 4000
Project Structure Example
my-project/
├── frontend/          # React, Vue, Angular, etc.
│   ├── src/
│   ├── package.json
│   └── ...
├── backend/           # Node.js, Python, etc.
│   ├── app.py
│   ├── requirements.txt
│   └── ...
├── README.md
└── package.json

​
Step 2: The Magic Command

Open your IDE Chat and follow these steps:
  1. Open a new chat window in your IDE
  2. Type the magic command:
Can you test this project with TestSprite?
  1. Drag and drop your project folder into the chat if you’d like to test a specific sub-project
  2. Press ⇧ Enter
That’s it! Your AI assistant will now take over and guide you through the entire testing process.

​
Step 3: Configuration (Required)

config
The Testing Configuration page will open in your browser. Complete the setup here to continue your test.
When the bootstrap tool opens, you must configure:
  1. Testing Type
type
  • Frontend: Select this if you want to test your UI and user flows (e.g. buttons, forms, navigation).
  • Backend: Select this if you want to test your APIs, services, or server logic.
  1. Test Account Credentials - If your app requires login:
credential
Crediential Examples
  Username: [email protected]
  Password: your-test-password
  1. Application URLs:
portal
URL Examples
Frontend: http://localhost:5173
Backend: http://localhost:4000
  1. Product Requirements Document
prd
Upload existing PRD (required). Even a draft or low-quality PRD is fine. TestSprite AI will generate a normalized PRD based on your upload.

​
Step 4: The Automated Workflow

Your AI assistant will automatically handle the entire testing process by running through these steps. It takes care of everything from understanding your project to running the actual tests, so you don’t have to do any of the work manually. Learn more about details steps at Testing Workflow.

​
Step 5: Review Test Results

After testing, you’ll find these files in your project:
Expandable After Testing Project Structure Example
testsprite_tests/
├── tmp/
│   ├── prd_files/                 # Uploaded PRD files
│   ├── config.json               # Test configuration
│   ├── code_summary.json         # Code analysis
│   ├── report_prompt.json        # AI analysis data
│   └── test_results.json         # Detailed test results
├── standard_prd.json             # Normalized PRD
├── TestSprite_MCP_Test_Report.md # Human-readable report
├── TestSprite_MCP_Test_Report.html # HTML report
├── TC001_Login_Success_with_Valid_Credentials.py
├── TC002_Login_Failure_with_Invalid_Credentials.py
└── ...                           # Additional test files
Understanding Test Results - The test report shows overall coverage, pass rate, failed tests with detailed failure analysis, and categories (Functional, UI/UX, Security, Performance).

​
Step 6: Automatic Bug Fixes

Request Fixes - After reviewing the test results, simply ask: 
Please fix the codebase based on TestSprite testing results.
The AI will analyze failing tests, identify problematic code sections, apply targeted fixes automatically, re-run tests to verify fixes, and iterate until issues are resolved.

​
Example Output

Test Plan Generated:
Expandable Test Plan Example
{
  "testCases": [
    {
      "id": "TC001",
      "title": "User Authentication Login",
      "description": "Test user login with valid credentials",
      "category": "Functional",
      "priority": "High",
      "steps": [
        "Navigate to login page",
        "Enter valid username and password",
        "Click login button",
        "Verify successful login"
      ]
    }
    // ... 17 more test cases
  ]
}
Test Report Summary:
Expandable Test Report Summary Example
{
  "summary": {
    "totalTests": 18,
    "passed": 12,
    "failed": 6,
    "passRate": "67%",
    "coverage": "85%"
  },
  "failures": [
    {
      "testId": "TC005",
      "title": "Admin Panel Access",
      "error": "Button not found: #admin-delete-btn",
      "recommendation": "Add missing delete button in admin panel"
    }
  ]
}

​
Tips for Success

Frontend and backend should be accessible on standard ports
Include README with setup instructions and descriptive folder names
Prepare test user accounts with non-production data
Check the generated PRD and test plan for accuracy

​
Next Steps

Congratulations! You’ve successfully run your first automated test with TestSprite MCP Server.

Complete Testing Workflow

Understand the full process

View Examples

See real-world use cases

Join Discord

Get help and share experiences

Contribute on Github

Contribute and report issues