@mcptoolshop/accessibility-suite 0.1.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.
Files changed (241) hide show
  1. package/.github/workflows/ci.yml +63 -0
  2. package/LICENSE +21 -0
  3. package/README.md +37 -0
  4. package/docs/prov-spec/.github/workflows/ci.yml +68 -0
  5. package/docs/prov-spec/CHANGELOG.md +69 -0
  6. package/docs/prov-spec/CODE_OF_CONDUCT.md +129 -0
  7. package/docs/prov-spec/CONFORMANCE_LEVELS.md +223 -0
  8. package/docs/prov-spec/CONTRIBUTING.md +145 -0
  9. package/docs/prov-spec/IMPLEMENTER_CHECKLIST.md +137 -0
  10. package/docs/prov-spec/LICENSE +21 -0
  11. package/docs/prov-spec/PRESS_RELEASE.md +74 -0
  12. package/docs/prov-spec/README.md +182 -0
  13. package/docs/prov-spec/SETUP.md +135 -0
  14. package/docs/prov-spec/WHY.md +86 -0
  15. package/docs/prov-spec/examples/artifact.example.json +14 -0
  16. package/docs/prov-spec/examples/artifact.ref.example.json +9 -0
  17. package/docs/prov-spec/examples/evidence.example.json +6 -0
  18. package/docs/prov-spec/examples/mcp.envelope.example.json +97 -0
  19. package/docs/prov-spec/examples/mcp.request.example.json +28 -0
  20. package/docs/prov-spec/examples/prov.record.example.json +35 -0
  21. package/docs/prov-spec/interop/PROOF_NODE_ENGINE.md +114 -0
  22. package/docs/prov-spec/spec/MCP_COMPATIBILITY.md +241 -0
  23. package/docs/prov-spec/spec/PROV_METHODS_CATALOG.md +142 -0
  24. package/docs/prov-spec/spec/PROV_METHODS_SPEC.md +397 -0
  25. package/docs/prov-spec/spec/methods.json +213 -0
  26. package/docs/prov-spec/spec/schemas/artifact.ref.schema.v0.1.json +58 -0
  27. package/docs/prov-spec/spec/schemas/artifact.schema.v0.1.json +61 -0
  28. package/docs/prov-spec/spec/schemas/assist.request.schema.v0.1.json +52 -0
  29. package/docs/prov-spec/spec/schemas/assist.response.schema.v0.1.json +70 -0
  30. package/docs/prov-spec/spec/schemas/cli.error.schema.v0.1.json +78 -0
  31. package/docs/prov-spec/spec/schemas/evidence.schema.v0.1.json +37 -0
  32. package/docs/prov-spec/spec/schemas/mcp.envelope.schema.v0.1.json +141 -0
  33. package/docs/prov-spec/spec/schemas/mcp.request.schema.v0.1.json +79 -0
  34. package/docs/prov-spec/spec/schemas/methods.schema.json +93 -0
  35. package/docs/prov-spec/spec/schemas/prov-capabilities.schema.json +122 -0
  36. package/docs/prov-spec/spec/schemas/prov.record.schema.v0.1.json +133 -0
  37. package/docs/prov-spec/spec/vectors/adapter.wrap.envelope_v0_1/expected.json +4 -0
  38. package/docs/prov-spec/spec/vectors/adapter.wrap.envelope_v0_1/input.json +1 -0
  39. package/docs/prov-spec/spec/vectors/adapter.wrap.envelope_v0_1/negative/double_wrapped.json +14 -0
  40. package/docs/prov-spec/spec/vectors/adapter.wrap.envelope_v0_1/negative/wrong_schema_version.json +11 -0
  41. package/docs/prov-spec/spec/vectors/engine.extract.evidence.json_pointer/expected.json +24 -0
  42. package/docs/prov-spec/spec/vectors/engine.extract.evidence.json_pointer/input.json +8 -0
  43. package/docs/prov-spec/spec/vectors/integrity.digest.sha256/expected.json +7 -0
  44. package/docs/prov-spec/spec/vectors/integrity.digest.sha256/input.json +1 -0
  45. package/docs/prov-spec/spec/vectors/integrity.digest.sha256/negative/non_hex_chars.json +16 -0
  46. package/docs/prov-spec/spec/vectors/integrity.digest.sha256/negative/uppercase_hex.json +16 -0
  47. package/docs/prov-spec/spec/vectors/integrity.digest.sha256/negative/wrong_length.json +16 -0
  48. package/docs/prov-spec/spec/vectors/method_id_syntax/negative/hyphen_separator.json +8 -0
  49. package/docs/prov-spec/spec/vectors/method_id_syntax/negative/reserved_namespace.json +8 -0
  50. package/docs/prov-spec/spec/vectors/method_id_syntax/negative/starts_with_digit.json +8 -0
  51. package/docs/prov-spec/spec/vectors/method_id_syntax/negative/uppercase.json +8 -0
  52. package/docs/prov-spec/spec/vectors/method_id_syntax/positive/valid_ids.json +18 -0
  53. package/docs/prov-spec/tools/python/prov_validator.py +428 -0
  54. package/examples/a11y-demo-site/.github/workflows/a11y-artifacts.yml +81 -0
  55. package/examples/a11y-demo-site/.github/workflows/a11y.yml +34 -0
  56. package/examples/a11y-demo-site/CODE_OF_CONDUCT.md +129 -0
  57. package/examples/a11y-demo-site/CONTRIBUTING.md +83 -0
  58. package/examples/a11y-demo-site/LICENSE +21 -0
  59. package/examples/a11y-demo-site/README.md +155 -0
  60. package/examples/a11y-demo-site/html/contact.html +15 -0
  61. package/examples/a11y-demo-site/html/index.html +20 -0
  62. package/examples/a11y-demo-site/scripts/a11y.sh +20 -0
  63. package/package.json +26 -0
  64. package/src/a11y-assist/.github/workflows/publish.yml +52 -0
  65. package/src/a11y-assist/.github/workflows/test.yml +30 -0
  66. package/src/a11y-assist/A11Y_ASSIST_TEST_COVERAGE_REQUIREMENTS.md +104 -0
  67. package/src/a11y-assist/CODE_OF_CONDUCT.md +129 -0
  68. package/src/a11y-assist/CONTRIBUTING.md +98 -0
  69. package/src/a11y-assist/ENGINE.md +363 -0
  70. package/src/a11y-assist/LICENSE +21 -0
  71. package/src/a11y-assist/PRESS_RELEASE.md +71 -0
  72. package/src/a11y-assist/QUICKSTART.md +101 -0
  73. package/src/a11y-assist/README.md +192 -0
  74. package/src/a11y-assist/RELEASE_NOTES.md +319 -0
  75. package/src/a11y-assist/a11y_assist/__init__.py +3 -0
  76. package/src/a11y-assist/a11y_assist/cli.py +599 -0
  77. package/src/a11y-assist/a11y_assist/from_cli_error.py +149 -0
  78. package/src/a11y-assist/a11y_assist/guard.py +444 -0
  79. package/src/a11y-assist/a11y_assist/ingest.py +407 -0
  80. package/src/a11y-assist/a11y_assist/methods.py +137 -0
  81. package/src/a11y-assist/a11y_assist/parse_raw.py +71 -0
  82. package/src/a11y-assist/a11y_assist/profiles/__init__.py +29 -0
  83. package/src/a11y-assist/a11y_assist/profiles/cognitive_load.py +245 -0
  84. package/src/a11y-assist/a11y_assist/profiles/cognitive_load_render.py +86 -0
  85. package/src/a11y-assist/a11y_assist/profiles/dyslexia.py +144 -0
  86. package/src/a11y-assist/a11y_assist/profiles/dyslexia_render.py +77 -0
  87. package/src/a11y-assist/a11y_assist/profiles/plain_language.py +119 -0
  88. package/src/a11y-assist/a11y_assist/profiles/plain_language_render.py +66 -0
  89. package/src/a11y-assist/a11y_assist/profiles/screen_reader.py +348 -0
  90. package/src/a11y-assist/a11y_assist/profiles/screen_reader_render.py +89 -0
  91. package/src/a11y-assist/a11y_assist/render.py +95 -0
  92. package/src/a11y-assist/a11y_assist/schemas/assist.request.schema.v0.1.json +52 -0
  93. package/src/a11y-assist/a11y_assist/schemas/assist.response.schema.v0.1.json +70 -0
  94. package/src/a11y-assist/a11y_assist/schemas/cli.error.schema.v0.1.json +78 -0
  95. package/src/a11y-assist/a11y_assist/storage.py +31 -0
  96. package/src/a11y-assist/pyproject.toml +60 -0
  97. package/src/a11y-assist/tests/__init__.py +1 -0
  98. package/src/a11y-assist/tests/fixtures/base_inputs/cli_error_high.json +18 -0
  99. package/src/a11y-assist/tests/fixtures/base_inputs/cli_error_medium.json +16 -0
  100. package/src/a11y-assist/tests/fixtures/base_inputs/raw_text_low.txt +3 -0
  101. package/src/a11y-assist/tests/fixtures/cli_error_good.json +9 -0
  102. package/src/a11y-assist/tests/fixtures/cli_error_missing_id.json +7 -0
  103. package/src/a11y-assist/tests/fixtures/cli_error_string_format.json +7 -0
  104. package/src/a11y-assist/tests/fixtures/expected/cognitive_load_high.txt +20 -0
  105. package/src/a11y-assist/tests/fixtures/expected/dyslexia_high.txt +20 -0
  106. package/src/a11y-assist/tests/fixtures/expected/lowvision_high.txt +18 -0
  107. package/src/a11y-assist/tests/fixtures/expected/plain_language_high.txt +14 -0
  108. package/src/a11y-assist/tests/fixtures/expected/screen_reader_high.txt +19 -0
  109. package/src/a11y-assist/tests/fixtures/golden_screen_reader_cli_error.txt +16 -0
  110. package/src/a11y-assist/tests/fixtures/golden_screen_reader_raw_no_id.txt +14 -0
  111. package/src/a11y-assist/tests/fixtures/golden_screen_reader_raw_with_id.txt +14 -0
  112. package/src/a11y-assist/tests/fixtures/raw_good.txt +11 -0
  113. package/src/a11y-assist/tests/fixtures/raw_no_id.txt +2 -0
  114. package/src/a11y-assist/tests/test_cognitive_load.py +469 -0
  115. package/src/a11y-assist/tests/test_dyslexia.py +337 -0
  116. package/src/a11y-assist/tests/test_explain.py +74 -0
  117. package/src/a11y-assist/tests/test_golden.py +127 -0
  118. package/src/a11y-assist/tests/test_guard.py +819 -0
  119. package/src/a11y-assist/tests/test_guard_integration.py +457 -0
  120. package/src/a11y-assist/tests/test_ingest.py +311 -0
  121. package/src/a11y-assist/tests/test_methods_metadata.py +236 -0
  122. package/src/a11y-assist/tests/test_plain_language.py +348 -0
  123. package/src/a11y-assist/tests/test_render.py +117 -0
  124. package/src/a11y-assist/tests/test_screen_reader.py +703 -0
  125. package/src/a11y-assist/tests/test_storage_last.py +61 -0
  126. package/src/a11y-assist/tests/test_triage.py +86 -0
  127. package/src/a11y-ci/.github/workflows/ci.yml +43 -0
  128. package/src/a11y-ci/.github/workflows/test.yml +30 -0
  129. package/src/a11y-ci/A11Y_CI_TEST_COVERAGE_REQUIREMENTS.md +94 -0
  130. package/src/a11y-ci/CODE_OF_CONDUCT.md +129 -0
  131. package/src/a11y-ci/CONTRIBUTING.md +142 -0
  132. package/src/a11y-ci/LICENSE +21 -0
  133. package/src/a11y-ci/README.md +105 -0
  134. package/src/a11y-ci/a11y_ci/__init__.py +3 -0
  135. package/src/a11y-ci/a11y_ci/allowlist.py +83 -0
  136. package/src/a11y-ci/a11y_ci/cli.py +145 -0
  137. package/src/a11y-ci/a11y_ci/gate.py +131 -0
  138. package/src/a11y-ci/a11y_ci/render.py +48 -0
  139. package/src/a11y-ci/a11y_ci/schemas/allowlist.schema.json +24 -0
  140. package/src/a11y-ci/a11y_ci/scorecard.py +99 -0
  141. package/src/a11y-ci/npm/package.json +35 -0
  142. package/src/a11y-ci/pyproject.toml +64 -0
  143. package/src/a11y-ci/tests/__init__.py +1 -0
  144. package/src/a11y-ci/tests/fixtures/allowlist_expired.json +10 -0
  145. package/src/a11y-ci/tests/fixtures/allowlist_ok.json +10 -0
  146. package/src/a11y-ci/tests/fixtures/baseline_ok.json +7 -0
  147. package/src/a11y-ci/tests/fixtures/current_fail.json +6 -0
  148. package/src/a11y-ci/tests/fixtures/current_ok.json +6 -0
  149. package/src/a11y-ci/tests/fixtures/current_regresses.json +7 -0
  150. package/src/a11y-ci/tests/test_gate.py +134 -0
  151. package/src/a11y-evidence-engine/.github/workflows/ci.yml +53 -0
  152. package/src/a11y-evidence-engine/CODE_OF_CONDUCT.md +129 -0
  153. package/src/a11y-evidence-engine/CONTRIBUTING.md +128 -0
  154. package/src/a11y-evidence-engine/LICENSE +21 -0
  155. package/src/a11y-evidence-engine/README.md +71 -0
  156. package/src/a11y-evidence-engine/bin/a11y-engine.js +11 -0
  157. package/src/a11y-evidence-engine/fixtures/bad/button-no-name.html +30 -0
  158. package/src/a11y-evidence-engine/fixtures/bad/img-missing-alt.html +19 -0
  159. package/src/a11y-evidence-engine/fixtures/bad/input-missing-label.html +26 -0
  160. package/src/a11y-evidence-engine/fixtures/bad/missing-lang.html +11 -0
  161. package/src/a11y-evidence-engine/fixtures/good/index.html +29 -0
  162. package/src/a11y-evidence-engine/package-lock.json +109 -0
  163. package/src/a11y-evidence-engine/package.json +45 -0
  164. package/src/a11y-evidence-engine/src/cli.js +74 -0
  165. package/src/a11y-evidence-engine/src/evidence/canonicalize.js +52 -0
  166. package/src/a11y-evidence-engine/src/evidence/json_pointer.js +34 -0
  167. package/src/a11y-evidence-engine/src/evidence/prov_emit.js +153 -0
  168. package/src/a11y-evidence-engine/src/fswalk.js +56 -0
  169. package/src/a11y-evidence-engine/src/html_parse.js +117 -0
  170. package/src/a11y-evidence-engine/src/ids.js +53 -0
  171. package/src/a11y-evidence-engine/src/rules/document_missing_lang.js +50 -0
  172. package/src/a11y-evidence-engine/src/rules/form_control_missing_label.js +105 -0
  173. package/src/a11y-evidence-engine/src/rules/img_missing_alt.js +77 -0
  174. package/src/a11y-evidence-engine/src/rules/index.js +37 -0
  175. package/src/a11y-evidence-engine/src/rules/interactive_missing_name.js +129 -0
  176. package/src/a11y-evidence-engine/src/scan.js +128 -0
  177. package/src/a11y-evidence-engine/test/scan.test.js +149 -0
  178. package/src/a11y-evidence-engine/test/vectors.test.js +200 -0
  179. package/src/a11y-lint/.github/workflows/ci.yml +46 -0
  180. package/src/a11y-lint/.github/workflows/test.yml +34 -0
  181. package/src/a11y-lint/CODE_OF_CONDUCT.md +129 -0
  182. package/src/a11y-lint/CONTRIBUTING.md +70 -0
  183. package/src/a11y-lint/GOVERNANCE.md +57 -0
  184. package/src/a11y-lint/LICENSE +21 -0
  185. package/src/a11y-lint/PRESS_RELEASE.md +50 -0
  186. package/src/a11y-lint/README.md +276 -0
  187. package/src/a11y-lint/RELEASE_NOTES.md +57 -0
  188. package/src/a11y-lint/RELEASING.md +57 -0
  189. package/src/a11y-lint/a11y_lint/__init__.py +64 -0
  190. package/src/a11y-lint/a11y_lint/cli.py +319 -0
  191. package/src/a11y-lint/a11y_lint/errors.py +252 -0
  192. package/src/a11y-lint/a11y_lint/render.py +293 -0
  193. package/src/a11y-lint/a11y_lint/report_md.py +289 -0
  194. package/src/a11y-lint/a11y_lint/scan_cli_text.py +434 -0
  195. package/src/a11y-lint/a11y_lint/schemas/cli.error.schema.v0.1.json +83 -0
  196. package/src/a11y-lint/a11y_lint/scorecard.py +244 -0
  197. package/src/a11y-lint/a11y_lint/validate.py +225 -0
  198. package/src/a11y-lint/pyproject.toml +75 -0
  199. package/src/a11y-lint/tests/__init__.py +1 -0
  200. package/src/a11y-lint/tests/test_cli.py +200 -0
  201. package/src/a11y-lint/tests/test_errors.py +188 -0
  202. package/src/a11y-lint/tests/test_render.py +202 -0
  203. package/src/a11y-lint/tests/test_report_md.py +188 -0
  204. package/src/a11y-lint/tests/test_scan_cli_text.py +290 -0
  205. package/src/a11y-lint/tests/test_scorecard.py +195 -0
  206. package/src/a11y-lint/tests/test_validate.py +257 -0
  207. package/src/a11y-mcp-tools/.github/workflows/ci.yml +53 -0
  208. package/src/a11y-mcp-tools/CODE_OF_CONDUCT.md +129 -0
  209. package/src/a11y-mcp-tools/CONTRIBUTING.md +136 -0
  210. package/src/a11y-mcp-tools/LICENSE +21 -0
  211. package/src/a11y-mcp-tools/PROV_METHODS_CATALOG.md +104 -0
  212. package/src/a11y-mcp-tools/README.md +168 -0
  213. package/src/a11y-mcp-tools/bin/cli.js +452 -0
  214. package/src/a11y-mcp-tools/bin/server.js +244 -0
  215. package/src/a11y-mcp-tools/fixtures/requests/a11y.diagnose.ok.json +27 -0
  216. package/src/a11y-mcp-tools/fixtures/requests/a11y.evidence.ok.json +25 -0
  217. package/src/a11y-mcp-tools/fixtures/responses/a11y.diagnose.ok.json +139 -0
  218. package/src/a11y-mcp-tools/fixtures/responses/a11y.diagnose.provenance_fail.json +13 -0
  219. package/src/a11y-mcp-tools/fixtures/responses/a11y.evidence.ok.json +88 -0
  220. package/src/a11y-mcp-tools/package-lock.json +189 -0
  221. package/src/a11y-mcp-tools/package.json +49 -0
  222. package/src/a11y-mcp-tools/src/envelope.js +197 -0
  223. package/src/a11y-mcp-tools/src/index.js +9 -0
  224. package/src/a11y-mcp-tools/src/schemas/artifact.js +85 -0
  225. package/src/a11y-mcp-tools/src/schemas/diagnosis.schema.v0.1.json +137 -0
  226. package/src/a11y-mcp-tools/src/schemas/envelope.schema.v0.1.json +108 -0
  227. package/src/a11y-mcp-tools/src/schemas/evidence.bundle.schema.v0.1.json +129 -0
  228. package/src/a11y-mcp-tools/src/schemas/evidence.js +97 -0
  229. package/src/a11y-mcp-tools/src/schemas/index.js +11 -0
  230. package/src/a11y-mcp-tools/src/schemas/provenance.js +140 -0
  231. package/src/a11y-mcp-tools/src/schemas/tools/a11y.diagnose.request.schema.v0.1.json +77 -0
  232. package/src/a11y-mcp-tools/src/schemas/tools/a11y.diagnose.response.schema.v0.1.json +50 -0
  233. package/src/a11y-mcp-tools/src/schemas/tools/a11y.evidence.request.schema.v0.1.json +120 -0
  234. package/src/a11y-mcp-tools/src/schemas/tools/a11y.evidence.response.schema.v0.1.json +50 -0
  235. package/src/a11y-mcp-tools/src/tools/diagnose.js +597 -0
  236. package/src/a11y-mcp-tools/src/tools/evidence.js +481 -0
  237. package/src/a11y-mcp-tools/src/tools/index.js +10 -0
  238. package/src/a11y-mcp-tools/test/contract.test.mjs +154 -0
  239. package/src/a11y-mcp-tools/test/diagnose.test.js +485 -0
  240. package/src/a11y-mcp-tools/test/evidence.test.js +183 -0
  241. package/src/a11y-mcp-tools/test/schema.test.js +327 -0
@@ -0,0 +1,129 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+
65
+ All complaints will be reviewed and investigated promptly and fairly.
66
+
67
+ All community leaders are obligated to respect the privacy and security of the
68
+ reporter of any incident.
69
+
70
+ ## Enforcement Guidelines
71
+
72
+ Community leaders will follow these Community Impact Guidelines in determining
73
+ the consequences for any action they deem in violation of this Code of Conduct:
74
+
75
+ ### 1. Correction
76
+
77
+ **Community Impact**: Use of inappropriate language or other behavior deemed
78
+ unprofessional or unwelcome in the community.
79
+
80
+ **Consequence**: A private, written warning from community leaders, providing
81
+ clarity around the nature of the violation and an explanation of why the
82
+ behavior was inappropriate. A public apology may be requested.
83
+
84
+ ### 2. Warning
85
+
86
+ **Community Impact**: A violation through a single incident or series
87
+ of actions.
88
+
89
+ **Consequence**: A warning with consequences for continued behavior. No
90
+ interaction with the people involved, including unsolicited interaction with
91
+ those enforcing the Code of Conduct, for a specified period of time. This
92
+ includes avoiding interactions in community spaces as well as external channels
93
+ like social media. Violating these terms may lead to a temporary or
94
+ permanent ban.
95
+
96
+ ### 3. Temporary Ban
97
+
98
+ **Community Impact**: A serious violation of community standards, including
99
+ sustained inappropriate behavior.
100
+
101
+ **Consequence**: A temporary ban from any sort of interaction or public
102
+ communication with the community for a specified period of time. No public or
103
+ private interaction with the people involved, including unsolicited interaction
104
+ with those enforcing the Code of Conduct, is allowed during this period.
105
+ Violating these terms may lead to a permanent ban.
106
+
107
+ ### 4. Permanent Ban
108
+
109
+ **Community Impact**: Demonstrating a pattern of violation of community
110
+ standards, including sustained inappropriate behavior, harassment of an
111
+ individual, or aggression toward or disparagement of classes of individuals.
112
+
113
+ **Consequence**: A permanent ban from any sort of public interaction within
114
+ the community.
115
+
116
+ ## Attribution
117
+
118
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119
+ version 2.0, available at
120
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121
+
122
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
123
+ enforcement ladder](https://github.com/mozilla/diversity).
124
+
125
+ [homepage]: https://www.contributor-covenant.org
126
+
127
+ For answers to common questions about this code of conduct, see the FAQ at
128
+ https://www.contributor-covenant.org/faq. Translations are available at
129
+ https://www.contributor-covenant.org/translations.
@@ -0,0 +1,98 @@
1
+ # Contributing to Ally
2
+
3
+ Thank you for your interest in contributing to the Ally accessibility toolchain.
4
+
5
+ Ally is designed as **infrastructure**, not a feature playground.
6
+ Correctness, determinism, and user trust matter more than speed.
7
+
8
+ Please read this document carefully before submitting changes.
9
+
10
+ ---
11
+
12
+ ## Core principles (non-negotiable)
13
+
14
+ All contributions must respect these principles:
15
+
16
+ 1. **Additive only**
17
+ - Ally must never rewrite, hide, or correct ground-truth tool output.
18
+
19
+ 2. **Deterministic**
20
+ - Same input must always produce the same output.
21
+ - No randomness, timestamps, or network calls.
22
+
23
+ 3. **SAFE by default**
24
+ - v0.x must never emit RISKY or DESTRUCTIVE commands.
25
+ - Suggested commands must appear verbatim in the input.
26
+
27
+ 4. **Confidence-honest**
28
+ - Confidence may never increase.
29
+ - If input is ambiguous, Ally must say so.
30
+
31
+ 5. **Guarded**
32
+ - All profile transforms are subject to the Profile Guard.
33
+ - Guard violations are engine bugs and must not be bypassed.
34
+
35
+ ---
36
+
37
+ ## What kinds of contributions are welcome
38
+
39
+ ### ✅ Good contributions
40
+ - Bug fixes
41
+ - Documentation improvements
42
+ - Test coverage
43
+ - New profiles (following the profile contract)
44
+ - Reference integrations
45
+ - CI and tooling improvements
46
+
47
+ ### ❌ Not accepted (without major discussion)
48
+ - Auto-fix behavior
49
+ - Executing commands
50
+ - "Smart" inference that invents facts
51
+ - Removing safety checks
52
+ - Making output less explicit to appear "cleaner"
53
+
54
+ ---
55
+
56
+ ## Adding or modifying a profile
57
+
58
+ Profiles are **policy**, not intelligence.
59
+
60
+ When proposing a profile:
61
+ 1. Document the target audience.
62
+ 2. Define exact transformation rules.
63
+ 3. Define guard constraints.
64
+ 4. Add golden tests.
65
+ 5. Prove no new facts or commands are introduced.
66
+
67
+ If a change cannot be proven safe by tests, it must not ship.
68
+
69
+ ---
70
+
71
+ ## Tests are mandatory
72
+
73
+ Every PR must include tests that demonstrate:
74
+ - determinism
75
+ - invariant preservation
76
+ - no invented IDs
77
+ - no invented commands
78
+ - correct guard behavior
79
+
80
+ Golden tests are strongly preferred.
81
+
82
+ ---
83
+
84
+ ## Questions or uncertainty
85
+
86
+ If you are unsure whether a change aligns with Ally's philosophy:
87
+ - open an issue first
88
+ - describe the problem, not the solution
89
+
90
+ Maintainers will help guide the decision.
91
+
92
+ ---
93
+
94
+ ## Code of conduct
95
+
96
+ Be respectful. Be patient. Accessibility work affects real people.
97
+
98
+ Thank you for helping make developer tools more humane.
@@ -0,0 +1,363 @@
1
+ # Ally Engine Contract (a11y-assist)
2
+
3
+ **Status:** Finalized (v0.3.1)
4
+ **Scope:** Engine-level guarantees and invariants
5
+
6
+ Ally is a deterministic recovery engine for CLI failures.
7
+ It helps humans recover from errors without rewriting, hiding, or second-guessing the tool's original output.
8
+
9
+ This document defines the platform contract for Ally as an engine behind current and future applications.
10
+
11
+ ---
12
+
13
+ ## 1. Design goals (non-negotiable)
14
+
15
+ Ally is designed to be:
16
+
17
+ - **Additive** – never rewrites or suppresses ground-truth output
18
+ - **Deterministic** – same input always produces the same output
19
+ - **Safe by default** – v0.x emits SAFE-only command suggestions
20
+ - **Profile-driven** – presentation policies change *how*, not *what*
21
+ - **Guarded** – engine invariants are enforced at runtime
22
+ - **Adapter-friendly** – CLI today, MCP/IDE/CI adapters later
23
+
24
+ Ally is intentionally conservative. When in doubt, it withholds help rather than inventing it.
25
+
26
+ ---
27
+
28
+ ## 2. Ground truth vs Assist output
29
+
30
+ ### 2.1 Ground truth
31
+
32
+ Ground truth is produced by the tool that failed. Preferred formats:
33
+
34
+ - `cli.error.v0.1` JSON (highest confidence)
35
+ - `a11y-lint` scorecard JSON (medium confidence)
36
+ - Raw CLI text (lowest confidence; best-effort only)
37
+
38
+ **Ground truth is never modified by Ally.**
39
+
40
+ ### 2.2 Assist output
41
+
42
+ Assist output is an additional block clearly labeled as such (e.g., `ASSIST (Low Vision):`).
43
+
44
+ Assist output:
45
+
46
+ - explains the situation
47
+ - suggests safe next steps
48
+ - discloses confidence
49
+ - preserves user control
50
+
51
+ ---
52
+
53
+ ## 3. Engine API (source of truth)
54
+
55
+ All adapters (CLI, MCP, IDE, CI) are thin layers over the engine API.
56
+
57
+ ### 3.1 assist.request (engine input)
58
+
59
+ **Schema:** `assist.request.v0.1`
60
+
61
+ Required:
62
+
63
+ - `profile` – presentation policy (lowvision, cognitive-load, screen-reader, etc.)
64
+ - `input.kind` – cli_error_json | scorecard_json | raw_text | last_log
65
+
66
+ Optional:
67
+
68
+ - `preferences.max_steps`
69
+ - `preferences.show_next_command`
70
+
71
+ ### 3.2 assist.response (engine output)
72
+
73
+ **Schema:** `assist.response.v0.1`
74
+
75
+ Required:
76
+
77
+ - `confidence` – High | Medium | Low
78
+ - `safest_next_step` – one sentence
79
+ - `plan` – ordered list of steps
80
+
81
+ Optional:
82
+
83
+ - `anchored_id` – string or null
84
+ - `next_safe_commands` – SAFE commands only
85
+ - `notes`
86
+ - `methods_applied` – audit-only method identifiers (see §15)
87
+ - `evidence` – audit-only source anchors (see §15)
88
+
89
+ This schema is the engine contract.
90
+ Human-readable output is a *rendering* of this structure.
91
+
92
+ ---
93
+
94
+ ## 4. Confidence semantics (monotonic and enforced)
95
+
96
+ Confidence reflects the reliability of the input, not the quality of the advice.
97
+
98
+ | Confidence | Meaning |
99
+ |------------|---------|
100
+ | High | Validated `cli.error.v0.1` JSON |
101
+ | Medium | Scorecard input or raw text with explicit `(ID: …)` |
102
+ | Low | Raw text without ID, partial parsing, or validation failure |
103
+
104
+ ### Invariant
105
+
106
+ **Confidence may never increase during profile transformation.**
107
+ Profiles may only preserve or downgrade confidence.
108
+
109
+ Enforced by the Profile Guard.
110
+
111
+ ---
112
+
113
+ ## 5. Safety model
114
+
115
+ ### 5.1 Risk taxonomy
116
+
117
+ - **SAFE** – read-only, dry-run, validation, inspection
118
+ - **RISKY** – reversible state changes
119
+ - **DESTRUCTIVE** – irreversible state changes
120
+
121
+ ### v0.x policy
122
+
123
+ - Ally MAY emit SAFE commands only
124
+ - Ally MUST NOT emit RISKY or DESTRUCTIVE commands
125
+ - Ally NEVER executes commands
126
+
127
+ ### Command provenance rule
128
+
129
+ Every emitted command must:
130
+
131
+ 1. appear verbatim in the ground truth (e.g., Fix lines or structured next)
132
+ 2. be classified SAFE
133
+ 3. be allowed by confidence level (no commands on Low confidence)
134
+
135
+ Enforced by the Profile Guard.
136
+
137
+ ---
138
+
139
+ ## 6. Profiles (policy transforms)
140
+
141
+ Profiles are deterministic presentation policies.
142
+
143
+ ### 6.1 Profile contract
144
+
145
+ A profile is a pure function:
146
+
147
+ ```
148
+ AssistResult (base) → AssistResult (profiled)
149
+ ```
150
+
151
+ **Allowed:**
152
+
153
+ - reorder steps
154
+ - truncate steps
155
+ - simplify phrasing
156
+ - change rendering style
157
+
158
+ **Forbidden:**
159
+
160
+ - inventing IDs
161
+ - inventing commands
162
+ - adding new facts
163
+ - increasing confidence
164
+ - bypassing safety rules
165
+
166
+ ### 6.2 Built-in profiles (v0.3.x)
167
+
168
+ | Profile | Purpose |
169
+ |---------|---------|
170
+ | lowvision | Visual clarity, spacing, redundancy |
171
+ | cognitive-load | Reduce steps and complexity |
172
+ | screen-reader | Audio-first, spoken-friendly output |
173
+ | dyslexia | Reduced reading friction, explicit labels |
174
+ | plain-language | Maximum clarity, one clause per sentence |
175
+
176
+ Adding a new profile is non-breaking.
177
+ Changing semantics of an existing profile is a breaking change.
178
+
179
+ ---
180
+
181
+ ## 7. Profile Guard (runtime invariant enforcement)
182
+
183
+ ### 7.1 Purpose
184
+
185
+ The Profile Guard enforces engine invariants after every profile transform.
186
+
187
+ Guard violations indicate engine bugs, not user errors.
188
+
189
+ ### 7.2 Enforced invariants (v0.3.x)
190
+
191
+ **Hard errors (fail execution):**
192
+
193
+ - Anchored ID invented or changed
194
+ - Confidence increased
195
+ - Invented commands
196
+ - Commands emitted on Low confidence
197
+ - Exceeding profile step limits
198
+ - Forbidden tokens (e.g., parentheticals in screen-reader)
199
+ - Visual navigation references in screen-reader output
200
+
201
+ **Warnings (non-fatal):**
202
+
203
+ - Content Support Invariant violations
204
+ (output contains facts not supported by base input)
205
+
206
+ Warnings are surfaced for developers but do not block output by default.
207
+
208
+ ### 7.3 Guard behavior
209
+
210
+ - Violations raise `GuardViolation`
211
+ - CLI emits structured error output with guard codes
212
+ - Exit code: 2 (engine/validation failure)
213
+ - Output must not be trusted when guard fails
214
+
215
+ ---
216
+
217
+ ## 8. Content Support Invariant (WARN-level)
218
+
219
+ Profiles must not introduce new factual topics.
220
+
221
+ ### Enforcement approach
222
+
223
+ A deterministic heuristic checks whether each output step:
224
+
225
+ 1. shares content tokens with base input text, or
226
+ 2. consists only of allowed "glue" language plus supported tokens
227
+
228
+ If unsupported, a WARN-level guard issue is emitted.
229
+
230
+ This balances safety with legitimate rephrasing.
231
+
232
+ ---
233
+
234
+ ## 9. CLI adapter behavior (current reference)
235
+
236
+ **Commands:**
237
+
238
+ - `explain --json <path>`
239
+ - `triage --stdin`
240
+ - `last`
241
+ - `assist-run <command...>`
242
+
243
+ **Rules:**
244
+
245
+ - Original tool output is printed unchanged
246
+ - Assist block is clearly labeled
247
+ - Guard is always enforced
248
+
249
+ **Exit codes:**
250
+
251
+ - 0 – success
252
+ - 2 – validation/guard failure
253
+
254
+ The CLI is the reference adapter, not the engine itself.
255
+
256
+ ---
257
+
258
+ ## 10. Determinism and locality
259
+
260
+ - No randomness
261
+ - No timestamps
262
+ - No network calls
263
+ - Local state limited to:
264
+ - `~/.a11y-assist/last.log`
265
+
266
+ Telemetry, analytics, or remote calls are explicitly out of scope.
267
+
268
+ ---
269
+
270
+ ## 11. Versioning policy
271
+
272
+ ### Schemas
273
+
274
+ - `cli.error.v0.1`
275
+ - `assist.request.v0.1`
276
+ - `assist.response.v0.1`
277
+
278
+ ### Versioning rules
279
+
280
+ - **Patch:** bug fixes, stricter enforcement, clearer wording
281
+ - **Minor:** new profiles, new optional fields, new adapters
282
+ - **Major:** changes to required fields or invariant semantics
283
+
284
+ Backward compatibility is preferred but correctness takes priority.
285
+
286
+ ---
287
+
288
+ ## 12. Testing requirements (quality gate)
289
+
290
+ Every release must include:
291
+
292
+ - Determinism tests (same input → same output)
293
+ - Guard unit tests for every invariant
294
+ - Profile integration tests
295
+ - Golden tests for all profiles:
296
+ - lowvision
297
+ - cognitive-load
298
+ - screen-reader
299
+ - dyslexia
300
+ - plain-language
301
+ - Methods metadata tests (if metadata is present, it must not affect deterministic output)
302
+
303
+ If a change cannot be proven safe by tests, it must not ship.
304
+
305
+ ---
306
+
307
+ ## 13. MCP and future adapters (explicitly deferred)
308
+
309
+ Ally becomes an MCP tool only after:
310
+
311
+ 1. engine contracts are stable
312
+ 2. guard invariants are proven in real usage
313
+ 3. consumers want programmatic access
314
+
315
+ When this happens, MCP will be a thin adapter over the engine API.
316
+
317
+ ---
318
+
319
+ ## 14. Methods metadata (optional, audit-only)
320
+
321
+ Ally may emit optional metadata fields in `assist.response.v0.1` to support auditing and future "methods/tests" mapping.
322
+ These fields must not change engine behavior and must not be required.
323
+
324
+ ### 14.1 methods_applied
325
+
326
+ Optional list of stable method identifiers indicating which deterministic procedures contributed to the output.
327
+
328
+ Examples:
329
+ - `engine.normalize.from_cli_error_v0_1`
330
+ - `profile.screen_reader.apply`
331
+ - `guard.validate_profile_transform`
332
+
333
+ Rules:
334
+ - append-only and stable once published
335
+ - identifiers are descriptive, not user-facing UI
336
+ - may be omitted or empty
337
+
338
+ ### 14.2 evidence
339
+
340
+ Optional list of lightweight source anchors mapping output text back to input text.
341
+
342
+ Each evidence entry references:
343
+ - `field`: which output field it supports (e.g., `safest_next_step`, `plan[0]`)
344
+ - `source`: where it came from (e.g., `cli.error.fix[1]`, `cli.error.why[0]`, `raw_text:Fix:2`)
345
+ - optional `note`
346
+
347
+ Rules:
348
+ - anchors must be deterministic
349
+ - no large blobs; references only
350
+ - may be omitted or empty
351
+
352
+ ### 14.3 Rendering and testing
353
+
354
+ - Renderers must ignore metadata by default (no visible output change)
355
+ - Golden fixtures compare rendered text only; metadata does not affect comparison
356
+ - Dedicated metadata tests verify correctness without affecting golden test stability
357
+
358
+ ---
359
+
360
+ ## 15. Design philosophy (final)
361
+
362
+ > Accessibility is not a feature.
363
+ > It is a contract—explicit, testable, enforced, and safe.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 mcp-tool-shop
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,71 @@
1
+ # a11y-assist v0.1.0 Released
2
+ ### Human help for CLI failures — without replacing ground truth
3
+
4
+ Today we're releasing **a11y-assist v0.1.0**, a low-vision-first assistant for command-line tools that helps users *act* on failures without rewriting, hiding, or second-guessing the original output.
5
+
6
+ a11y-assist is the third component in the accessibility toolchain:
7
+
8
+ - **a11y-lint** defines the accessibility contract
9
+ - **a11y-ci** enforces it in continuous integration
10
+ - **a11y-assist** helps humans recover when things go wrong
11
+
12
+ ## What problem this solves
13
+
14
+ CLI errors often fail users at the worst possible moment:
15
+ - when they're under time pressure
16
+ - when output is dense or poorly structured
17
+ - when vision or cognitive load makes scanning difficult
18
+
19
+ a11y-assist does **not** fix errors automatically.
20
+ Instead, it provides a clear, additive explanation that helps users regain control.
21
+
22
+ ## Key principles
23
+
24
+ - **Additive, not destructive**
25
+ The original tool output is never modified or hidden.
26
+
27
+ - **Ground truth anchored**
28
+ When available, assistance is anchored to `cli.error.v0.1` IDs and structure.
29
+
30
+ - **Low-vision-first**
31
+ Output uses clear labeling, spacing, redundancy, and short line lengths.
32
+
33
+ - **Safe by default**
34
+ v0.1 emits only non-destructive, read-only next steps.
35
+
36
+ - **Deterministic and local**
37
+ No background services. No network calls. No hidden state.
38
+
39
+ ## What's included in v0.1.0
40
+
41
+ - `a11y-assist explain --json <file>`
42
+ High-confidence assistance from structured CLI error JSON
43
+
44
+ - `a11y-assist triage --stdin`
45
+ Best-effort help for raw terminal output (clearly labeled lower confidence)
46
+
47
+ - `a11y-assist last`
48
+ Assistance for the most recent failed command via a local wrapper
49
+
50
+ - `assist-run <command>`
51
+ A zero-config wrapper that captures output and suggests help on failure
52
+
53
+ ## What this release deliberately does *not* include
54
+
55
+ - No interactive chat
56
+ - No autonomous fixes
57
+ - No risky command suggestions
58
+ - No AI dependency
59
+
60
+ These capabilities are intentionally deferred to future versions.
61
+
62
+ ## Why this matters
63
+
64
+ Accessibility is not just about correctness — it's about **recoverability**.
65
+
66
+ a11y-assist makes CLI tools more humane without sacrificing determinism, debuggability, or trust.
67
+
68
+ ---
69
+
70
+ Repository: https://github.com/mcp-tool-shop-org/a11y-assist
71
+ Release: v0.1.0