mcp-accessibility-scanner 1.0.1 → 1.0.3

package/Readme.md

@@ -17,16 +17,6 @@ Using npm:
 npm install -g mcp-accessibility-scanner
 ```
 
-Using mcp-get:
-```bash
-npx @michaellatman/mcp-get@latest install mcp-accessibility-scanner
-```
-
-Using Smithery (for Claude Desktop):
-```bash
-npx -y @smithery/cli install mcp-accessibility-scanner --client claude
-```
-
 ### Installation in VS Code
 
 Install the Accessibility Scanner in VS Code using the VS Code CLI:
@@ -60,14 +50,23 @@ Here's the Claude Desktop configuration:
 
 The scanner exposes a single tool `scan_accessibility` that accepts:
 
-- `url`: The webpage URL to scan
-- `violationsTag`: Array of accessibility violation tags to check (optional)
+- `url`: The webpage URL to scan (required)
+- `violationsTag`: Array of accessibility violation tags to check (required)
+- `viewport`: Optional object to customize the viewport size
+  - `width`: number (default: 1920)
+  - `height`: number (default: 1080)
+- `shouldRunInHeadless`: Optional boolean to control headless mode (default: true)
 
 Example usage in Claude:
 ```
 Could you scan example.com for accessibility issues related to color contrast?
 ```
 
+Advanced example with custom options:
+```
+Could you scan example.com for accessibility issues with a viewport of 1280x720 and show the browser window?
+```
+
 ## Development
 
 Clone and set up the project:

package/build/accessibilityChecker.js

@@ -50,11 +50,11 @@ const playwright_1 = require("playwright");
 const playwright_2 = require("@axe-core/playwright");
 const node_path_1 = __importDefault(require("node:path"));
 const os = __importStar(require("node:os"));
-function scanViolations(url, violationsTag) {
-    return __awaiter(this, void 0, void 0, function* () {
+function scanViolations(url_1, violationsTag_1) {
+    return __awaiter(this, arguments, void 0, function* (url, violationsTag, viewport = { width: 1920, height: 1080 }, shouldRunInHeadless = true, downloadsDir = node_path_1.default.join(os.homedir(), 'Downloads')) {
         var _a;
         const browser = yield playwright_1.chromium.launch({
-            headless: true,
+            headless: shouldRunInHeadless,
             args: [
                 '--disable-blink-features=AutomationControlled',
                 '--disable-dev-shm-usage',
@@ -63,7 +63,7 @@ function scanViolations(url, violationsTag) {
             ]
         });
         const context = yield browser.newContext({
-            viewport: { width: 1920, height: 1080 },
+            viewport,
             userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36'
         });
         const page = yield context.newPage();
@@ -170,7 +170,6 @@ function scanViolations(url, violationsTag) {
                 });
             }
         }
-        const downloadsDir = node_path_1.default.join(os.homedir(), 'Downloads');
         const filePath = node_path_1.default.join(downloadsDir, `a11y-report-${Date.now()}.png`);
         const screenshot = yield page.screenshot({
             path: filePath,

package/build/index.js

@@ -18,9 +18,14 @@ const server = new mcp_js_1.McpServer({
 });
 server.tool("scan_accessibility", {
     url: zod_1.z.string().url(),
-    violationsTag: zod_1.z.array(zod_1.z.string())
-}, (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, violationsTag }) {
-    const { report, base64Screenshot } = yield (0, accessibilityChecker_1.scanViolations)(url, violationsTag);
+    violationsTag: zod_1.z.array(zod_1.z.string()),
+    viewport: zod_1.z.object({
+        width: zod_1.z.number().default(1920),
+        height: zod_1.z.number().default(1080)
+    }).optional(),
+    shouldRunInHeadless: zod_1.z.boolean().default(true)
+}, (_a) => __awaiter(void 0, [_a], void 0, function* ({ url, violationsTag, viewport, shouldRunInHeadless }) {
+    const { report, base64Screenshot } = yield (0, accessibilityChecker_1.scanViolations)(url, violationsTag, viewport, shouldRunInHeadless);
     return {
         content: [
             {

package/build/server.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "mcp-accessibility-scanner",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A Model Context Protocol (MCP) server for performing automated accessibility scans of web pages using Playwright and Axe-core",
   "main": "build/index.js",
   "types": "build/index.d.ts",
+  "bin": {
+    "mcp-accessibility-scanner": "./build/server.js"
+  },
   "files": [
     "build/**/*",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
+    "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755') && require('fs').chmodSync('build/server.js', '755')\"",
     "prepare": "npm run build",
     "watch": "tsc --watch",
     "inspector": "npx @modelcontextprotocol/inspector build/index.js"
   },
   "dependencies": {
     "@axe-core/playwright": "^4.10.1",
-    "@modelcontextprotocol/sdk": "^1.4.1",
-    "mcp-accessibility-scanner": "file:"
+    "@modelcontextprotocol/sdk": "^1.4.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.49.1",