Table of Contents

Installation

Prerequisites

  • HelpMeTest API token (get it from your account settings)
  • One of the supported AI editors:
    • Claude Desktop
    • Cursor
    • VSCode with Claude extension
    • Any MCP-compatible editor

Quick Installation

The installer will:

  1. Detect which AI editors you have installed
  2. Configure MCP integration for each detected editor
  3. Provide setup instructions or open configuration links
  4. Verify the installation

Manual Configuration

If automatic detection doesn't work or you prefer manual setup:

For Claude Desktop:

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

For Cursor:

Add to your Cursor MCP settings (Settings → MCP → Add Server):

After configuration, restart your AI editor for changes to take effect.

Available MCP Tools

Test Management Tools

helpmetest_list_tests

Discovers and lists all available tests in your account.

What your AI can do:

  • List all tests with names, descriptions, and tags
  • Organize tests by category (uptime, API, user journeys, etc.)
  • Filter tests by tags
  • Show test counts and organization
  • Recommend which tests to run for specific scenarios

Example interactions:

helpmetest_run_test

Executes tests by name, ID, or tag and returns detailed results.

Parameters:

  • identifier: Test name, ID, or tag (with tag: prefix)

What your AI can do:

  • Execute individual tests by name
  • Run all tests with a specific tag
  • Execute tests by ID
  • Analyze test results and performance
  • Identify failures and suggest debugging steps
  • Compare results against historical data

Example interactions:

Run by name:

Run by tag:

Run by ID:

Health Check Tools

helpmetest_status_health

Queries health check status for all configured services.

What your AI can do:

  • List all health checks with current status
  • Show last check time and grace periods
  • Identify unhealthy services
  • Explain what each health check monitors
  • Suggest actions for failing checks

Example interactions:

Test Management

Test Organization with Tags

Tags help organize and filter tests for different scenarios:

Common tag patterns:

  • uptime - Service availability and connectivity tests
  • api - API endpoint and backend service tests
  • cuj - Critical user journey and workflow tests
  • keywords - Search and functionality tests
  • docs - Documentation and content tests
  • landing - Landing page and marketing tests
  • flaky - Tests that may be unstable

Using tags effectively:

Pre-Deployment Testing Workflows

Complete pre-deployment check:

Deployment verification:

Health Check Monitoring

Understanding Health Check Status

Health checks report service status through heartbeat signals:

Status indicators:

  • Healthy: Last heartbeat within grace period
  • ⚠️ Warning: Approaching grace period limit
  • Down: Exceeded grace period, no recent heartbeat

Grace periods define how long a service can go without reporting before being marked as down. They vary by service type:

  • Web services: 1-5 minutes
  • API services: 30 seconds - 2 minutes
  • Background workers: 10-15 minutes
  • Batch jobs: Hours to days depending on schedule

Service Health Queries

Advanced Usage Patterns

Performance Analysis

Failure Analysis and Debugging

Intelligent Test Recommendations

Real-Time Execution Monitoring

Real-World Examples

For Developers

Development workflow:

Before demos:

For DevOps Teams

Daily standup prep:

Deployment verification:

For SRE Teams

Incident response:

Performance investigation:

For QA Teams

Test environment validation:

Test execution organization:

Troubleshooting

No Tests Found

Symptom: Your AI reports "You currently have no tests configured"

Causes:

  • No tests have been created in your account yet
  • API token doesn't have access to test data
  • Tests exist but haven't synchronized yet

Solutions:

  1. Verify you have tests created:

    • Check the HelpMeTest web interface
    • Ensure tests are saved and not just drafts
  2. Check API token permissions:

    • Regenerate your API token if needed
    • Update MCP configuration with new token
    • Restart your AI editor
  3. Create a test to verify:

MCP Server Not Responding

Symptom: AI says "I can't access HelpMeTest tools right now"

Causes:

  • MCP server not configured properly
  • CLI not in system PATH
  • API token missing or invalid

Solutions:

  1. Verify CLI installation:

  2. Test MCP server directly:

    Should start the MCP server without errors.

  3. Check MCP configuration:

    • Verify API token in config file
    • Ensure helpmetest command is accessible
    • Restart your AI editor after configuration changes

Test Execution Failures

Symptom: Tests fail unexpectedly or consistently

Debugging steps:

  1. Ask AI to analyze the failure:

  2. Check service dependencies:

  3. Verify test environment:

Performance Issues

Symptom: Tests running slower than expected

Analysis:

Health Check Configuration Issues

Symptom: Health checks showing incorrect status

Common issues:

  1. Grace period too short

    • Services marked down when they're actually healthy
    • Solution: Increase grace period to match service characteristics
  2. Grace period too long

    • Failures not detected quickly enough
    • Solution: Decrease grace period for faster detection
  3. Heartbeat not reporting

    • Health checks never update
    • Solution: Verify the service is calling helpmetest health command

Ask your AI for help:


This completes the technical deep dive. Your AI assistant now has comprehensive capabilities for testing and monitoring. For the high-level overview and quick start guide, see the main MCP Integration guide.

Questions? Email us at contact@helpmetest.com