@testdriverai/mcp 7.10.0-canary.0 → 7.10.1-test

package/docs/v7/copilot/auto-healing.mdx

@@ -1,23 +1,168 @@
 ---
-title: "Auto-Healing Tests"
-sidebarTitle: "Auto-Healing"
-description: "Set up automatic test repair in CI using GitHub Copilot and TestDriver"
-icon: "bandage"
+title: "Prevent"
+sidebarTitle: "Prevent"
+description: "Catch regressions automatically with CI, auto-healing, and GitHub integration"
+icon: "shield-check"
 ---
 
-Auto-healing tests automatically fix themselves when your application changes. By integrating GitHub Copilot with TestDriver in your CI pipeline, you can have AI investigate test failures and propose fixes.
+Prevent regressions by letting TestDriver run and repair itself on every change. Once you've [explored](/v7/generating-tests), [taught it your app](/v7/caching), [run it](/v7/copilot/running-tests), [validated outcomes](/v7/making-assertions), [adapted to your UI](/v7/performing-actions), and learned to [debug with screenshots](/v7/debugging-with-screenshots), the last step is closing the loop: wire TestDriver into your pull requests so regressions never reach production.
 
-## How It Works
+Your AI agent can run tests on every PR, investigate failures, and propose fixes — and you can drive all of it from GitHub itself, whether you're at your desk or on your phone.
+
+## Use TestDriver in GitHub
+
+TestDriver works directly in GitHub's web interface and mobile app. The same MCP server that powers VS Code integration also works in GitHub, letting you create and manage tests from anywhere.
+
+### How It Works
+
+When you add a TestDriver agent file to your repository at `.github/agents/testdriver.agent.md`, GitHub Copilot can use TestDriver's MCP tools directly in:
+
+- GitHub.com (web browser)
+- GitHub Mobile app (iOS/Android)
+- Pull request conversations
+- Issue comments
+
+### Using TestDriver in GitHub Web
+
+<Steps>
+  <Step title="Navigate to Your Repository">
+    Open your repository on GitHub.com. Make sure you have the TestDriver agent file at `.github/agents/testdriver.agent.md`.
+  </Step>
+
+  <Step title="Start a Copilot Chat">
+    Click the **Copilot icon** in the GitHub interface to open a chat. You can find this in:
+    - The repository's Code tab
+    - Pull request pages
+    - Issue pages
+  </Step>
+
+  <Step title="Invoke the TestDriver Agent">
+    Start your message with `@testdriver`:
+
+    ```
+    @testdriver Create a test that verifies the homepage loads correctly at https://myapp.com
+    ```
+
+    The agent will spawn a sandbox environment and begin executing, just like in VS Code.
+  </Step>
+
+  <Step title="View Screenshots in Chat">
+    As the test runs, screenshots appear directly in the chat. You can see what the AI sees and provide guidance if needed.
+  </Step>
+</Steps>
+
+### Creating Tests from PR Comments
+
+You can create tests directly from pull request reviews. Comment on a PR and mention Copilot:
+
+```
+@copilot create a TestDriver test that verifies this new feature works.
+Test the checkout flow with a guest user.
+```
+
+Copilot will:
+1. Use the TestDriver MCP server
+2. Create a test based on your description
+3. Commit the test file to the PR branch
+
+This is useful for:
+- Adding test coverage during code review
+- Verifying bug fixes before merging
+- Creating regression tests for new features
+
+### Creating Tests from Issues
+
+You can also create tests from issue comments:
+
+```
+@copilot Use TestDriver to create a test that reproduces this bug.
+Navigate to /settings, change the theme, and verify it persists after refresh.
+```
+
+The test will be created in a new branch and linked to the issue.
+
+### Mobile App Support
+
+The GitHub Mobile app supports Copilot chat, which means you can use TestDriver from your phone:
+
+1. Open the GitHub app
+2. Navigate to your repository
+3. Tap the Copilot icon
+4. Type `@testdriver` followed by your request
+
+Screenshots and test progress appear in the chat, letting you create and debug tests on the go.
+
+### Example: PR Review Workflow
+
+Here's a complete workflow for adding tests during code review:
+
+<Steps>
+  <Step title="Developer Opens PR">
+    A developer opens a pull request with a new feature.
+  </Step>
+
+  <Step title="Reviewer Requests Tests">
+    The reviewer comments:
+    ```
+    @copilot Create a TestDriver test for this user registration flow.
+    Test both successful registration and validation errors.
+    ```
+  </Step>
+
+  <Step title="Copilot Creates Tests">
+    Copilot spawns TestDriver, creates the tests, and commits them to the PR branch.
+  </Step>
+
+  <Step title="Tests Run in CI">
+    The new tests run automatically in CI, validating the feature works as expected.
+  </Step>
+</Steps>
+
+### Agent File Reference
+
+The agent file at `.github/agents/testdriver.agent.md` contains the configuration for GitHub Copilot to use TestDriver. Here's the structure:
+
+```yaml
+---
+name: testdriver
+description: An expert at creating and refining automated tests using TestDriver.ai
+mcp-servers:
+  testdriver:
+    command: npx
+    args:
+      - -p
+      - testdriverai
+      - testdriverai-mcp
+    env:
+      TD_API_KEY: ${TD_API_KEY}
+---
+
+# TestDriver Expert
+
+You are an expert at writing automated tests using TestDriver...
+```
+
+The `TD_API_KEY` is pulled from your repository secrets when running in GitHub Actions or from your environment when using the web interface.
+
+<Warning>
+  Make sure `TD_API_KEY` is set in your repository secrets for CI workflows. Go to **Settings → Secrets and variables → Actions** to add it.
+</Warning>
+
+## Auto-Healing Tests
+
+Auto-healing tests automatically fix themselves when your application changes. By integrating an AI coding agent with TestDriver in your CI pipeline, you can have AI investigate test failures and propose fixes. The example below uses GitHub Copilot in GitHub Actions, but the same approach works with any AI agent that can run TestDriver's MCP server.
+
+### How It Works
 
 When a test fails in CI:
 
 1. **GitHub Actions detects the failure**
-2. **Copilot spawns the TestDriver agent** with access to the MCP server
+2. **The AI agent spawns TestDriver** with access to the MCP server
 3. **The agent investigates** by running the failing test and analyzing what changed
-4. **Copilot creates a fix** by updating the test code
+4. **The agent creates a fix** by updating the test code
 5. **A pull request is opened** with the proposed changes for review
 
-## Setting Up Auto-Healing
+### Setting Up Auto-Healing
 
 <Steps>
   <Step title="Add Repository Secrets">
@@ -131,7 +276,7 @@ When a test fails in CI:
   </Step>
 </Steps>
 
-## Example: Button Text Change
+### Example: Button Text Change
 
 Here's what auto-healing looks like when a button's text changes:
 
@@ -158,7 +303,7 @@ Here's what auto-healing looks like when a button's text changes:
   </Step>
 
   <Step title="Auto-Heal Triggers">
-    The auto-heal workflow runs, and Copilot investigates:
+    The auto-heal workflow runs, and the AI agent investigates:
 
     ```
     The test is looking for a "Submit button" but I see a "Send button"
@@ -177,9 +322,9 @@ Here's what auto-healing looks like when a button's text changes:
   </Step>
 </Steps>
 
-## Configuration Options
+### Configuration Options
 
-### Selective Auto-Healing
+#### Selective Auto-Healing
 
 You can limit auto-healing to specific test files or patterns:
 
@@ -190,7 +335,7 @@ You can limit auto-healing to specific test files or patterns:
     vitest run tests/e2e/ 2>&1 | tee test-output.txt
 ```
 
-### Manual Approval
+#### Manual Approval
 
 For safety, you can require manual approval before auto-heal runs:
 
@@ -202,7 +347,7 @@ jobs:
 
 Configure the environment in **Settings → Environments** with required reviewers.
 
-### Limiting Changes
+#### Limiting Changes
 
 Add instructions to constrain what the AI can change:
 
@@ -220,7 +365,7 @@ Add instructions to constrain what the AI can change:
       - Keep changes minimal
 ```
 
-## Best Practices
+### Best Practices
 
 <AccordionGroup>
   <Accordion title="Always review auto-heal PRs">
@@ -250,7 +395,7 @@ Add instructions to constrain what the AI can change:
   </Accordion>
 </AccordionGroup>
 
-## Limitations
+### Limitations
 
 Auto-healing works best for:
 - Element text changes
@@ -262,4 +407,8 @@ It may struggle with:
 - New features requiring new assertions
 - Complex multi-step interactions
 
-For significant changes, create new tests manually using the [TestDriver agent](/v7/copilot/creating-tests).
+For significant changes, create new tests by going back to [Explore](/v7/generating-tests) and generating them with the TestDriver agent.
+
+<Card title="View Your Runs" icon="chart-line" href="https://console.testdriver.ai">
+  Open the TestDriver console to monitor test runs, healing PRs, and CI results across your projects.
+</Card>