@testdriverai/agent 7.8.0-canary.10

package/docs/claude-mcp-plugin.mdx

@@ -0,0 +1,160 @@
+---
+title: Using TestDriver with Claude Code (MCP)
+---
+
+TestDriver exposes test results and analytics over an **HTTP MCP server**, so Claude Code (or any MCP-compatible client) can inspect your test runs, failures, and filters.
+
+This guide assumes:
+
+- Your API server is running the MCP endpoint at `POST /api/v1/mcp`
+- You have a **team or user API key** for authentication
+- You are using this repo (`testdriverai`) as the SDK / local tooling
+
+## 1. Configure an API key
+
+Get your API key from the team settings:
+
+- Visit your team page (e.g. `https://console.testdriver.ai/team`)
+- Create or copy a **Team API Key** (or User API Key)
+- Store it locally as an environment variable, for example:
+
+```bash
+export TD_API_KEY="your_api_key_here"
+```
+
+The MCP server expects this API key in the `X-Api-Key` header (or `Authorization: Bearer <key>`).
+
+## 2. HTTP MCP endpoint contract
+
+The HTTP endpoint lives at:
+
+```text
+POST /api/v1/mcp
+```
+
+Common request shapes:
+
+- **List tools**
+
+```json
+{
+  "kind": "list_tools"
+}
+```
+
+- **Call a tool**
+
+```json
+{
+  "kind": "call_tool",
+  "tool": "list_test_runs",
+  "arguments": {
+    "status": "failed",
+    "page": 1,
+    "limit": 20
+  }
+}
+```
+
+Responses from tool calls follow the MCP content convention:
+
+```json
+{
+  "content": [
+    {
+      "type": "json",
+      "json": {
+        "testRuns": [],
+        "totalCount": 0,
+        "hasMore": false
+      }
+    }
+  ]
+}
+```
+
+### Available tools
+
+The MCP server advertises at least these tools in `list_tools`:
+
+- `list_test_runs`  
+  List recent TestDriver test runs for the current team, with filters and pagination.
+
+- `get_test_run_detail`  
+  Get a single test run and its test cases (including replay IDs / share keys when available).
+
+- `list_test_cases`  
+  List individual test cases for the team with status, duration, error messages, and replay info.
+
+- `get_filter_options`  
+  Get branch, suite, repo, filename, commit, status, platform, and test name options for building queries.
+
+## 3. Claude Code MCP server configuration
+
+You can point Claude Code at the HTTP MCP endpoint using a JSON configuration similar to:
+
+```json
+{
+  "$schema": "https://schema.anthropic.com/mcp/servers.json",
+  "mcpServers": {
+    "testdriver-cloud": {
+      "type": "sse",
+      "url": "https://your-api-host.example.com/api/v1/mcp",
+      "requestHeaders": {
+        "X-Api-Key": "${TD_API_KEY}"
+      },
+      "description": "Query TestDriver test runs, test cases, and filters for your team using an API key."
+    }
+  }
+}
+```
+
+You can find this exact snippet in the repo at:
+
+- `claude-mcp-config.example.json`
+
+Replace `https://your-api-host.example.com` with your actual API origin (e.g. `https://api.testdriver.ai` or `http://localhost:1337` in development).
+
+### Local development
+
+For local development:
+
+- Run your API server on `http://localhost:1337`
+- Point `baseUrl` at `http://localhost:1337/api/v1/mcp`
+- Use a local team or user API key in `TD_API_KEY`
+
+```json
+{
+  "mcpServers": {
+    "testdriver-cloud-local": {
+      "type": "sse",
+      "url": "http://localhost:1337/api/v1/mcp",
+      "requestHeaders": {
+        "X-Api-Key": "${TD_API_KEY}"
+      }
+    }
+  }
+}
+```
+
+## 4. Skills documentation for Claude
+
+Claude Code expects a `SKILLs.md` file to explain how to use a server. In this repo:
+
+- `ai/agents/testdriver.md` contains the **full TestDriver Agent Guide**
+- `SKILLs.md` acts as a short wrapper that points Claude (and other agents) to the agent guide
+
+Use these as the primary reference for:
+
+- How to initialize the `TestDriver` SDK in Vitest
+- The MCP workflow for building tests interactively with visual feedback
+- How to find elements, click, type, scroll, assert, and capture screenshots
+
+The MCP tools described above are **read-only** helpers for:
+
+- Inspecting recent test runs and failures
+- Discovering branches, files, and suites to focus on
+- Pulling detailed test case and replay information into Claude for analysis
+
+Use the SDK (`testdriverai`) for **driving tests**, and the HTTP MCP server (`/api/v1/mcp`) for **observing and debugging** them from Claude Code.
+

package/docs/docs.json

@@ -0,0 +1,442 @@
+{
+  "$schema": "https://mintlify.com/docs.json",
+  "theme": "almond",
+  "name": "TestDriver",
+  "colors": {
+    "primary": "#b3d334",
+    "light": "#b3d334",
+    "dark": "#152a65"
+  },
+  "appearance": {
+    "default": "dark"
+  },
+  "favicon": "/images/template/icon.png",
+  "navigation": {
+    "versions": [
+      {
+        "version": "v7",
+        "groups": [
+          {
+            "group": "Overview",
+            "pages": [
+              "/v7/quickstart",
+              "/v7/what-is-testdriver",
+              {
+                "group": "Examples",
+                "icon": "code",
+                "pages": [
+                  "/v7/examples/ai",
+                  "/v7/examples/assert",
+                  "/v7/examples/captcha-api",
+                  "/v7/examples/chrome-extension",
+                  "/v7/examples/drag-and-drop",
+                  "/v7/examples/element-not-found",
+                  "/v7/examples/exec-output",
+                  "/v7/examples/exec-pwsh",
+                  "/v7/examples/focus-window",
+                  "/v7/examples/hover-image",
+                  "/v7/examples/hover-text",
+                  "/v7/examples/installer",
+                  "/v7/examples/launch-vscode-linux",
+                  "/v7/examples/match-image",
+                  "/v7/examples/press-keys",
+                  "/v7/examples/scroll-keyboard",
+                  "/v7/examples/scroll-until-image",
+                  "/v7/examples/scroll-until-text",
+                  "/v7/examples/scroll",
+                  "/v7/examples/type",
+                  "/v7/examples/windows-installer"
+                ]
+              },
+
+              {
+                "group": "Deployment",
+                "icon": "server",
+                "pages": [
+                  "/v7/hosted",
+                  "/v7/self-hosted"
+                ]
+              },
+              "/changelog"
+            ]
+          },
+
+          {
+            "group": "GitHub Copilot",
+            "pages": [
+              "/v7/copilot/setup",
+              "/v7/copilot/creating-tests",
+              "/v7/copilot/running-tests",
+              "/v7/copilot/github",
+              "/v7/copilot/auto-healing"
+            ]
+          },
+          {
+            "group": "Guide",
+            "pages": [
+              "/v7/generating-tests",
+              "/v7/device-config",
+              "/v7/locating-elements",
+              "/v7/waiting-for-elements",
+              "/v7/performing-actions",
+              "/v7/making-assertions"
+            ]
+          },
+          {
+            "group": "Running Tests",
+            "pages": [
+              "/v7/running-tests",
+              "/v7/caching",
+              "/v7/ci-cd"
+            ]
+          },
+          {
+            "group": "Scaling",
+            "pages": [
+              "/v7/variables",
+              "/v7/secrets",
+              "/v7/reusable-code",
+              {
+                "group": "Self-Hosting Setup",
+                "icon": "server",
+                "pages": [
+                  "/v7/aws-setup"
+                ]
+              }
+            ]
+          },
+          {
+            "group": "SDK Reference",
+            "pages": [
+              "/v7/client",
+              "/v7/elements",
+              {
+                "group": "Actions",
+                "icon": "bolt",
+                "pages": [
+                  "/v7/ai",
+                  "/v7/assert",
+                  "/v7/captcha",
+                  "/v7/click",
+                  "/v7/double-click",
+                  "/v7/exec",
+                  "/v7/find",
+                  "/v7/focus-application",
+                  "/v7/hover",
+                  "/v7/mouse-down",
+                  "/v7/mouse-up",
+                  "/v7/parse",
+                  "/v7/press-keys",
+                  "/v7/right-click",
+                  "/v7/screenshot",
+                  "/v7/scroll",
+                  "/v7/type"
+                ]
+              },
+              "/v7/dashcam"
+            ]
+          }
+        ]
+      },
+      {
+        "version": "v6",
+        "groups": [
+          {
+            "group": "Overview",
+            "pages": [
+              "/v6/overview/what-is-testdriver",
+              {
+                "group": "Concepts",
+                "icon": "book",
+                "pages": [
+                  "/v6/features/selectorless",
+                  "/v6/overview/comparison",
+                  "/v6/overview/performance",
+                  "/v6/overview/faq"
+                ]
+              },
+              "/v6/account/enterprise"
+            ]
+          },
+          {
+            "group": "Get Started",
+            "pages": [
+              "/v6/overview/quickstart",
+              {
+                "group": "CLI",
+                "icon": "terminal",
+                "pages": [
+                  "/v6/cli/overview",
+                  {
+                    "group": "Commands",
+                    "icon": "command",
+                    "pages": [
+                      "/v6/interactive/explore",
+                      "/v6/interactive/run",
+                      "/v6/interactive/save"
+                    ]
+                  }
+                ]
+              },
+              "/v6/getting-started/self-hosting",
+              "/v6/getting-started/playwright",
+              "/v6/getting-started/vscode"
+            ]
+          },
+          {
+            "group": "Examples",
+            "pages": [
+              {
+                "group": "Apps",
+                "icon": "laptop",
+                "pages": [
+                  "/v6/apps/static-websites",
+                  "/v6/apps/desktop-apps",
+                  "/v6/apps/chrome-extensions",
+                  "/v6/apps/mobile-apps",
+                  "/v6/apps/tauri-apps"
+                ]
+              },
+              {
+                "group": "Scenarios",
+                "icon": "computer-mouse",
+                "pages": [
+                  "/v6/scenarios/ai-chatbot",
+                  "/v6/scenarios/cookie-banner",
+                  "/v6/scenarios/file-upload",
+                  "/v6/scenarios/form-filling",
+                  "/v6/scenarios/log-in",
+                  "/v6/scenarios/pdf-generation",
+                  "/v6/scenarios/spell-check"
+                ]
+              },
+              {
+                "group": "Build Systems",
+                "icon": "helmet-safety",
+                "pages": [
+                  "/v6/integrations/electron",
+                  "/v6/integrations/netlify",
+                  "/v6/integrations/vercel"
+                ]
+              }
+            ]
+          },
+          {
+            "group": "Guide",
+            "pages": [
+              {
+                "group": "Configuration",
+                "icon": "desktop",
+                "pages": [
+                  "/v6/guide/authentication",
+                  "/v6/guide/variables",
+                  "/v6/guide/lifecycle",
+                  "/v6/guide/dashcam",
+                  "/v6/guide/environment-variables",
+                  "/v6/action/ami"
+                ]
+              },
+              {
+                "group": "Writing",
+                "icon": "pencil",
+                "pages": [
+                  "/v6/features/generation",
+                  "/v6/guide/locating",
+                  "/v6/guide/waiting",
+                  "/v6/guide/assertions",
+                  "/v6/guide/code",
+                  "/v6/features/reusable-snippets",
+                  "/v6/guide/protips"
+                ]
+              },
+              {
+                "group": "Importing",
+                "icon": "file-import",
+                "pages": [
+                  "/v6/importing/csv",
+                  "/v6/importing/gherkin",
+                  "/v6/importing/jira",
+                  "/v6/importing/testrail"
+                ]
+              },
+              {
+                "group": "Running",
+                "icon": "play",
+                "pages": [
+                  "/v6/getting-started/running",
+                  "/v6/getting-started/ci",
+                  "/v6/features/parallel-testing",
+                  "/v6/action/performance",
+                  "/v6/action/secrets"
+                ]
+              },
+              {
+                "group": "Maintaining",
+                "icon": "wrench",
+                "pages": [
+                  "/v6/getting-started/editing",
+                  "/v6/features/auto-healing"
+                ]
+              },
+              {
+                "group": "Reporting",
+                "icon": "chart-simple",
+                "pages": [
+                  "/v6/exporting/junit",
+                  "/v6/bugs/jira"
+                ]
+              }
+            ]
+          },
+          {
+            "group": "Reference",
+            "pages": [
+              {
+                "group": "YAML",
+                "icon": "file-code",
+                "pages": [
+                  "/v6/commands/assert",
+                  "/v6/commands/exec",
+                  "/v6/commands/focus-application",
+                  "/v6/commands/hover-image",
+                  "/v6/commands/hover-text",
+                  "/v6/commands/if",
+                  "/v6/commands/match-image",
+                  "/v6/commands/press-keys",
+                  "/v6/commands/remember",
+                  "/v6/commands/run",
+                  "/v6/commands/scroll",
+                  "/v6/commands/scroll-until-image",
+                  "/v6/commands/scroll-until-text",
+                  "/v6/commands/type",
+                  "/v6/commands/wait",
+                  "/v6/commands/wait-for-image",
+                  "/v6/commands/wait-for-text"
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  "logo": {
+    "light": "/images/template/light.png",
+    "dark": "/images/template/dark.png",
+    "href": "https://testdriver.ai"
+  },
+  "navbar": {
+    "links": [
+      {
+        "label": "Discord",
+        "icon": "discord",
+        "href": "https://discord.com/invite/cWDFW8DzPm"
+      },
+      {
+        "label": "Book a Demo",
+        "href": "http://testdriver.ai/demo",
+        "icon": "calendar"
+      },
+      {
+        "icon": "gauge-high",
+        "label": "Dashboard",
+        "href": "https://console.testdriver.ai"
+      },
+      {
+        "icon": "megaphone",
+        "label": "Changelog",
+        "href": "/changelog"
+      }
+    ]
+  },
+  "footer": {
+    "socials": {
+      "x": "https://x.com/testdriverai",
+      "github": "https://github.com/testdriverai",
+      "discord": "https://discord.com/invite/cWDFW8DzPm",
+      "youtube": "https://www.youtube.com/@testdriverai"
+    }
+  },
+  "redirects": [
+    {
+      "source": "/guides/github-actions",
+      "destination": "/v6/action/setup"
+    },
+    {
+      "source": "/reference/test-steps",
+      "destination": "/v6/features/selectorless"
+    },
+    {
+      "source": "/guides/debugging-test-runs",
+      "destination": "/v6/getting-started/editing"
+    },
+    {
+      "source": "/overview/:slug*",
+      "destination": "/v6/overview/:slug*"
+    },
+    {
+      "source": "/features/:slug*",
+      "destination": "/v6/features/:slug*"
+    },
+    {
+      "source": "/getting-started/:slug*",
+      "destination": "/v6/getting-started/:slug*"
+    },
+    {
+      "source": "/cli/:slug*",
+      "destination": "/v6/cli/:slug*"
+    },
+    {
+      "source": "/interactive/:slug*",
+      "destination": "/v6/interactive/:slug*"
+    },
+    {
+      "source": "/guide/:slug*",
+      "destination": "/v6/guide/:slug*"
+    },
+    {
+      "source": "/action/:slug*",
+      "destination": "/v6/action/:slug*"
+    },
+    {
+      "source": "/account/:slug*",
+      "destination": "/v6/account/:slug*"
+    },
+    {
+      "source": "/apps/:slug*",
+      "destination": "/v6/apps/:slug*"
+    },
+    {
+      "source": "/scenarios/:slug*",
+      "destination": "/v6/scenarios/:slug*"
+    },
+    {
+      "source": "/integrations/:slug*",
+      "destination": "/v6/integrations/:slug*"
+    },
+    {
+      "source": "/importing/:slug*",
+      "destination": "/v6/importing/:slug*"
+    },
+    {
+      "source": "/exporting/:slug*",
+      "destination": "/v6/exporting/:slug*"
+    },
+    {
+      "source": "/bugs/:slug*",
+      "destination": "/v6/bugs/:slug*"
+    },
+    {
+      "source": "/commands/:slug*",
+      "destination": "/v6/commands/:slug*"
+    }
+  ],
+  "integrations": {
+    "segment": {
+      "key": "oh4PK60u4Qvm2DKIjxfhxd0KCdRbQsQE"
+    },
+    "posthog": {
+      "apiKey": "phc_ovOQ2HFpqFwPVqaxE5plJmI9buPMsz024FB2iajItqn"
+    }
+  }
+}