accessflow-mcp-server 1.0.3 → 1.0.4
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 +159 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# AccessFlow MCP Server
|
|
2
|
+
|
|
3
|
+
A Model Context Protocol (MCP) server that provides intelligent accessibility issue analysis and remediation guidance. This server connects to the AccessFlow platform to help developers identify, prioritize, and fix accessibility issues in their web applications.
|
|
4
|
+
|
|
5
|
+
## 🎯 Purpose
|
|
6
|
+
|
|
7
|
+
The AccessFlow MCP Server enables AI assistants (like Claude Desktop) to:
|
|
8
|
+
|
|
9
|
+
- **Identify Priority Issues**: Get the most urgent accessibility issues ordered by severity and impact
|
|
10
|
+
- **Provide Fix Guidance**: Generate detailed remediation instructions with code examples
|
|
11
|
+
- **WCAG Compliance**: Reference specific WCAG guidelines and criteria for each issue
|
|
12
|
+
- **Streamline Workflow**: Integrate accessibility testing directly into your development environment
|
|
13
|
+
|
|
14
|
+
## 🛠️ Available Tools
|
|
15
|
+
|
|
16
|
+
### `getMostUrgentIssues`
|
|
17
|
+
|
|
18
|
+
Retrieves the most critical accessibility issues, prioritized by:
|
|
19
|
+
|
|
20
|
+
1. **Severity**: EXTREME → HIGH → MEDIUM → LOW
|
|
21
|
+
2. **Site Impact**: Number of locations affected across the site
|
|
22
|
+
3. **Page Impact**: Number of occurrences on individual pages
|
|
23
|
+
|
|
24
|
+
**Parameters**: None (uses configured domain)
|
|
25
|
+
|
|
26
|
+
**Returns**: JSON data with structured issue information including severity, WCAG level, occurrence counts, and unique identifiers.
|
|
27
|
+
|
|
28
|
+
### `getIssueRemediation`
|
|
29
|
+
|
|
30
|
+
Provides detailed remediation guidance for a specific accessibility issue.
|
|
31
|
+
|
|
32
|
+
**Parameters**:
|
|
33
|
+
|
|
34
|
+
- `issueDisplayName` (string, required): The unique identifier for the accessibility issue
|
|
35
|
+
|
|
36
|
+
**Returns**: Comprehensive fix guidance including:
|
|
37
|
+
|
|
38
|
+
- Problem summary and WCAG references
|
|
39
|
+
- Current problematic code
|
|
40
|
+
- Suggested code fixes with examples
|
|
41
|
+
- Step-by-step remediation instructions
|
|
42
|
+
- Links to tutorials and additional resources
|
|
43
|
+
|
|
44
|
+
## 📋 Usage
|
|
45
|
+
|
|
46
|
+
### 1. Installation
|
|
47
|
+
|
|
48
|
+
Install the package via npm:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm install -g accessflow-mcp-server
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### 2. Configuration
|
|
55
|
+
|
|
56
|
+
Add the following configuration to your MCP client (e.g., Claude Desktop):
|
|
57
|
+
|
|
58
|
+
```json
|
|
59
|
+
{
|
|
60
|
+
"mcpServers": {
|
|
61
|
+
"flow-mcp": {
|
|
62
|
+
"command": "npx",
|
|
63
|
+
"args": ["-y", "accessflow-mcp-server"],
|
|
64
|
+
"env": {
|
|
65
|
+
"API_KEY": "your-accessflow-api-key",
|
|
66
|
+
"DOMAIN": "https://your-app-domain.com"
|
|
67
|
+
},
|
|
68
|
+
"type": "stdio"
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
#### Configuration Parameters
|
|
75
|
+
|
|
76
|
+
- **`API_KEY`** (required): Your AccessFlow API key for authentication
|
|
77
|
+
- **`DOMAIN`** (required): The domain of your application being analyzed (e.g., `https://example.com`)
|
|
78
|
+
|
|
79
|
+
### 3. Example Usage
|
|
80
|
+
|
|
81
|
+
Once configured, you can interact with the server through your MCP client:
|
|
82
|
+
|
|
83
|
+
**Get Priority Issues:**
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
"Show me the most urgent accessibility issues for my site"
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Get Specific Remediation:**
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
"Get remediation guidance for issue: Decorative-Content-6d277a13ba"
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## � Supported Clients
|
|
96
|
+
|
|
97
|
+
This MCP server works with AI agents in IDEs and other MCP-compatible clients:
|
|
98
|
+
|
|
99
|
+
- **VS Code Copilot**: Integrates with GitHub Copilot in VS Code
|
|
100
|
+
- **Cursor**: Works with Cursor's AI assistant
|
|
101
|
+
- **Claude Desktop**: Direct integration with Claude Desktop app
|
|
102
|
+
- **Other MCP Clients**: Any application supporting the Model Context Protocol
|
|
103
|
+
|
|
104
|
+
## 📚 Integration Examples
|
|
105
|
+
|
|
106
|
+
### Claude Desktop Configuration
|
|
107
|
+
|
|
108
|
+
Add to your Claude Desktop `claude_desktop_config.json`:
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"mcpServers": {
|
|
113
|
+
"flow-mcp": {
|
|
114
|
+
"command": "npx",
|
|
115
|
+
"args": ["-y", "accessflow-mcp-server"],
|
|
116
|
+
"env": {
|
|
117
|
+
"API_KEY": "flow-1uwLV9VHxuVDyaK8Jqw p0JkEwMmxhrv",
|
|
118
|
+
"DOMAIN": "https://reap-app.netlify.app/"
|
|
119
|
+
},
|
|
120
|
+
"type": "stdio"
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Typical Workflow
|
|
127
|
+
|
|
128
|
+
1. **Assessment**: Ask Claude to "analyze my site's accessibility issues"
|
|
129
|
+
2. **Prioritization**: Review the most urgent issues by severity
|
|
130
|
+
3. **Remediation**: Get detailed fix guidance for specific issues
|
|
131
|
+
4. **Implementation**: Apply the suggested code changes
|
|
132
|
+
5. **Verification**: Re-run analysis to confirm fixes
|
|
133
|
+
|
|
134
|
+
## 🚀 Features
|
|
135
|
+
|
|
136
|
+
- ✅ **Real-time Analysis**: Connect to live AccessFlow scanning data
|
|
137
|
+
- ✅ **WCAG Compliance**: Detailed WCAG 2.1 AA/AAA references
|
|
138
|
+
- ✅ **Code Examples**: Practical HTML/CSS/JS fix suggestions
|
|
139
|
+
- ✅ **Priority Ranking**: Smart issue prioritization by impact
|
|
140
|
+
- ✅ **Developer-Friendly**: Integrates seamlessly with existing workflows
|
|
141
|
+
- ✅ **Comprehensive**: Covers all major accessibility categories
|
|
142
|
+
|
|
143
|
+
## 📖 API Reference
|
|
144
|
+
|
|
145
|
+
For detailed API documentation and tool specifications, see [TOOL_REFERENCE.md](./TOOL_REFERENCE.md).
|
|
146
|
+
|
|
147
|
+
## 🆘 Support
|
|
148
|
+
|
|
149
|
+
- **Documentation**: [AccessFlow Docs](https://docs.accessflow.com)
|
|
150
|
+
- **Issues**: Report bugs and feature requests on GitHub
|
|
151
|
+
- **Contact**: Support team for API access and configuration help
|
|
152
|
+
|
|
153
|
+
## 📄 License
|
|
154
|
+
|
|
155
|
+
ISC License - see LICENSE file for details.
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
**Keywords**: accessibility, WCAG, MCP, Model Context Protocol, AI assistant, web development, compliance, remediation
|