a11y-test-mcp 1.0.7 → 1.1.1

package/README.md

@@ -1,16 +1,17 @@
 # a11y test MCP
+
 An MCP (Model Context Protocol) server for performing a11y test on webpages using playwright axe-core. The results are then used in an agent loop with your favorite AI assistant (Cline/Cursor/GH Copilot) to find problems with a11y and suggest improvements.
 
 ## Features
 
-* Perform detailed accessibility testing on any web pages
-* Get an overview of accessibility issues
-  * Violations
-    * Provides information on which DOM was at fault
-  * Passes
-  * Incomplete
-  * Inapplicable
-* Can specify specific WCAG criteria（Default WCAG 2.0 level A, WCAG 2.0 level AA, WCAG 2.1 level A, WCAG 2.1 level AA）
+- Perform detailed accessibility testing on any web pages
+- Get an overview of accessibility issues
+  - Violations
+    - Provides information on which DOM was at fault
+  - Passes
+  - Incomplete
+  - Inapplicable
+- Can specify specific WCAG criteria（Default WCAG 2.0 level A, WCAG 2.0 level AA, WCAG 2.1 level A, WCAG 2.1 level AA）
 
 ## Installation
 

package/build/constants.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_WCAG_TAGS = exports.ALLOWED_PREFIXES_OR_TAGS = exports.WCAG_TAG_MAP = void 0;
+/** WCAG tag map */
+exports.WCAG_TAG_MAP = {
+    'a': 'wcag2a',
+    'wcag20a': 'wcag2a',
+    'wcag2a': 'wcag2a',
+    'aa': 'wcag2aa',
+    'wcag20aa': 'wcag2aa',
+    'wcag2aa': 'wcag2aa',
+    'wcag21a': 'wcag21a',
+    'wcag21aa': 'wcag21aa',
+    'wcag22a': 'wcag22a',
+    'wcag22aa': 'wcag22aa',
+    // Add other known tags or aliases here
+};
+/** Allow prefixes or tags */
+exports.ALLOWED_PREFIXES_OR_TAGS = ['wcag', 'best-practice', 'section508'];
+/** default WCAG tags */
+exports.DEFAULT_WCAG_TAGS = ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'];

package/build/functions.js

@@ -4,8 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertTestResultToText = exports.execTest = void 0;
-const playwright_1 = __importDefault(require("playwright"));
-const playwright_2 = __importDefault(require("@axe-core/playwright"));
+const playwright_1 = __importDefault(require("@axe-core/playwright"));
+const playwright_2 = require("playwright");
+const constants_1 = require("./constants");
 /**
  * Enhance WCAG tag conversion
  * @param {string[]} tags - Array of WCAG tags
@@ -14,33 +15,28 @@ const playwright_2 = __importDefault(require("@axe-core/playwright"));
 const convertWcagTag = (tags) => {
     return tags.map(tag => {
         const lowerTag = tag.toLowerCase().replace(/[\s.]/g, '');
-        switch (lowerTag) {
-            case 'wcag2a':
-            case 'a':
-            case 'wcag20a':
-                return 'wcag2a';
-            case 'wcag2aa':
-            case 'aa':
-            case 'wcag20aa':
-                return 'wcag2aa';
-            case 'wcag21a':
-                return 'wcag21a';
-            case 'wcag21aa':
-                return 'wcag21aa';
-            case 'wcag22a':
-                return 'wcag22a';
-            case 'wcag22aa':
-                return 'wcag22aa';
-            default:
-                if (lowerTag.startsWith('wcag') || ['best-practice', 'section508'].includes(lowerTag)) {
-                    return lowerTag;
-                }
-                console.warn(`Unrecognized WCAG tag: ${tag}`);
-                return '';
+        if (lowerTag in constants_1.WCAG_TAG_MAP) {
+            return constants_1.WCAG_TAG_MAP[lowerTag];
+        }
+        if (constants_1.ALLOWED_PREFIXES_OR_TAGS.some(prefixOrTag => lowerTag.startsWith(prefixOrTag) || lowerTag === prefixOrTag)) {
+            return lowerTag;
         }
-    }).filter(tag => {
-        return tag !== '';
-    });
+        console.warn(`Unrecognized WCAG tag: ${tag}`);
+        return '';
+    }).filter(tag => tag !== '');
+};
+/**
+ * Formats a single accessibility violation into a human-readable string.
+ * Includes impact level, ID, description, node count, help URL, and details of each affected node.
+ * @param {ViolationSummary} v - The violation summary object containing details about the violation.
+ * @returns {string} A formatted string representing the violation, suitable for display in reports or logs.
+ */
+const formatViolation = (v) => {
+    const violationHeader = `    - [${String(v.impact?.toUpperCase() ?? 'N/A')}] ${v.id}: ${v.description} (Nodes: ${String(v.nodes.length)}, Help: ${v.helpUrl})`;
+    const violationNodes = v.nodes
+        .map((node, index) => `      Node ${String(index + 1)}: ${node.html}`)
+        .join('\n');
+    return `${violationHeader}\n${violationNodes}`;
 };
 /**
  * Execute a11y test
@@ -49,55 +45,52 @@ const convertWcagTag = (tags) => {
  * @returns {AccessibilityTestOutput[]} - Results of the accessibility tests
  */
 const execTest = async (urls, wcagStandards) => {
-    const results = [];
-    const browser = await playwright_1.default.chromium.launch();
+    const browser = await playwright_2.chromium.launch();
     const context = await browser.newContext();
     const tagsToUse = (wcagStandards && wcagStandards.length > 0)
         ? convertWcagTag(wcagStandards)
-        : ["wcag2a", "wcag2aa", "wcag21a", "wcag21aa"];
+        : constants_1.DEFAULT_WCAG_TAGS;
     try {
-        for (const url of urls) {
+        const results = await Promise.all(urls.map(async (url) => {
             let page = null;
             try {
                 page = await context.newPage();
                 await page.goto(url, { waitUntil: 'networkidle' });
-                const axeBuilder = new playwright_2.default({ page });
+                const axeBuilder = new playwright_1.default({ page });
                 axeBuilder.withTags(tagsToUse);
                 const axeResults = await axeBuilder.analyze();
-                // Summarize results, handling null impact
                 const summarizedViolations = axeResults.violations.map(v => ({
                     id: v.id,
-                    // Handle null impact from axe-core
                     impact: v.impact === null ? undefined : v.impact,
                     description: v.description,
                     helpUrl: v.helpUrl,
-                    nodes: v.nodes
+                    nodes: v.nodes,
                 }));
-                results.push({
+                return {
                     url: url,
                     violations: summarizedViolations,
                     passesCount: axeResults.passes.length,
                     incompleteCount: axeResults.incomplete.length,
                     inapplicableCount: axeResults.inapplicable.length,
-                });
+                };
             }
             catch (error) {
-                results.push({
+                return {
                     url: url,
                     error: `Failed to test: ${error instanceof Error ? error.message : String(error)}`,
-                });
+                };
             }
             finally {
                 if (page !== null) {
                     await page.close();
                 }
             }
-        }
+        }));
+        return results;
     }
     finally {
         await browser.close();
     }
-    return results;
 };
 exports.execTest = execTest;
 /**
@@ -106,34 +99,25 @@ exports.execTest = execTest;
  * @returns {string} - Text representation of the results
  */
 const convertTestResultToText = (structuredResults) => {
-    return structuredResults
-        .map((result) => {
-        const resultTextList = [`URL: ${result.url}`];
+    let outputText = '';
+    for (const result of structuredResults) {
+        let resultText = `URL: ${result.url}\n`;
         if (result.error) {
-            resultTextList.push(`  Error: ${result.error}`);
+            resultText += `  Error: ${result.error}\n`;
         }
         else {
-            resultTextList.push(`  Violations: ${String(result.violations?.length ?? 0)}`);
-            const resultViolationText = result.violations?.map((v) => {
-                return [
-                    `    - [${String(v.impact?.toUpperCase() ?? 'N/A')}] ${v.id}: ${v.description} (Nodes: ${String(v.nodes.length)}, Help: ${v.helpUrl})`,
-                    v.nodes
-                        .map((node, index) => {
-                        return `      Node ${String(index + 1)}: ${node.html}`;
-                    })
-                        .join('\n')
-                ].join('\n');
-            });
-            if (resultViolationText !== undefined) {
-                resultTextList.push(...resultViolationText);
+            resultText += `  Violations: ${String(result.violations?.length ?? 0)}\n`;
+            if (result.violations && result.violations.length > 0) {
+                for (const violation of result.violations) {
+                    resultText += `${formatViolation(violation)}\n`;
+                }
             }
-            resultTextList.push(`  Passes: ${String(result.passesCount ?? 0)}`);
-            resultTextList.push(`  Incomplete: ${String(result.incompleteCount ?? 0)}`);
-            resultTextList.push(`  Inapplicable: ${String(result.inapplicableCount ?? 0)}`);
+            resultText += `  Passes: ${String(result.passesCount ?? 0)}\n`;
+            resultText += `  Incomplete: ${String(result.incompleteCount ?? 0)}\n`;
+            resultText += `  Inapplicable: ${String(result.inapplicableCount ?? 0)}\n`;
         }
-        return resultTextList.join('\n');
-    })
-        .join('\n')
-        .trim();
+        outputText += resultText + '\n';
+    }
+    return outputText.trim();
 };
 exports.convertTestResultToText = convertTestResultToText;

package/build/index.js

@@ -15,8 +15,8 @@ server.tool('exec-a11y-test', 'Obtains a list of specified list of URL and a lis
     return {
         content: [{
                 type: 'text',
-                text: (0, functions_1.convertTestResultToText)(structuredResults)
-            }]
+                text: (0, functions_1.convertTestResultToText)(structuredResults),
+            }],
     };
 });
 /**

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "a11y-test-mcp",
-  "version": "1.0.7",
+  "version": "1.1.1",
   "main": "build/index.js",
   "scripts": {
     "postinstall": "npx -y playwright install",
     "build": "tsc && chmod 755 build/index.js",
     "start": "node build/index.js",
-    "lint": "eslint .",
-    "format": "npm run lint -- --fix"
+    "lint": "npm run lint:e && npm run lint:d",
+    "lint:e": "eslint .",
+    "lint:d": "dprint check",
+    "format": "dprint fmt"
   },
   "bin": {
     "a11y-test-mcp": "build/index.js"
@@ -43,6 +45,7 @@
   "devDependencies": {
     "@eslint/js": "^9.25.1",
     "@types/node": "^22.15.2",
+    "dprint": "^0.49.1",
     "eslint": "^9.25.1",
     "eslint-config-flat-gitignore": "^2.1.0",
     "typescript": "^5.8.3",

package/build/functions.d.ts

@@ -1,14 +0,0 @@
-import type { AccessibilityTestOutput } from './types';
-/**
- * Execute a11y test
- * @param {string[]} urls - URLs
- * @param {string[] | undefined} wcagStandards - WCAG standards to apply
- * @returns {AccessibilityTestOutput[]} - Results of the accessibility tests
- */
-export declare const execTest: (urls: string[], wcagStandards: string[] | undefined) => Promise<AccessibilityTestOutput[]>;
-/**
- * Convert structured results to text format
- * @param {AccessibilityTestOutput[]} structuredResults - Structured results from the tests
- * @returns {string} - Text representation of the results
- */
-export declare const convertTestResultToText: (structuredResults: AccessibilityTestOutput[]) => string;

package/build/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/build/types.d.ts

@@ -1,17 +0,0 @@
-import type { NodeResult } from 'axe-core';
-export interface ViolationSummary {
-    id: string;
-    impact?: 'minor' | 'moderate' | 'serious' | 'critical';
-    description: string;
-    helpUrl: string;
-    nodes: NodeResult[];
-}
-/** Update the main output structure */
-export interface AccessibilityTestOutput {
-    url: string;
-    violations?: ViolationSummary[];
-    passesCount?: number;
-    incompleteCount?: number;
-    inapplicableCount?: number;
-    error?: string;
-}

package/build/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });