accessflow-mcp-server 2.3.8-beta.0 → 2.3.8

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 (2) hide show
  1. package/README.md +34 -15
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -13,6 +13,8 @@ The accessFlow MCP Server enables AI clients (like Copilot) to:
13
13
  - **Align with WCAG**: Reference specific WCAG guidelines and criteria for each issue.
14
14
  - **Streamline workflow**: Get detailed accessibility insights and fix recommendations directly in your IDE.
15
15
 
16
+ The accessFlow MCP server works with both platform audits and SDK-based audits. You can use it to analyze issues from your live site or connect it to SDK audit results.
17
+
16
18
  ## API Key Setup
17
19
 
18
20
  Generate a token in accessFlow to set the API key.
@@ -51,10 +53,10 @@ Enter your copied token into `API_KEY`:
51
53
 
52
54
  #### Configuration Parameters
53
55
 
54
- | Parameter | Required | Description |
55
- |-----------|----------|-------------|
56
- | `API_KEY` | Yes | Your accessFlow API key for authentication |
57
- | `DOMAIN` | Yes | The domain of your application being analyzed (e.g., `https://example.com`) |
56
+ | Parameter | Required | Description |
57
+ | --------- | -------- | --------------------------------------------------------------------------- |
58
+ | `API_KEY` | Yes | Your accessFlow API key for authentication |
59
+ | `DOMAIN` | Yes | The domain of your application being analyzed (e.g., `https://example.com`) |
58
60
 
59
61
  ### Connect to the accessFlow MCP server remotely
60
62
 
@@ -77,10 +79,10 @@ Connect remotely to the accessFlow MCP server: `flow-mcp.accessibe.com`
77
79
 
78
80
  #### Configuration Parameters
79
81
 
80
- | Parameter | Required | Description |
81
- |-----------|----------|-------------|
82
- | `Authorization` | Yes | Your accessFlow bearer token and API key for authentication |
83
- | `X-Domain` | Yes | The domain of your application being analyzed (e.g., `https://example.com`) |
82
+ | Parameter | Required | Description |
83
+ | --------------- | -------- | --------------------------------------------------------------------------- |
84
+ | `Authorization` | Yes | Your accessFlow bearer token and API key for authentication |
85
+ | `X-Domain` | Yes | The domain of your application being analyzed (e.g., `https://example.com`) |
84
86
 
85
87
  ## MCP Server Commands
86
88
 
@@ -96,7 +98,16 @@ Retrieves the most critical accessibility issues, prioritized by:
96
98
  2. **Site impact**: Number of locations affected across the site
97
99
  3. **Page impact**: Number of occurrences on individual pages
98
100
 
99
- **Parameters**: None (uses the configured domain)
101
+ You can run this command on either a platform audit or an SDK audit by setting the `auditSource` parameter.
102
+
103
+ **Parameters**:
104
+
105
+ | Parameter | Type | Required | Description |
106
+ | ------------- | ------ | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
107
+ | `auditSource` | enum | No | `PLATFORM` (default) returns the most critical issues from the latest accessFlow platform audit. `SDK` returns the most critical issues from the specified SDK audit. |
108
+ | `commitId` | string | Required when `auditSource` is `SDK` | The commit ID for the SDK audit results you want to retrieve. |
109
+ | `repo` | string | No | The repository URL or identifier for the SDK audit. Only provide this when you need to narrow results to a specific repository. |
110
+ | `branch` | string | No | The branch name for the SDK audit. Only provide this when you need to narrow results to a specific branch. |
100
111
 
101
112
  **Returns**: JSON data with structured issue information including severity, WCAG level, occurrence counts, and unique identifiers.
102
113
 
@@ -112,11 +123,15 @@ Retrieves the most critical accessibility issues, prioritized by:
112
123
 
113
124
  Provides detailed remediation guidance for a specific accessibility issue.
114
125
 
126
+ You can retrieve guidance from either a platform audit or an SDK audit by setting the `auditSource` parameter.
127
+
115
128
  **Parameters**:
116
129
 
117
- | Parameter | Type | Required | Description |
118
- |-----------|------|----------|-------------|
119
- | `issueDisplayName` | string | Yes | The unique identifier for the accessibility issue |
130
+ | Parameter | Type | Required | Description |
131
+ | ------------------ | ------ | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
132
+ | `issueDisplayName` | string | Yes | The unique identifier for the accessibility issue. |
133
+ | `auditSource` | enum | No | `PLATFORM` (default) gets guidance from the latest accessFlow platform audit. `SDK` gets guidance from the specified SDK audit. |
134
+ | `commitId` | string | Required when `auditSource` is `SDK` | The commit ID for the SDK audit results you want to retrieve. |
120
135
 
121
136
  **Returns**: Comprehensive fix guidance including:
122
137
 
@@ -140,11 +155,15 @@ Marks the specified issue as resolved in accessFlow.
140
155
 
141
156
  > **Note:** If the next audit still detects this issue, it will be reopened automatically.
142
157
 
158
+ You can resolve issues in either a platform audit or an SDK audit by setting the `auditSource` parameter.
159
+
143
160
  **Parameters**:
144
161
 
145
- | Parameter | Type | Required | Description |
146
- |-----------|------|----------|-------------|
147
- | `issueDisplayName` | string | Yes | The unique identifier for the accessibility issue |
162
+ | Parameter | Type | Required | Description |
163
+ | ------------------ | ------ | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
164
+ | `issueDisplayName` | string | Yes | The unique identifier for the accessibility issue. |
165
+ | `auditSource` | enum | No | `PLATFORM` (default) resolves the issue in accessFlow platform audit results. `SDK` resolves the issue in the specified SDK audit. |
166
+ | `commitId` | string | Required when `auditSource` is `SDK` | The commit ID for the SDK audit results you want to update. |
148
167
 
149
168
  **Example**:
150
169
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "accessflow-mcp-server",
3
- "version": "2.3.8-beta.0",
3
+ "version": "2.3.8",
4
4
  "type": "module",
5
5
  "description": "AccessFlow MCP Server for accessibility issue remediation",
6
6
  "main": "./dist/index.js",