The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the AI Quality Gate listing page.
MCP Server for AI code quality automation.
AI writes code → calls quality_fix → Server fixes what it can → Reports remaining issues to AI.
Hybrid Approach:
Important: ESLint vs Prettier
| Tool | Source | Config |
|---|---|---|
| ESLint | Project's config (if exists) or MCP's embedded | .eslintrc.* / eslint.config.* / MCP embedded |
| Prettier | Project's own | Project's prettier.config.mjs |
ESLint rules are controlled by MCP for consistent quality gates. Prettier uses project's config so formatting matches project preferences.
Phase 1 Rule Coverage:
| Plugin | Rules | Description |
|---|---|---|
| SonarJS | 201 | Security, bugs, code smells |
| Unicorn | 127 | Modern JS best practices |
| ESLint Core | 108 | JavaScript fundamentals |
| TypeScript-ESLint | 99 | TypeScript-specific rules |
| RegExp | 60 | Regex best practices |
| Import | 11 | Import/export rules |
| Promise | 10 | Async/await best practices |
| Node.js (n) | 9 | Node.js specific rules |
| Unused Imports | 2 | Auto-remove unused imports |
| Total | 627 |
node -v).Project root is auto-detected when PROJECT_ROOT is omitted: the server walks up from the MCP process working directory until it finds package.json or tsconfig.json. Set PROJECT_ROOT in env only to analyze a different tree than the inferred root.
Open Settings → Tools & MCP → Edit (user mcp.json). Add one server block; the examples below match .cursor/mcp.json.example (JSONC with comments — if your editor rejects comments, copy the JSON blocks below only).
Server name vs tool name: The key under mcpServers (e.g. "ai-quality-gate") is only the label for that connection in Cursor. The MCP tool your agent calls is always quality_fix — that name is fixed by this package and is separate from the server key and from ai-quality-gate.
npx (no global install)Always runs the published package; good for teams and CI-like setups.
npm installAfter npm i -g ai-quality-gate, the ai-quality-gate binary is on your PATH:
Requires a running SonarQube instance, sonar-scanner available (see SonarQube Setup), and all three variables below. Phase 1 still runs first.
Add an "env" object when you need overrides. Merge order for config is defaults → .quality-gate.yaml / .quality-gate.json → environment variables.
| Variable | When to set |
|---|---|
QUALITY_GATE_CONFIG | Absolute path to a specific .quality-gate.yaml or .quality-gate.json (skips walking directories). |
PROJECT_ROOT | Force project root if auto-detection is wrong for your layout. |
SONAR_HOST_URL | SonarQube server URL (with Phase 2). |
SONAR_TOKEN | SonarQube token (with Phase 2). |
SONAR_PROJECT_KEY | SonarQube project key (with Phase 2). |
SONAR_SCANNER_PATH | Full path to sonar-scanner if not on PATH. |
PHASE1_TIMEOUT | Phase 1 timeout (ms), default 30000. |
PHASE2_TIMEOUT | Phase 2 timeout (ms), default 300000. |
ENABLE_I18N_RULES | true / false — stricter JSX literal checks for i18n projects. |
Create or edit OpenCode config (typically ~/.config/opencode/opencode.json or project-level config):
Environment variables can be added under the server config if needed (see C) SonarQube (Phase 2) above).
To dogfood or contribute:
yarn build — generates dist/server.js.env.PROJECT_ROOT only if the repo you analyze differs from the inferred root.Settings → Rules and Commands → Add Rule:
--setup)The interactive wizard creates or updates .quality-gate.yaml without hand-editing: it walks you through project root, optional SonarQube (host URL + project key; token is not saved to disk — use SONAR_TOKEN in your environment), which Phase 1 tools to enable (ESLint, curly-brace / arrow AST fixers, Prettier, JSON validator), timeouts, and i18n rules. The generated file includes a fixers: block you can adjust later.
After yarn build (or install from npm), run from the target project (or any path under it):
PROJECT_ROOT is inferred when unset (see MCP configuration). Use the same entrypoint as the MCP server (node dist/server.js or npx ai-quality-gate); only the --setup flag switches to wizard mode. Answer prompts in the terminal; on success you get a ready-to-use config next to your project root.
Other CLI modes: --check (read-only Phase 1), --fix (default behavior when using CLI quality run), --phase1-only, --phase2-only — see docs/DEVELOPMENT.md.
Configure Sonar env in MCP as in C) SonarQube (Phase 2) above, or copy from .cursor/mcp.json.example. You need sonar-scanner on your machine for analysis (see below).
SONAR_TOKEN| Platform | Method | Command |
|---|---|---|
| Windows | npm (global) | npm install -g sonarqube-scanner |
| Windows | Chocolatey | choco install sonar-scanner |
| macOS | npm (global) | npm install -g sonarqube-scanner |
| macOS | Homebrew | brew install sonar-scanner |
| Linux | npm (global) | npm install -g sonarqube-scanner |
| Docker | Container | docker run sonarsource/sonar-scanner-cli |
For custom path: SONAR_SCANNER_PATH env var
Optional files (discovered by walking up from the inferred project root — same algorithm as package.json / tsconfig.json — or from PROJECT_ROOT when set): .quality-gate.yaml (preferred) or .quality-gate.json. Same fields as environment variables (camelCase); you may nest Sonar settings under sonar: { hostUrl, token, projectKey, scannerPath }.
Merge order: defaults → config file → environment variables (ENV wins on conflicts).
Set QUALITY_GATE_CONFIG to an explicit path to skip discovery.
customRules)Optional line-based regex checks on lintable files (Phase 1). Each match is reported as an issue with rule set to custom:<id> (and included in quality_fix remaining). Example:
Patterns use JavaScript RegExp source (escape backslashes as in YAML strings). Invalid patterns are skipped at runtime with a log line.
When fixers.jsonValidator is enabled and you pass JSON paths that match locale patterns (for example locales/en.json / locales/tr.json), the tool compares keys across those files.
issues and fail Phase 1 / quality_fix until fixed.i18nIssues in the validator result and printed as warnings on stderr during Phase 1. They do not set passed: false and do not block the gate.Treat i18nIssues as advisory unless you add your own CI check on top.
All variables are optional unless you use Phase 2, which requires SONAR_HOST_URL, SONAR_TOKEN, and SONAR_PROJECT_KEY together.
| Variable | Description | Example |
|---|---|---|
QUALITY_GATE_CONFIG | Absolute path to a .quality-gate.yaml or .quality-gate.json file. Skips walking parent directories for config discovery. | /app/ci/quality-gate.yaml |
PROJECT_ROOT | Override detected project root. Default: walk up from the process cwd until package.json or tsconfig.json is found. | /Users/me/my-repo |
SONAR_HOST_URL | SonarQube server base URL (Phase 2). | http://localhost:9000 |
SONAR_TOKEN | SonarQube authentication token (Phase 2). Prefer env / secret store; avoid committing. | sqa_xxx... |
SONAR_PROJECT_KEY | SonarQube project key (Phase 2). | my-project |
SONAR_SCANNER_PATH | Full path to the sonar-scanner executable if it is not on PATH. | /opt/sonar-scanner/bin/sonar-scanner |
PHASE1_TIMEOUT | Phase 1 subprocess timeout in milliseconds. | 30000 (default) |
PHASE2_TIMEOUT | Phase 2 (Sonar) timeout in milliseconds. | 300000 (default) |
ENABLE_I18N_RULES | Set to true to enable ESLint rules that flag raw string literals in JSX (for i18n-heavy apps). | false (default) |
Phase 1 automatically fixes these issues:
After ESLint fixes, Prettier runs to ensure consistent formatting:
Note: Prettier uses project's config, not MCP's.
Everything else: Reported to AI, AI fixes it.
quality_fixENABLE_I18N_RULESFor projects with internationalization (i18n), enable literal string detection:
When enabled:
quality_fix does not appearnode -v and npx --version.mcp.json (or use the MCP refresh control)."command": "ai-quality-gate", run npm i -g ai-quality-gate once so the binary exists."npx not found" error:
Permission denied:
"Permission denied" error:
"sonar-scanner not found" error:
"Insufficient privileges" error:
"Project not found" error:
Use Local development (this repository) for MCP pointing at dist/server.js.
.cursor/mcp.json.example are enough to run the published package.MIT © Mustafa Çağrı Güven
v0.0.1 — Initial release! MCP quality_fix, Phase 1/2 pipeline, CLI, config files, custom rules (see CHANGELOG)