@validate.qa/mcp 1.0.0

package/README.md

@@ -0,0 +1,139 @@
+# @validate.qa/mcp
+
+MCP server for Validate.QA.
+
+This package lets AI IDEs like Claude Code and Cursor connect directly to your
+Validate.QA workspace over stdio. Your AI can create, edit, run, and heal tests
+from inside the editor while Validate.QA handles execution, scheduling, and
+reporting on the platform side.
+
+## Requirements
+
+- Node.js 18+
+- A Validate.QA API URL
+- A `pat_...` personal access token
+- A Validate.QA project ID
+
+## Quick Start
+
+Run it directly with `npx`:
+
+```bash
+npx @validate.qa/mcp \
+  --api-url https://api.myorg.validate.qa \
+  --token pat_xxxxxxxxxxxx \
+  --project-id proj_xxxxxxxxxxxx
+```
+
+Or install it globally:
+
+```bash
+npm install -g @validate.qa/mcp
+
+validate-mcp \
+  --api-url https://api.myorg.validate.qa \
+  --token pat_xxxxxxxxxxxx \
+  --project-id proj_xxxxxxxxxxxx
+```
+
+## Required Arguments
+
+- `--api-url`
+  Your Validate.QA API base URL, for example `https://api.myorg.validate.qa`
+  or `http://localhost:3001`.
+- `--token`
+  A Validate.QA personal access token. For IDE usage, use a `pat_...` token.
+- `--project-id`
+  The project the MCP server should scope all tool calls to.
+
+## Configuration Resolution
+
+The package resolves config in this order:
+
+1. CLI args: `--api-url`, `--token`, `--project-id`
+2. Environment variables: `VALIDATEQA_API_URL`, `VALIDATEQA_TOKEN`,
+   `VALIDATEQA_PROJECT_ID`
+3. `.validateqa.json` in the current working directory
+
+Example `.validateqa.json`:
+
+```json
+{
+  "apiUrl": "https://api.myorg.validate.qa",
+  "projectId": "proj_xxxxxxxxxxxx"
+}
+```
+
+`token` is intentionally not read from `.validateqa.json`; pass it via CLI or
+environment variable instead.
+
+## Claude Code Example
+
+Create `.mcp.json` in your repo:
+
+```json
+{
+  "mcpServers": {
+    "validate.qa": {
+      "command": "npx",
+      "args": [
+        "@validate.qa/mcp",
+        "--api-url",
+        "https://api.myorg.validate.qa",
+        "--token",
+        "pat_xxxxxxxxxxxx",
+        "--project-id",
+        "proj_xxxxxxxxxxxx"
+      ]
+    }
+  }
+}
+```
+
+## Cursor Example
+
+Create `.cursor/mcp.json` in your repo:
+
+```json
+{
+  "mcpServers": {
+    "validate.qa": {
+      "command": "npx",
+      "args": [
+        "@validate.qa/mcp",
+        "--api-url",
+        "https://api.myorg.validate.qa",
+        "--token",
+        "pat_xxxxxxxxxxxx",
+        "--project-id",
+        "proj_xxxxxxxxxxxx"
+      ]
+    }
+  }
+}
+```
+
+## Optional Init Helper
+
+The package also includes a helper to write MCP config files for supported IDEs:
+
+```bash
+npx @validate.qa/mcp init \
+  --api-url https://api.myorg.validate.qa \
+  --token pat_xxxxxxxxxxxx \
+  --project-id proj_xxxxxxxxxxxx
+```
+
+This can create or update:
+
+- `.mcp.json` for Claude Code
+- `.cursor/mcp.json` for Cursor
+- `.windsurf/mcp.json` for Windsurf
+- `.vscode/mcp.json` for VS Code
+
+## More Docs
+
+- Full MCP guide:
+  [docs/MCP.md](https://github.com/Validate-QA/validate.qa/blob/main/docs/MCP.md)
+- Package source:
+  [packages/mcp-server](https://github.com/Validate-QA/validate.qa/tree/main/packages/mcp-server)

package/bin.cjs

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+// CommonJS wrapper for Windows compatibility — npx can't run ESM bin files on Windows
+const { resolve } = require('path');
+const { execFileSync } = require('child_process');
+const entry = resolve(__dirname, 'dist', 'index.js');
+try {
+  execFileSync('node', [entry, ...process.argv.slice(2)], { stdio: 'inherit' });
+} catch (e) {
+  process.exit(e.status || 1);
+}