Skip to content

Commit a20fbbf

Browse files
authored
Merge pull request #83 from woocommerce/26-04/ai-recommended-tools
Add AI Recommended Tools page and agent-agnostic framing
2 parents 2f1a1e0 + 2cacf72 commit a20fbbf

4 files changed

Lines changed: 70 additions & 5 deletions

File tree

docs/ai/getting-started.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ This page assumes your AI agent already has QIT context. If not, see [Getting St
1010

1111
Once set up, your AI agent can handle any QIT task autonomously. This page covers what's possible and how to get the most out of it.
1212

13-
## What Claude Can Do
13+
## What Your AI Agent Can Do
1414

15-
With the QIT plugin, Claude can:
15+
With QIT documentation context, your AI agent can:
1616

1717
- **Run any QIT test**: managed tests, test packages, or both
1818
- **Create test packages**: follows a [structured methodology](./test-packages/writing-with-agents.md) that includes user research, UI observation, and persona-based test design
@@ -23,10 +23,20 @@ With the QIT plugin, Claude can:
2323

2424
## How It Works
2525

26-
The plugin uses **progressive disclosure** from QIT's live documentation:
26+
### Claude Code (Recommended)
2727

28-
1. Claude fetches the [documentation index](https://qit.woo.com/docs/llms.txt) to find relevant pages
28+
The QIT plugin uses **progressive disclosure** from live documentation:
29+
30+
1. The agent fetches the [documentation index](https://qit.woo.com/docs/llms.txt) to find relevant pages
2931
2. It reads the specific docs needed for your task
3032
3. It acts on what it learned: running commands, writing code, interpreting results
3133

32-
This means Claude always has current information, even as QIT evolves. You don't need to paste docs or explain QIT concepts — the agent discovers what it needs on-demand.
34+
This happens automatically. You don't need to paste docs or explain QIT concepts.
35+
36+
### Other AI Agents
37+
38+
Provide your agent with the documentation URL once:
39+
40+
> Read https://qit.woo.com/docs/llms.txt — I want to test my WooCommerce extension with QIT.
41+
42+
Your agent reads the index, fetches the pages it needs, and has the same capabilities from there. The llms.txt index follows the [llmstxt.org](https://llmstxt.org) standard and stays current as QIT evolves.

docs/ai/recommended-tools.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
description: "The recommended MCP servers and tools for using QIT with AI coding agents. Covers Playwright MCP for browser observation, Xdebug MCP for PHP debugging, and how they work together in a typical test development workflow."
3+
---
4+
5+
# Recommended Tools
6+
7+
These MCP servers give your AI agent direct access to the browser and PHP runtime, making it significantly more effective at writing tests, debugging failures, and investigating issues.
8+
9+
## Playwright MCP
10+
11+
[Playwright MCP](https://github.com/anthropics/playwright-mcp) lets your agent control a real browser: navigate pages, read the accessibility tree, take screenshots, fill forms, and click elements. Essential for writing test packages and debugging test failures.
12+
13+
Your agent uses it to:
14+
- Explore your extension's admin and frontend UI before writing tests
15+
- Observe exact accessible names and page structure for reliable selectors
16+
- Debug failing tests by navigating to the failing page and inspecting what's actually there
17+
18+
See [Browser Observation](./test-packages/browser-observation.md) for the detailed workflow.
19+
20+
## Xdebug MCP
21+
22+
[Xdebug MCP](https://github.com/kpanuragh/xdebug-mcp) lets your agent do PHP step debugging conversationally: set breakpoints, step through code, inspect variables, and evaluate expressions. No IDE needed.
23+
24+
Your agent uses it to:
25+
- Set breakpoints in plugin code and step through execution
26+
- Inspect variable state at runtime to understand behavior
27+
- Trace function calls to find where things go wrong
28+
29+
Pair it with QIT's built-in Xdebug support:
30+
31+
```qitbash
32+
qit env:up --xdebug --plugin=your-extension
33+
```
34+
35+
See [Xdebug Debugging](../environment/xdebug.md) for environment setup and configuration.
36+
37+
## How They Work Together
38+
39+
A typical AI-driven test development workflow uses all three tools:
40+
41+
1. **QIT CLI** starts the environment and runs tests
42+
2. **Playwright MCP** observes the UI to discover selectors and verify behavior
43+
3. **Xdebug MCP** debugs PHP when something unexpected happens server-side
44+
45+
For example, when a test fails because checkout doesn't complete:
46+
- Your agent uses Playwright MCP to navigate to checkout and see the current UI state
47+
- If the UI looks correct but the order still fails, it uses Xdebug MCP to set a breakpoint in the payment processing code and step through it
48+
- Once it finds the issue, it fixes the code and uses QIT CLI to re-run the test
49+
50+
This is the workflow described in detail in [Writing Test Packages with AI](./test-packages/writing-with-agents.md).

docs/environment/xdebug.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ QIT environments include Xdebug pre-installed but disabled by default. The `--xd
1212
- **Profiling** — generate cachegrind files to find performance bottlenecks
1313
- **Tracing** — log every function call for execution flow analysis
1414

15+
:::tip AI-agent debugging
16+
Using an AI coding agent? It can drive Xdebug directly via [Xdebug MCP](https://github.com/kpanuragh/xdebug-mcp), setting breakpoints and inspecting variables conversationally with no IDE needed. See [Recommended Tools](/ai/recommended-tools) for the full AI toolkit.
17+
:::
18+
1519
## Quick start
1620

1721
```qitbash

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ const sidebars = {
114114
collapsed: true,
115115
items: [
116116
'ai/getting-started',
117+
'ai/recommended-tools',
117118
{
118119
type: 'category',
119120
label: 'Test Packages',

0 commit comments

Comments
 (0)