@reticular/speakable 1.1.0 → 1.1.1
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/README.md +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -159,6 +159,35 @@ Verify that the accessibility model serializes and deserializes consistently:
|
|
|
159
159
|
speakable page.html --validate
|
|
160
160
|
```
|
|
161
161
|
|
|
162
|
+
## MCP Integration (AI Assistants)
|
|
163
|
+
|
|
164
|
+
Speakable includes a Model Context Protocol (MCP) server that lets AI coding assistants analyze accessibility in real-time. Ask your assistant "check if this component is accessible" and it calls Speakable automatically.
|
|
165
|
+
|
|
166
|
+
### Setup
|
|
167
|
+
|
|
168
|
+
Add to your MCP config (Kiro, VS Code, Cursor, Claude Desktop, Windsurf):
|
|
169
|
+
|
|
170
|
+
```json
|
|
171
|
+
{
|
|
172
|
+
"mcpServers": {
|
|
173
|
+
"speakable": {
|
|
174
|
+
"command": "npx",
|
|
175
|
+
"args": ["-y", "@reticular/speakable-mcp"]
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
### Available Tools
|
|
182
|
+
|
|
183
|
+
| Tool | Description |
|
|
184
|
+
|------|-------------|
|
|
185
|
+
| `analyze_html` | Predict screen reader output for NVDA, JAWS, and VoiceOver |
|
|
186
|
+
| `audit_html` | Generate accessibility audit report with issues and remediation |
|
|
187
|
+
| `diff_html` | Compare two HTML versions for accessibility regressions |
|
|
188
|
+
|
|
189
|
+
All tools run locally — no network requests, no data leaves your machine. See the [MCP Integration docs](https://getspeakable.dev/docs/mcp-integration) for full setup instructions.
|
|
190
|
+
|
|
162
191
|
## CI/CD Integration
|
|
163
192
|
|
|
164
193
|
### GitHub Actions
|