a11y-devkit-deploy 0.8.8 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +4 -4
- package/templates/deploy-README.md +176 -32
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "a11y-devkit-deploy",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.0",
|
|
4
4
|
"description": "CLI to deploy a11y skills and MCP servers across IDEs",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -28,12 +28,12 @@
|
|
|
28
28
|
],
|
|
29
29
|
"repository": {
|
|
30
30
|
"type": "git",
|
|
31
|
-
"url": "https://github.com/joe-watkins/a11y-devkit.git"
|
|
31
|
+
"url": "https://github.com/joe-watkins/a11y-devkit-deploy.git"
|
|
32
32
|
},
|
|
33
33
|
"bugs": {
|
|
34
|
-
"url": "https://github.com/joe-watkins/a11y-devkit/issues"
|
|
34
|
+
"url": "https://github.com/joe-watkins/a11y-devkit-deploy/issues"
|
|
35
35
|
},
|
|
36
|
-
"homepage": "https://github.com/joe-watkins/a11y-devkit#readme",
|
|
36
|
+
"homepage": "https://github.com/joe-watkins/a11y-devkit-deploy#readme",
|
|
37
37
|
"author": "Joe Watkins",
|
|
38
38
|
"engines": {
|
|
39
39
|
"node": ">=18"
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# A11y DevKit - Skills & MCP Guide
|
|
2
2
|
|
|
3
|
-
Welcome to your comprehensive accessibility testing and remediation toolkit! You
|
|
3
|
+
Welcome to your comprehensive accessibility testing and remediation toolkit! You may have installed some of these skill based on your profile, but this guide will cover all the skills and MCP servers included in the A11y DevKit, along with example prompts and workflows to help you get the most out of them.
|
|
4
4
|
|
|
5
5
|
## What Was Installed
|
|
6
6
|
|
|
7
|
-
###
|
|
7
|
+
### Accessibility Skills
|
|
8
|
+
|
|
8
9
|
Your AI assistant can now leverage these specialized capabilities:
|
|
10
|
+
|
|
9
11
|
- **a11y-base-web** - Core accessibility patterns and foundational web code
|
|
10
12
|
- **a11y-issue-writer** - Document accessibility violations in standardized formats
|
|
11
13
|
- **a11y-tester** - Automated testing with axe-core and Playwright
|
|
@@ -14,13 +16,16 @@ Your AI assistant can now leverage these specialized capabilities:
|
|
|
14
16
|
- **web-standards** - Reference web standards and specifications
|
|
15
17
|
- **a11y-audit-fix-agent-orchestrator** - Coordinate full accessibility audits
|
|
16
18
|
|
|
17
|
-
###
|
|
19
|
+
### MCP Knowledge Servers
|
|
20
|
+
|
|
18
21
|
These servers provide instant access to accessibility guidelines and specifications:
|
|
22
|
+
|
|
19
23
|
- **wcag** - WCAG 2.2 guidelines, success criteria, and techniques
|
|
20
24
|
- **aria** - WAI-ARIA roles, states, properties, and patterns
|
|
21
25
|
- **magentaa11y** - Component accessibility acceptance criteria
|
|
22
26
|
- **a11y-personas** - User personas representing diverse accessibility needs
|
|
23
27
|
- **arc-issues** - Pre-formatted AxeCore violation issue templates
|
|
28
|
+
- **playwright** - Playwright testing patterns and best practices
|
|
24
29
|
|
|
25
30
|
## Quick Start
|
|
26
31
|
|
|
@@ -53,76 +58,90 @@ Using the a11y-tester skill, scan the homepage at https://example.com for access
|
|
|
53
58
|
|
|
54
59
|
### Skills (The Doers)
|
|
55
60
|
|
|
56
|
-
| Skill
|
|
57
|
-
|
|
58
|
-
| **a11y-base-web**
|
|
59
|
-
| **a11y-issue-writer**
|
|
60
|
-
| **a11y-tester**
|
|
61
|
-
| **a11y-remediator**
|
|
62
|
-
| **a11y-validator**
|
|
63
|
-
| **web-standards**
|
|
64
|
-
| **a11y-audit-fix-agent-orchestrator** | Coordinate end-to-end audits
|
|
61
|
+
| Skill | Purpose | When to Use |
|
|
62
|
+
| ------------------------------------- | ----------------------------------------- | --------------------------------------------------- |
|
|
63
|
+
| **a11y-base-web** | Foundational accessibility code patterns | Building new components with accessibility built-in |
|
|
64
|
+
| **a11y-issue-writer** | Create standardized accessibility reports | Documenting violations for teams or issue trackers |
|
|
65
|
+
| **a11y-tester** | Run automated accessibility scans | Testing pages or components for WCAG violations |
|
|
66
|
+
| **a11y-remediator** | Fix accessibility issues in code | Implementing solutions for identified problems |
|
|
67
|
+
| **a11y-validator** | Validate WCAG compliance | Verifying fixes meet accessibility standards |
|
|
68
|
+
| **web-standards** | Reference web specifications | Understanding semantic HTML and best practices |
|
|
69
|
+
| **a11y-audit-fix-agent-orchestrator** | Coordinate end-to-end audits | Running comprehensive accessibility assessments |
|
|
65
70
|
|
|
66
71
|
### MCP Servers (The Knowledge Base)
|
|
67
72
|
|
|
68
|
-
| Server
|
|
69
|
-
|
|
70
|
-
| **wcag**
|
|
71
|
-
| **aria**
|
|
72
|
-
| **magentaa11y**
|
|
73
|
-
| **a11y-personas** | User scenarios and needs
|
|
74
|
-
| **arc-issues**
|
|
73
|
+
| Server | Provides | Example Query |
|
|
74
|
+
| ----------------- | ---------------------------------------- | ----------------------------------------------------------------- |
|
|
75
|
+
| **wcag** | WCAG 2.2 guidelines and success criteria | "What are the requirements for WCAG 2.2 Level AA color contrast?" |
|
|
76
|
+
| **aria** | WAI-ARIA specification details | "What attributes are required for the dialog role?" |
|
|
77
|
+
| **magentaa11y** | Component acceptance criteria | "What are the accessibility requirements for a dropdown menu?" |
|
|
78
|
+
| **a11y-personas** | User scenarios and needs | "Show me personas who rely on keyboard navigation" |
|
|
79
|
+
| **arc-issues** | Formatted AxeCore violation templates | "Format this color contrast violation as a GitHub issue" |
|
|
75
80
|
|
|
76
81
|
## Example Prompts Library
|
|
77
82
|
|
|
78
83
|
### Getting Started (Beginner)
|
|
79
84
|
|
|
80
85
|
#### 1. Simple Page Scan
|
|
86
|
+
|
|
81
87
|
```
|
|
82
88
|
Use a11y-tester to scan https://mywebsite.com and list the top 5 most critical accessibility issues.
|
|
83
89
|
```
|
|
90
|
+
|
|
84
91
|
**Uses**: a11y-tester skill
|
|
85
92
|
**Outcome**: Quick overview of major violations
|
|
86
93
|
|
|
87
94
|
#### 2. Check WCAG Requirements
|
|
95
|
+
|
|
88
96
|
```
|
|
89
97
|
Query the wcag MCP server: What are the Level AA requirements for keyboard accessibility?
|
|
90
98
|
```
|
|
99
|
+
|
|
91
100
|
**Uses**: wcag MCP server
|
|
92
101
|
**Outcome**: Specific WCAG 2.2 success criteria and techniques
|
|
93
102
|
|
|
94
103
|
#### 3. Fix a Specific Issue
|
|
104
|
+
|
|
95
105
|
```
|
|
96
106
|
Using a11y-remediator, fix the missing alt text on images in src/components/Gallery.tsx
|
|
97
107
|
```
|
|
108
|
+
|
|
98
109
|
**Uses**: a11y-remediator skill
|
|
99
110
|
**Outcome**: Code updated with proper alt attributes
|
|
100
111
|
|
|
101
112
|
#### 4. Understand ARIA Roles
|
|
113
|
+
|
|
102
114
|
```
|
|
103
115
|
Ask the aria MCP server: What's the difference between role="button" and a native button element?
|
|
104
116
|
```
|
|
117
|
+
|
|
105
118
|
**Uses**: aria MCP server
|
|
106
119
|
**Outcome**: Explanation of semantic differences and best practices
|
|
107
120
|
|
|
108
121
|
#### 5. Document an Issue
|
|
122
|
+
|
|
109
123
|
```
|
|
110
124
|
Use a11y-issue-writer to create a GitHub issue for the form label violations found in our checkout page.
|
|
111
125
|
```
|
|
126
|
+
|
|
112
127
|
**Uses**: a11y-issue-writer skill
|
|
113
128
|
**Outcome**: Formatted issue ready to post
|
|
114
129
|
|
|
115
130
|
#### 6. Validate a Component
|
|
131
|
+
|
|
116
132
|
```
|
|
117
133
|
Use a11y-validator to check if the modal dialog in src/Modal.tsx meets WCAG 2.2 Level AA standards.
|
|
118
134
|
```
|
|
135
|
+
|
|
119
136
|
**Uses**: a11y-validator skill
|
|
120
137
|
**Outcome**: Compliance report with pass/fail status
|
|
121
138
|
|
|
122
139
|
#### 7. Learn Component Patterns
|
|
140
|
+
|
|
123
141
|
```
|
|
124
142
|
Query magentaa11y MCP: What are the acceptance criteria for an accessible tabs component?
|
|
125
143
|
```
|
|
144
|
+
|
|
126
145
|
**Uses**: magentaa11y MCP server
|
|
127
146
|
**Outcome**: Comprehensive accessibility requirements checklist
|
|
128
147
|
|
|
@@ -133,141 +152,183 @@ Query magentaa11y MCP: What are the acceptance criteria for an accessible tabs c
|
|
|
133
152
|
#### a11y-base-web Skill
|
|
134
153
|
|
|
135
154
|
**1. Build an Accessible Form**
|
|
155
|
+
|
|
136
156
|
```
|
|
137
157
|
Using a11y-base-web, create a contact form component with proper labels, error messages, and ARIA attributes.
|
|
138
158
|
```
|
|
159
|
+
|
|
139
160
|
**Outcome**: Form component with accessibility best practices built-in
|
|
140
161
|
|
|
141
162
|
**2. Implement Skip Links**
|
|
163
|
+
|
|
142
164
|
```
|
|
143
165
|
Use a11y-base-web to add skip navigation links to our main layout component in src/Layout.tsx
|
|
144
166
|
```
|
|
167
|
+
|
|
145
168
|
**Outcome**: Skip links added with proper focus management
|
|
146
169
|
|
|
147
170
|
**3. Create Accessible Tables**
|
|
171
|
+
|
|
148
172
|
```
|
|
149
173
|
With a11y-base-web, refactor the data table in src/DataGrid.tsx to use proper table semantics and ARIA where needed.
|
|
150
174
|
```
|
|
175
|
+
|
|
151
176
|
**Outcome**: Table with proper headers, scope, and ARIA attributes
|
|
152
177
|
|
|
153
178
|
#### a11y-issue-writer Skill
|
|
154
179
|
|
|
155
180
|
**1. Generate Batch Issue Reports**
|
|
181
|
+
|
|
156
182
|
```
|
|
157
183
|
Use a11y-issue-writer to create separate GitHub issues for each unique violation type found in our latest accessibility scan.
|
|
158
184
|
```
|
|
185
|
+
|
|
159
186
|
**Outcome**: Multiple formatted issues ready for tracking
|
|
160
187
|
|
|
161
188
|
**2. Document Color Contrast Failures**
|
|
189
|
+
|
|
162
190
|
```
|
|
163
191
|
With a11y-issue-writer, create a detailed report of all color contrast violations on our marketing pages, including screenshots and WCAG references.
|
|
164
192
|
```
|
|
193
|
+
|
|
165
194
|
**Outcome**: Comprehensive report with remediation guidance
|
|
166
195
|
|
|
167
196
|
**3. Create Sprint Planning Documentation**
|
|
197
|
+
|
|
168
198
|
```
|
|
169
199
|
Use a11y-issue-writer to generate a prioritized list of accessibility fixes for our next sprint, organized by WCAG level and impact.
|
|
170
200
|
```
|
|
201
|
+
|
|
171
202
|
**Outcome**: Prioritized backlog items for team planning
|
|
172
203
|
|
|
173
204
|
#### a11y-tester Skill
|
|
174
205
|
|
|
175
206
|
**1. Test Component Library**
|
|
207
|
+
|
|
176
208
|
```
|
|
177
209
|
Use a11y-tester to scan all components in our Storybook at http://localhost:6006 and generate a summary report.
|
|
178
210
|
```
|
|
211
|
+
|
|
179
212
|
**Outcome**: Component-by-component accessibility assessment
|
|
180
213
|
|
|
181
214
|
**2. Regression Testing**
|
|
215
|
+
|
|
182
216
|
```
|
|
183
217
|
With a11y-tester, scan our production site and compare results to the baseline from last week to identify new violations.
|
|
184
218
|
```
|
|
219
|
+
|
|
185
220
|
**Outcome**: Diff report showing newly introduced issues
|
|
186
221
|
|
|
187
222
|
**3. Test User Flows**
|
|
223
|
+
|
|
188
224
|
```
|
|
189
225
|
Use a11y-tester to test the complete checkout flow from cart to confirmation, checking each step for accessibility issues.
|
|
190
226
|
```
|
|
227
|
+
|
|
191
228
|
**Outcome**: Multi-page accessibility audit of critical path
|
|
192
229
|
|
|
193
230
|
#### a11y-remediator Skill
|
|
194
231
|
|
|
195
232
|
**1. Fix Form Validation**
|
|
233
|
+
|
|
196
234
|
```
|
|
197
235
|
Using a11y-remediator, update our form validation in src/forms/ to provide accessible error messages with proper ARIA attributes.
|
|
198
236
|
```
|
|
237
|
+
|
|
199
238
|
**Outcome**: Forms with screen reader-friendly error handling
|
|
200
239
|
|
|
201
240
|
**2. Remediate Focus Management**
|
|
241
|
+
|
|
202
242
|
```
|
|
203
243
|
Use a11y-remediator to fix focus issues in our modal dialogs, ensuring focus is trapped and returned properly.
|
|
204
244
|
```
|
|
245
|
+
|
|
205
246
|
**Outcome**: Modals with proper keyboard trap and focus restoration
|
|
206
247
|
|
|
207
248
|
**3. Update Images for Accessibility**
|
|
249
|
+
|
|
208
250
|
```
|
|
209
251
|
With a11y-remediator, audit and fix all images in src/components/ to have appropriate alt text or aria-hidden.
|
|
210
252
|
```
|
|
253
|
+
|
|
211
254
|
**Outcome**: Images properly labeled or marked as decorative
|
|
212
255
|
|
|
213
256
|
#### a11y-validator Skill
|
|
214
257
|
|
|
215
258
|
**1. Pre-deployment Validation**
|
|
259
|
+
|
|
216
260
|
```
|
|
217
261
|
Use a11y-validator to verify our staging environment at https://staging.mysite.com meets WCAG 2.2 Level AA before we deploy to production.
|
|
218
262
|
```
|
|
263
|
+
|
|
219
264
|
**Outcome**: Go/no-go compliance report
|
|
220
265
|
|
|
221
266
|
**2. Component Certification**
|
|
267
|
+
|
|
222
268
|
```
|
|
223
269
|
With a11y-validator, check if our new autocomplete component meets all WCAG success criteria and ARIA authoring practices.
|
|
224
270
|
```
|
|
271
|
+
|
|
225
272
|
**Outcome**: Detailed compliance checklist for component
|
|
226
273
|
|
|
227
274
|
**3. Validate Fixes**
|
|
275
|
+
|
|
228
276
|
```
|
|
229
277
|
Use a11y-validator to confirm that the color contrast issues we fixed in PR #123 now meet WCAG requirements.
|
|
230
278
|
```
|
|
279
|
+
|
|
231
280
|
**Outcome**: Verification that remediation was successful
|
|
232
281
|
|
|
233
282
|
#### web-standards Skill
|
|
234
283
|
|
|
235
284
|
**1. Semantic HTML Review**
|
|
285
|
+
|
|
236
286
|
```
|
|
237
287
|
Using web-standards, review src/pages/About.tsx and suggest improvements for proper semantic HTML structure.
|
|
238
288
|
```
|
|
289
|
+
|
|
239
290
|
**Outcome**: Recommendations for header hierarchy, landmarks, etc.
|
|
240
291
|
|
|
241
292
|
**2. Best Practices Audit**
|
|
293
|
+
|
|
242
294
|
```
|
|
243
295
|
With web-standards, analyze our navigation component and suggest improvements based on HTML5 and ARIA best practices.
|
|
244
296
|
```
|
|
297
|
+
|
|
245
298
|
**Outcome**: Specific recommendations with standards references
|
|
246
299
|
|
|
247
300
|
**3. Progressive Enhancement Check**
|
|
301
|
+
|
|
248
302
|
```
|
|
249
303
|
Use web-standards to evaluate if our interactive components work without JavaScript and follow progressive enhancement principles.
|
|
250
304
|
```
|
|
305
|
+
|
|
251
306
|
**Outcome**: Assessment of baseline functionality and enhancement layers
|
|
252
307
|
|
|
253
308
|
#### a11y-audit-fix-agent-orchestrator Skill
|
|
254
309
|
|
|
255
310
|
**1. Full Site Audit**
|
|
311
|
+
|
|
256
312
|
```
|
|
257
313
|
Using a11y-audit-fix-agent-orchestrator, perform a complete accessibility audit of https://mysite.com and create a remediation plan.
|
|
258
314
|
```
|
|
315
|
+
|
|
259
316
|
**Outcome**: Comprehensive audit report with prioritized fix recommendations
|
|
260
317
|
|
|
261
318
|
**2. Automated Fix Pipeline**
|
|
319
|
+
|
|
262
320
|
```
|
|
263
321
|
With a11y-audit-fix-agent-orchestrator, scan our codebase, identify issues, attempt automated fixes, and report what requires manual intervention.
|
|
264
322
|
```
|
|
323
|
+
|
|
265
324
|
**Outcome**: Batch of automated fixes plus list of manual tasks
|
|
266
325
|
|
|
267
326
|
**3. Continuous Monitoring Setup**
|
|
327
|
+
|
|
268
328
|
```
|
|
269
329
|
Use a11y-audit-fix-agent-orchestrator to set up a weekly accessibility audit workflow that tests, reports, and suggests fixes.
|
|
270
330
|
```
|
|
331
|
+
|
|
271
332
|
**Outcome**: Automated monitoring configuration
|
|
272
333
|
|
|
273
334
|
---
|
|
@@ -277,101 +338,131 @@ Use a11y-audit-fix-agent-orchestrator to set up a weekly accessibility audit wor
|
|
|
277
338
|
#### wcag MCP Server
|
|
278
339
|
|
|
279
340
|
**1. Research Success Criteria**
|
|
341
|
+
|
|
280
342
|
```
|
|
281
343
|
Query wcag MCP: What are all Level AA success criteria related to keyboard accessibility in WCAG 2.2?
|
|
282
344
|
```
|
|
345
|
+
|
|
283
346
|
**Outcome**: Complete list of relevant success criteria with descriptions
|
|
284
347
|
|
|
285
348
|
**2. Understand Techniques**
|
|
349
|
+
|
|
286
350
|
```
|
|
287
351
|
Ask wcag MCP: What techniques can I use to meet success criterion 1.4.3 Contrast (Minimum)?
|
|
288
352
|
```
|
|
353
|
+
|
|
289
354
|
**Outcome**: List of sufficient techniques and advisory techniques
|
|
290
355
|
|
|
291
356
|
**3. Compare WCAG Versions**
|
|
357
|
+
|
|
292
358
|
```
|
|
293
359
|
Query wcag MCP: What new success criteria were added in WCAG 2.2 compared to 2.1?
|
|
294
360
|
```
|
|
361
|
+
|
|
295
362
|
**Outcome**: Changelog of new requirements
|
|
296
363
|
|
|
297
364
|
#### aria MCP Server
|
|
298
365
|
|
|
299
366
|
**1. Role Requirements**
|
|
367
|
+
|
|
300
368
|
```
|
|
301
369
|
Ask aria MCP: What states and properties are required vs. supported for the combobox role?
|
|
302
370
|
```
|
|
371
|
+
|
|
303
372
|
**Outcome**: Complete list of required and optional ARIA attributes
|
|
304
373
|
|
|
305
374
|
**2. Pattern Implementation**
|
|
375
|
+
|
|
306
376
|
```
|
|
307
377
|
Query aria MCP: Show me the keyboard interaction pattern for an accordion widget.
|
|
308
378
|
```
|
|
379
|
+
|
|
309
380
|
**Outcome**: Detailed keyboard navigation requirements
|
|
310
381
|
|
|
311
382
|
**3. Attribute Values**
|
|
383
|
+
|
|
312
384
|
```
|
|
313
385
|
Ask aria MCP: What are the valid values for aria-live and when should I use each?
|
|
314
386
|
```
|
|
387
|
+
|
|
315
388
|
**Outcome**: Explanation of polite, assertive, and off values with use cases
|
|
316
389
|
|
|
317
390
|
#### magentaa11y MCP Server
|
|
318
391
|
|
|
319
392
|
**1. Component Acceptance Criteria**
|
|
393
|
+
|
|
320
394
|
```
|
|
321
395
|
Query magentaa11y MCP: What are the accessibility acceptance criteria for a date picker component?
|
|
322
396
|
```
|
|
397
|
+
|
|
323
398
|
**Outcome**: Comprehensive checklist of requirements
|
|
324
399
|
|
|
325
400
|
**2. Testing Scenarios**
|
|
401
|
+
|
|
326
402
|
```
|
|
327
403
|
Ask magentaa11y MCP: What should I test when validating an accessible navigation menu?
|
|
328
404
|
```
|
|
405
|
+
|
|
329
406
|
**Outcome**: List of test scenarios and expected behaviors
|
|
330
407
|
|
|
331
408
|
**3. Implementation Guidance**
|
|
409
|
+
|
|
332
410
|
```
|
|
333
411
|
Query magentaa11y MCP: What are the developer notes for implementing an accessible tooltip?
|
|
334
412
|
```
|
|
413
|
+
|
|
335
414
|
**Outcome**: Code examples and implementation guidance
|
|
336
415
|
|
|
337
416
|
#### a11y-personas MCP Server
|
|
338
417
|
|
|
339
418
|
**1. Understand User Needs**
|
|
419
|
+
|
|
340
420
|
```
|
|
341
421
|
Query a11y-personas MCP: Show me personas who use screen readers and their primary challenges.
|
|
342
422
|
```
|
|
423
|
+
|
|
343
424
|
**Outcome**: Detailed persona profiles with assistive tech usage
|
|
344
425
|
|
|
345
426
|
**2. Test Perspective**
|
|
427
|
+
|
|
346
428
|
```
|
|
347
429
|
Ask a11y-personas MCP: What would a user with motor disabilities experience when using our navigation?
|
|
348
430
|
```
|
|
431
|
+
|
|
349
432
|
**Outcome**: User scenario highlighting potential issues
|
|
350
433
|
|
|
351
434
|
**3. Design Validation**
|
|
435
|
+
|
|
352
436
|
```
|
|
353
437
|
Query a11y-personas MCP: Which personas would be affected by small click targets and how?
|
|
354
438
|
```
|
|
439
|
+
|
|
355
440
|
**Outcome**: Impact analysis across different disability types
|
|
356
441
|
|
|
357
442
|
#### arc-issues MCP Server
|
|
358
443
|
|
|
359
444
|
**1. Format Violations**
|
|
445
|
+
|
|
360
446
|
```
|
|
361
447
|
Query arc-issues MCP: Format this AxeCore color-contrast violation as a GitHub issue with all details.
|
|
362
448
|
```
|
|
449
|
+
|
|
363
450
|
**Outcome**: Ready-to-post issue with title, description, and remediation steps
|
|
364
451
|
|
|
365
452
|
**2. Batch Issue Creation**
|
|
453
|
+
|
|
366
454
|
```
|
|
367
455
|
Ask arc-issues MCP: Convert these 5 AxeCore violations into separate Jira tickets with appropriate labels.
|
|
368
456
|
```
|
|
457
|
+
|
|
369
458
|
**Outcome**: Multiple formatted tickets for issue tracking
|
|
370
459
|
|
|
371
460
|
**3. Standardized Reporting**
|
|
461
|
+
|
|
372
462
|
```
|
|
373
463
|
Query arc-issues MCP: Create a markdown report from this AxeCore scan result that I can add to our PR.
|
|
374
464
|
```
|
|
465
|
+
|
|
375
466
|
**Outcome**: Formatted report suitable for version control
|
|
376
467
|
|
|
377
468
|
---
|
|
@@ -379,107 +470,137 @@ Query arc-issues MCP: Create a markdown report from this AxeCore scan result tha
|
|
|
379
470
|
### Combined Workflows (Advanced)
|
|
380
471
|
|
|
381
472
|
#### 1. Research-Driven Remediation
|
|
473
|
+
|
|
382
474
|
```
|
|
383
475
|
First, query wcag MCP for the requirements of success criterion 4.1.2. Then use a11y-remediator to fix the name/role/value issues in src/components/CustomButton.tsx based on those requirements.
|
|
384
476
|
```
|
|
477
|
+
|
|
385
478
|
**Uses**: wcag MCP + a11y-remediator
|
|
386
479
|
**Outcome**: Standards-compliant fix with proper justification
|
|
387
480
|
|
|
388
481
|
#### 2. Persona-Based Testing
|
|
482
|
+
|
|
389
483
|
```
|
|
390
484
|
Query a11y-personas MCP to understand keyboard-only users' needs, then use a11y-tester to specifically test keyboard navigation on our dashboard, documenting findings with a11y-issue-writer.
|
|
391
485
|
```
|
|
486
|
+
|
|
392
487
|
**Uses**: a11y-personas MCP + a11y-tester + a11y-issue-writer
|
|
393
488
|
**Outcome**: User-centered test results with documented issues
|
|
394
489
|
|
|
395
490
|
#### 3. Pattern-Based Development
|
|
491
|
+
|
|
396
492
|
```
|
|
397
493
|
Ask magentaa11y MCP for the acceptance criteria for an accessible carousel, then use a11y-base-web to implement it, and a11y-validator to confirm compliance.
|
|
398
494
|
```
|
|
495
|
+
|
|
399
496
|
**Uses**: magentaa11y MCP + a11y-base-web + a11y-validator
|
|
400
497
|
**Outcome**: Fully accessible component built to specification
|
|
401
498
|
|
|
402
499
|
#### 4. Standards-Based Audit
|
|
500
|
+
|
|
403
501
|
```
|
|
404
502
|
Use web-standards to review our semantic HTML, query aria MCP for proper ARIA usage, then use a11y-validator to confirm everything meets WCAG 2.2 Level AA.
|
|
405
503
|
```
|
|
504
|
+
|
|
406
505
|
**Uses**: web-standards + aria MCP + a11y-validator
|
|
407
506
|
**Outcome**: Multi-faceted standards compliance check
|
|
408
507
|
|
|
409
508
|
#### 5. Comprehensive Issue Documentation
|
|
509
|
+
|
|
410
510
|
```
|
|
411
511
|
Use a11y-tester to scan our site, query wcag MCP to get the relevant success criteria for each violation, then use a11y-issue-writer to create detailed GitHub issues with WCAG references.
|
|
412
512
|
```
|
|
513
|
+
|
|
413
514
|
**Uses**: a11y-tester + wcag MCP + a11y-issue-writer
|
|
414
515
|
**Outcome**: Well-documented issues with standards citations
|
|
415
516
|
|
|
416
517
|
#### 6. Component Library Validation
|
|
518
|
+
|
|
417
519
|
```
|
|
418
520
|
For each component in src/components/, query magentaa11y MCP for acceptance criteria, use a11y-validator to test against those criteria, and generate a compliance matrix.
|
|
419
521
|
```
|
|
522
|
+
|
|
420
523
|
**Uses**: magentaa11y MCP + a11y-validator
|
|
421
524
|
**Outcome**: Component library accessibility certification report
|
|
422
525
|
|
|
423
526
|
#### 7. Fix Verification Workflow
|
|
527
|
+
|
|
424
528
|
```
|
|
425
529
|
Use a11y-tester to identify issues, a11y-remediator to fix them, then a11y-validator to confirm the fixes meet requirements, documenting the changes with a11y-issue-writer.
|
|
426
530
|
```
|
|
531
|
+
|
|
427
532
|
**Uses**: a11y-tester + a11y-remediator + a11y-validator + a11y-issue-writer
|
|
428
533
|
**Outcome**: Complete test-fix-verify-document cycle
|
|
429
534
|
|
|
430
535
|
#### 8. ARIA Pattern Implementation
|
|
536
|
+
|
|
431
537
|
```
|
|
432
538
|
Query aria MCP for the disclosure widget pattern requirements, use a11y-base-web to implement it, test with a11y-tester, and validate with a11y-validator.
|
|
433
539
|
```
|
|
540
|
+
|
|
434
541
|
**Uses**: aria MCP + a11y-base-web + a11y-tester + a11y-validator
|
|
435
542
|
**Outcome**: Spec-compliant ARIA widget with test verification
|
|
436
543
|
|
|
437
544
|
#### 9. User-Centered Design Review
|
|
545
|
+
|
|
438
546
|
```
|
|
439
547
|
Query a11y-personas MCP for diverse user needs, use web-standards to ensure semantic HTML foundation, then a11y-remediator to enhance with proper ARIA where semantics fall short.
|
|
440
548
|
```
|
|
549
|
+
|
|
441
550
|
**Uses**: a11y-personas MCP + web-standards + a11y-remediator
|
|
442
551
|
**Outcome**: User-focused accessible implementation
|
|
443
552
|
|
|
444
553
|
#### 10. Regression Prevention
|
|
554
|
+
|
|
445
555
|
```
|
|
446
556
|
Use a11y-tester to scan before merging PR, query wcag MCP for any new violations' requirements, use a11y-remediator to fix them, then a11y-validator to confirm before deployment.
|
|
447
557
|
```
|
|
558
|
+
|
|
448
559
|
**Uses**: a11y-tester + wcag MCP + a11y-remediator + a11y-validator
|
|
449
560
|
**Outcome**: Automated accessibility gate in CI/CD
|
|
450
561
|
|
|
451
562
|
#### 11. Documentation-First Development
|
|
563
|
+
|
|
452
564
|
```
|
|
453
565
|
Query magentaa11y MCP for component requirements, use a11y-base-web to scaffold the component, document expected behavior with a11y-issue-writer, then validate with a11y-validator.
|
|
454
566
|
```
|
|
567
|
+
|
|
455
568
|
**Uses**: magentaa11y MCP + a11y-base-web + a11y-issue-writer + a11y-validator
|
|
456
569
|
**Outcome**: Well-documented, specification-driven component
|
|
457
570
|
|
|
458
571
|
#### 12. Cross-Reference Validation
|
|
572
|
+
|
|
459
573
|
```
|
|
460
574
|
Use a11y-tester to find violations, query both wcag MCP and aria MCP to understand the requirements, then use a11y-remediator to implement fixes that satisfy both specifications.
|
|
461
575
|
```
|
|
576
|
+
|
|
462
577
|
**Uses**: a11y-tester + wcag MCP + aria MCP + a11y-remediator
|
|
463
578
|
**Outcome**: Fixes validated against multiple standards
|
|
464
579
|
|
|
465
580
|
#### 13. Issue Triage Pipeline
|
|
581
|
+
|
|
466
582
|
```
|
|
467
583
|
Use a11y-tester to scan multiple pages, query wcag MCP to determine WCAG level for each issue, use arc-issues MCP to format them, then a11y-issue-writer to add prioritization and assignment.
|
|
468
584
|
```
|
|
585
|
+
|
|
469
586
|
**Uses**: a11y-tester + wcag MCP + arc-issues MCP + a11y-issue-writer
|
|
470
587
|
**Outcome**: Prioritized, formatted issue backlog
|
|
471
588
|
|
|
472
589
|
#### 14. Accessibility Training Material
|
|
590
|
+
|
|
473
591
|
```
|
|
474
592
|
Query a11y-personas MCP for user scenarios, wcag MCP for requirements, magentaa11y MCP for component patterns, and use a11y-issue-writer to create training documentation.
|
|
475
593
|
```
|
|
594
|
+
|
|
476
595
|
**Uses**: a11y-personas MCP + wcag MCP + magentaa11y MCP + a11y-issue-writer
|
|
477
596
|
**Outcome**: Educational materials for team onboarding
|
|
478
597
|
|
|
479
598
|
#### 15. Third-Party Component Audit
|
|
599
|
+
|
|
480
600
|
```
|
|
481
601
|
Use web-standards to evaluate semantic foundation of a library component, query aria MCP for proper ARIA usage, use a11y-tester to scan it, and a11y-validator to certify compliance.
|
|
482
602
|
```
|
|
603
|
+
|
|
483
604
|
**Uses**: web-standards + aria MCP + a11y-tester + a11y-validator
|
|
484
605
|
**Outcome**: Vendor component accessibility assessment
|
|
485
606
|
|
|
@@ -488,52 +609,62 @@ Use web-standards to evaluate semantic foundation of a library component, query
|
|
|
488
609
|
### Complete Audit Workflows (Advanced)
|
|
489
610
|
|
|
490
611
|
#### 1. Full Site Accessibility Audit
|
|
612
|
+
|
|
491
613
|
```
|
|
492
614
|
Using a11y-audit-fix-agent-orchestrator, perform a comprehensive audit of https://mysite.com, querying wcag MCP for requirements, aria MCP for patterns, and generating a complete remediation roadmap with prioritized issues documented via a11y-issue-writer.
|
|
493
615
|
```
|
|
616
|
+
|
|
494
617
|
**Outcome**: End-to-end audit report with actionable remediation plan
|
|
495
618
|
|
|
496
619
|
#### 2. Pre-Launch Compliance Check
|
|
620
|
+
|
|
497
621
|
```
|
|
498
622
|
Use the orchestrator to scan our staging environment, validate against WCAG 2.2 Level AA with a11y-validator, cross-reference findings with magentaa11y MCP acceptance criteria, and create a go/no-go report with all issues documented.
|
|
499
623
|
```
|
|
624
|
+
|
|
500
625
|
**Outcome**: Deployment readiness assessment with compliance status
|
|
501
626
|
|
|
502
627
|
#### 3. Automated Remediation Pipeline
|
|
628
|
+
|
|
503
629
|
```
|
|
504
630
|
Run the orchestrator to scan the codebase with a11y-tester, automatically fix common issues with a11y-remediator, validate fixes with a11y-validator, document remaining issues with a11y-issue-writer, and create PRs for manual review.
|
|
505
631
|
```
|
|
632
|
+
|
|
506
633
|
**Outcome**: Batch fixes applied, remaining work itemized and tracked
|
|
507
634
|
|
|
508
635
|
#### 4. Component Library Certification
|
|
636
|
+
|
|
509
637
|
```
|
|
510
638
|
Use the orchestrator to audit every component in src/components/, query magentaa11y MCP for each component type's requirements, validate with a11y-validator, and generate a comprehensive certification report showing compliance status.
|
|
511
639
|
```
|
|
640
|
+
|
|
512
641
|
**Outcome**: Component library accessibility certification matrix
|
|
513
642
|
|
|
514
643
|
#### 5. Continuous Accessibility Monitoring
|
|
644
|
+
|
|
515
645
|
```
|
|
516
646
|
Set up the orchestrator to run weekly scans with a11y-tester, compare results to previous baselines, query wcag MCP for any new violation types, automatically create issues via a11y-issue-writer for regressions, and alert the team.
|
|
517
647
|
```
|
|
648
|
+
|
|
518
649
|
**Outcome**: Automated accessibility monitoring and regression detection
|
|
519
650
|
|
|
520
651
|
---
|
|
521
652
|
|
|
522
653
|
## Quick Reference Cheat Sheet
|
|
523
654
|
|
|
524
|
-
| Task
|
|
525
|
-
|
|
526
|
-
| Scan a page for issues
|
|
527
|
-
| Fix missing alt text
|
|
528
|
-
| Document violations
|
|
529
|
-
| Check WCAG requirements
|
|
530
|
-
| Understand ARIA roles
|
|
531
|
-
| Get component patterns
|
|
532
|
-
| Validate compliance
|
|
533
|
-
| Review semantics
|
|
534
|
-
| Understand user needs
|
|
535
|
-
| Format AxeCore violations | arc-issues MCP
|
|
536
|
-
| Run full audit
|
|
655
|
+
| Task | Tool to Use | Example |
|
|
656
|
+
| ------------------------- | ----------------- | --------------------------------------------- |
|
|
657
|
+
| Scan a page for issues | a11y-tester | `Scan https://example.com with a11y-tester` |
|
|
658
|
+
| Fix missing alt text | a11y-remediator | `Fix alt text in src/Gallery.tsx` |
|
|
659
|
+
| Document violations | a11y-issue-writer | `Create GitHub issue for form errors` |
|
|
660
|
+
| Check WCAG requirements | wcag MCP | `Query wcag: color contrast requirements` |
|
|
661
|
+
| Understand ARIA roles | aria MCP | `Query aria: button role requirements` |
|
|
662
|
+
| Get component patterns | magentaa11y MCP | `Query magentaa11y: tabs acceptance criteria` |
|
|
663
|
+
| Validate compliance | a11y-validator | `Validate modal meets WCAG 2.2 AA` |
|
|
664
|
+
| Review semantics | web-standards | `Review HTML structure in src/Nav.tsx` |
|
|
665
|
+
| Understand user needs | a11y-personas MCP | `Query a11y-personas: screen reader users` |
|
|
666
|
+
| Format AxeCore violations | arc-issues MCP | `Format this violation as Jira ticket` |
|
|
667
|
+
| Run full audit | orchestrator | `Audit https://mysite.com with orchestrator` |
|
|
537
668
|
|
|
538
669
|
---
|
|
539
670
|
|
|
@@ -544,33 +675,43 @@ Set up the orchestrator to run weekly scans with a11y-tester, compare results to
|
|
|
544
675
|
Your MCP servers run via `npx`, which means they're fetched on-demand and don't require local installation. To verify they're working, try these test prompts:
|
|
545
676
|
|
|
546
677
|
#### Test wcag MCP
|
|
678
|
+
|
|
547
679
|
```
|
|
548
680
|
Query the wcag MCP server: What is success criterion 2.1.1?
|
|
549
681
|
```
|
|
682
|
+
|
|
550
683
|
**Expected**: Details about keyboard accessibility requirements
|
|
551
684
|
|
|
552
685
|
#### Test aria MCP
|
|
686
|
+
|
|
553
687
|
```
|
|
554
688
|
Query the aria MCP server: What attributes does the button role support?
|
|
555
689
|
```
|
|
690
|
+
|
|
556
691
|
**Expected**: List of ARIA attributes applicable to buttons
|
|
557
692
|
|
|
558
693
|
#### Test magentaa11y MCP
|
|
694
|
+
|
|
559
695
|
```
|
|
560
696
|
Query the magentaa11y MCP server: List all available component types.
|
|
561
697
|
```
|
|
698
|
+
|
|
562
699
|
**Expected**: List of components with acceptance criteria
|
|
563
700
|
|
|
564
701
|
#### Test a11y-personas MCP
|
|
702
|
+
|
|
565
703
|
```
|
|
566
704
|
Query the a11y-personas MCP server: Show me all available personas.
|
|
567
705
|
```
|
|
706
|
+
|
|
568
707
|
**Expected**: List of user personas with disabilities
|
|
569
708
|
|
|
570
709
|
#### Test arc-issues MCP
|
|
710
|
+
|
|
571
711
|
```
|
|
572
712
|
Query the arc-issues MCP server: What issue formats are available?
|
|
573
713
|
```
|
|
714
|
+
|
|
574
715
|
**Expected**: List of supported formats (GitHub, Jira, etc.)
|
|
575
716
|
|
|
576
717
|
### Basic Troubleshooting
|
|
@@ -606,16 +747,19 @@ Where `{IDE}` is one of: `Claude`, `Cursor`, `Codex`, or `Code` (for VSCode)
|
|
|
606
747
|
### Common Issues
|
|
607
748
|
|
|
608
749
|
**"Skill not found"**
|
|
750
|
+
|
|
609
751
|
- Verify skills are installed in your IDE's skills directory
|
|
610
752
|
- Check that the skill name matches exactly (e.g., `a11y-tester`, not `a11y-testing`)
|
|
611
753
|
- Restart your IDE to reload skills
|
|
612
754
|
|
|
613
755
|
**"MCP server not responding"**
|
|
756
|
+
|
|
614
757
|
- Ensure you're querying the MCP server explicitly (e.g., "Query wcag MCP:")
|
|
615
758
|
- Restart your IDE to reinitialize MCP servers
|
|
616
759
|
- Check that npx is installed and working
|
|
617
760
|
|
|
618
761
|
**"Permission denied"**
|
|
762
|
+
|
|
619
763
|
- MCP servers run via npx and may need permission to execute
|
|
620
764
|
- Check your system's security settings for CLI tool execution
|
|
621
765
|
|