Documentation

Welcome to TestStory

Your expert QA agent trained on decades of testing best practices. Generate comprehensive test cases in minutes, not hours.

5 min
Quick Start
10+
Integrations
3
API Protocols

Overview

What is TestStory?

TestStory is an AI-powered platform that automatically generates comprehensive test cases from user stories, requirements, process diagrams, and integration issues. It helps QA teams and developers create thorough test coverage faster and more consistently.

Key Features

  • AI-powered test case generation
  • Process diagram analysis
  • Multiple AI provider support
  • Import from Jira, Linear, GitHub, ClickUp
  • Auto-sync to TestQuality, TestRail, Zephyr
  • RESTful API access
  • MCP for Claude, Cursor, CoPilot, Antigravity, and Codex

Supported AI Providers

  • Anthropic Claude (Sonnet, Opus, Haiku)
  • OpenAI GPT-4 & GPT-3.5
  • TestQuality AI
  • OpenRouter (multi-provider access)

Getting Started

Basic Workflow

Start generating test cases in 4 simple steps

1

Create an Account

Sign up for a free account. You'll receive initial credits to try the platform. The pre-configured free AI provider works great for most users.

2

Enter a Story

Type your user story into the input box, or select one of the example stories to get started quickly.

3

Generate Test Cases

Click the "Generate Test Cases" button and let AI create comprehensive test coverage for your story.

4

Export Your Test Cases

Download your test cases as CSV or PDF for immediate use in your testing workflow.

Explore More

Enhance your test case generation

5

Upload a Process Diagram

Import process diagrams (Visio, PDF, images) to generate test cases from visual workflows.

6

Try Presets & Customize Settings

Use generation presets (basic, comprehensive, exhaustive) or customize test types, coverage levels, and complexity.

Test Case Generation

Manual Story Input

Generate test cases from custom requirements

How to Use:

  1. Navigate to the AI Test Generator page
  2. Enter or paste your user story, requirement, or feature description
  3. Optionally add modifiers to customize generation:
    • Test Types: Functional, Security, Performance, Accessibility
    • Coverage Level: Basic, Standard, Comprehensive, Exhaustive
    • Complexity: Simple, Moderate, Complex
  4. Click "Generate Test Cases"
  5. Review the generated test cases and edit if needed
  6. Export or sync to your test management system

Example Input:

Title: User Login Feature

As a user, I want to login with email and password so that I can access my account.

Acceptance Criteria:
• Valid credentials should log the user in successfully
• Invalid credentials should show an error message
• After 5 failed attempts, the account should be locked
• User should be able to reset password via email

Generation Options & Modifiers

Customize test case generation to your needs

Test Types

Choose which types of tests to generate: Functional, Security, Performance, Accessibility, Integration, or Unit tests.

Coverage Level

Control test depth: Basic (happy path only), Standard (common scenarios), Comprehensive (edge cases), or Exhaustive (all possibilities).

Complexity

Adjust detail level: Simple (concise steps), Moderate (standard detail), or Complex (extensive documentation).

Split Mode

When enabled, generates one test case per scenario. When disabled, combines multiple test scenarios into fewer, consolidated test cases.

Process Diagrams

Diagram-Based Test Generation

Upload process flows and generate test cases automatically

Supported Formats:

Visio files (.vsdx, .vsd)
PDF documents
Images (PNG, JPG, JPEG)
BPMN, flowcharts, swimlanes

How to Use:

  1. Navigate to Process Diagrams page
  2. Click "Upload Diagram" and select your file
  3. Add a title and optional description
  4. The AI will analyze the diagram and extract:
    • Process flows and decision points
    • User interactions and system responses
    • Business logic and validation rules
    • Error handling and edge cases
  5. View the AI's analysis and recommendations
  6. Click "Generate Test Cases" to create comprehensive tests
Best Practices
  • Use clear, readable diagrams with labeled elements
  • Include decision points and alternate flows
  • Add annotations for complex business rules
  • Ensure text in diagrams is legible

Integrations & Import

Jira Integration

Import issues and stories from Jira

Setup Instructions:

  1. Go to Settings → Integrations → Jira
  2. Enter your Jira instance URL (e.g., https://yourcompany.atlassian.net)
  3. Provide your Jira email address
  4. Generate an API token from Jira:
    • Go to Atlassian Account Settings
    • Click Security → API Tokens
    • Create new token and copy it
  5. Paste the API token in TestStory settings
  6. Configure default project and search preferences
  7. Click Save to activate the integration

Linear Integration

Import issues from Linear

Setup Instructions:

  1. Go to Settings → Integrations → Linear
  2. Generate a Personal API Key from Linear:
    • Open Linear Settings → API
    • Click "Create new API key"
    • Copy the generated key
  3. Paste the API key in TestStory settings
  4. Enter your team ID (found in Linear URL)
  5. Click Save to activate the integration

GitHub Integration

Import issues from GitHub repositories

Setup Instructions:

  1. Go to Settings → Integrations → GitHub
  2. Generate a Personal Access Token (classic):
    • Go to GitHub Settings → Developer Settings
    • Click Personal Access Tokens → Tokens (classic)
    • Generate new token with 'repo' scope
    • Copy the token
  3. Paste the access token in TestStory settings
  4. Configure organization and repository settings
  5. Click Save to activate the integration

ClickUp Integration

Import tasks from ClickUp workspaces

Setup Instructions:

  1. Go to Settings → Integrations → ClickUp
  2. Generate an API Token from ClickUp:
    • Open ClickUp Settings → Apps
    • Click "Generate" under API Token
    • Copy the generated token
  3. Paste the API token in TestStory settings
  4. Select your workspace, space, and optionally filter by folders or lists
  5. Configure tag filters to import only relevant tasks
  6. Click Save to activate the integration

Export & Auto-Sync

Test Management Upload Options

Test management integrations (TestQuality, TestRail, Zephyr) support both manual export and automatic sync. You can upload test cases on-demand after generation, or enable auto-sync to automatically push every generated test case to your platform.

Export Formats

Multiple export options for your test cases

Markdown

Export as formatted markdown for documentation

PDF

Generate professional PDF documents

CSV

Import into spreadsheets or other tools

GitHub PR

Create pull request with test cases

Test Management Platforms

Sync test cases to popular platforms

TestQuality

Direct integration with automatic sync support. Configure in Settings to enable one-click upload or auto-sync.

TestRail

Export test cases directly to TestRail sections and suites with full field mapping.

Zephyr

Sync test cases to Zephyr Scale with project and folder selection.

Settings

AI Provider Configuration

Configure your preferred AI providers

  • TestQuality AI: Pre-configured, no API key needed
  • Anthropic Claude: Requires API key from console.anthropic.com
  • OpenAI: Requires API key from platform.openai.com
  • OpenRouter: Multi-provider access with single API key

Default Settings

Configure defaults for test generation

  • Default Integration: Set which platform to import from by default
  • Default Project: Pre-select projects for faster imports
  • Auto-Sync: Enable automatic upload to test management platforms
  • Generation Presets: Save custom generation configurations

Public API

REST API Overview

Programmatically generate test cases from your applications

Authentication

All API requests require an API key passed in the X-API-Key header. Generate your API key in Settings → API.

Base URL

https://teststory.ai/api/v1

Generate Test Cases

POST /api/v1/generate

Generate test cases from a user story or requirement.

Example Request

{
  "story": "As a user, I want to reset my password",
  "options": {
    "testTypes": ["functional", "security"],
    "coverage": "comprehensive"
  }
}

MCP Integration

Model Context Protocol

Use TestStory with Claude, Cursor, CoPilot, Antigravity, and Codex

TestStory supports the Model Context Protocol (MCP) for seamless integration with Claude, Cursor, CoPilot, Antigravity, and Codex. This allows you to generate test cases directly within your AI conversations and development workflows.

Setup Modes

  • Local Mode: Run MCP server locally for Claude Desktop
  • Remote Mode (Claude Desktop): Connect to hosted MCP server
  • Remote Mode (claude.ai): Use with Claude Pro/Team accounts

Available MCP Tools

Tools available through MCP integration

  • generate_test_cases: Generate test cases from user stories
  • preprocess_source_code: Analyze source code for test generation
  • preprocess_diagram: Extract test scenarios from process diagrams
  • preprocess_issue: Process issues from integrated platforms