eslint-plugin-ai-guard 1.3.1 → 1.4.1

package/README.md

@@ -33,7 +33,14 @@
 
 ## What is AI Guard?
 
-**AI Guard** (`eslint-plugin-ai-guard`) is a deterministic ESLint plugin, CLI, and GitHub Action engineered to detect reliability bugs, async hazards, security vulnerabilities, and code-scaffolding defects frequently introduced during AI-assisted development (GitHub Copilot, Cursor, Claude Code, Gemini Code Assist, etc.).
+**AI Guard** (`eslint-plugin-ai-guard`) provides:
+- **ESLint plugin** with 18 deterministic rules and 4 presets (`recommended`, `strict`, `security`, `agent`)
+- **CLI** (`ai-guard`) for terminal, changed-file, and CI scanning
+- **GitHub Action** with native SARIF 2.1.0 output for GitHub Code Scanning
+- **Claude Code integration** with a zero-config PostToolUse hook
+- **MCP server** (`ai-guard-mcp`) for local AI-agent workflows over STDIO
+
+It is engineered to detect reliability bugs, async hazards, security vulnerabilities, and code-scaffolding defects frequently introduced during AI-assisted development (GitHub Copilot, Cursor, Claude Code, Gemini Code Assist, etc.).
 
 AI Guard analyzes Abstract Syntax Trees (AST) using ESLint's native engine. It runs locally in your editor, in your terminal via the zero-config CLI, and in your CI/CD pipelines via native SARIF 2.1.0 integration with GitHub Code Scanning.
 
@@ -87,7 +94,7 @@ flowchart TD
     end
 
     subgraph Tiers["3. Classification & Presets"]
-        E --> F{"Active Preset\n(recommended | strict | security)"}
+        E --> F{"Active Preset\n(recommended | strict | security | agent)"}
         F --> G["Confidence Tiering & AST Filtering"]
     end
 
@@ -265,6 +272,8 @@ npx ai-guard <command> [options]
 | `preset` | Interactively select and switch active preset in config | (Interactive prompt with automatic config patch & backup) |
 | `ignore` | Add standard ignore paths (`.next`, `dist`, `build`) to config | (Patches flat config or legacy ignores safely) |
 
+**`run` exit codes:** `0` no errors · `1` errors found (or `--max-warnings` exceeded) · `2` scan did not run — the file passed to `--path` matches a built-in ignore pattern (`node_modules/`, `dist/`, `build/`, `generated/`, `vendor/`, …), so nothing was analyzed. Directory scans skip ignored files silently and never exit `2`.
+
 ### CLI Usage Examples
 
 ```bash
@@ -614,6 +623,44 @@ For the complete methodology, raw findings, and benchmark harness, see [**`docs/
 
 ---
 
+## MCP Server (Model Context Protocol)
+
+AI Guard includes a local MCP server that exposes its deterministic analysis engine to MCP-capable AI clients (Claude Code, Claude Desktop, and other MCP-compatible integrations).
+
+```bash
+npx --yes --package eslint-plugin-ai-guard ai-guard-mcp
+```
+
+**Available tools:**
+
+| Tool | Description |
+| :--- | :--- |
+| `ai_guard_scan_file` | Scan a single JS/TS file with structured findings |
+| `ai_guard_scan_diff` | Scan changed files in git diff (including newly created untracked JS/TS files) |
+| `ai_guard_scan_project` | Scan a bounded workspace directory (current source; not yet published) |
+| `ai_guard_rules` | List rules and presets, or look up specific rules (`rules: ["no-floating-promise"]`) with remediation and docs link |
+
+All tools declare an `outputSchema`; the text content is the same result as compact JSON. Scan tools accept `maxIssues` (default 50, errors first, exact `totalIssues` and `truncated`). The `verify_changes` prompt runs the scan → fix → rescan loop.
+
+**Claude Code configuration** (project-root `.mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "ai-guard": {
+      "type": "stdio",
+      "command": "node",
+      "args": ["/absolute/path/to/ai-guard/dist/mcp/server.js"],
+      "env": { "AI_GUARD_WORKSPACE": "/absolute/path/to/project" }
+    }
+  }
+}
+```
+
+The SDK in-memory and built STDIO integrations are tested, plus a headless Claude Code CLI smoke test (see the MCP guide for scope). Use the built checkout to test unreleased changes. Scan, fix, then rescan; a partial or failed scan is never clean. For setup, result status, limits, and client verification scope, see [**`docs/mcp-server.md`**](./docs/mcp-server.md).
+
+---
+
 ## Learn More & Ecosystem
 
 Visit [getaiguard.dev](https://getaiguard.dev) to explore interactive documentation, rule catalogs, benchmarks, and deep-dive engineering articles.