accessflow-mcp-server 2.3.4 → 2.3.6

package/README.md

@@ -2,61 +2,36 @@
 
 # AccessFlow MCP Server
 
-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.
+The accessFlow Model Context Protocol (MCP) server provides intelligent accessibility issue analysis and remediation guidance. It connects AI clients to the accessFlow platform to help developers identify, prioritize, and fix accessibility issues in their web applications.
 
-## 🎯 Purpose
+## Purpose
 
 The accessFlow MCP Server enables AI clients (like Copilot) to:
 
-- **Identify Priority Issues**: Get the most urgent accessibility issues ordered by severity and impact
-- **Provide Fix Guidance**: Generate detailed remediation instructions with code examples
-- **WCAG Compliance**: Reference specific WCAG guidelines and criteria for each issue
-- **Streamline Workflow**: Integrate accessibility testing directly into your development environment
+- **Identify priority issues**: Get the most urgent accessibility issues, ordered by severity and impact.
+- **Provide fix guidance**: Generate detailed remediation instructions with code examples.
+- **Align with WCAG**: Reference specific WCAG guidelines and criteria for each issue.
+- **Streamline workflow**: Get detailed accessibility insights and fix recommendations directly in your IDE.
 
-## 🛠️ Available Tools
+## API Key Setup
 
-### `getMostUrgentIssues`
+Generate a token in accessFlow to set the API key.
 
-Retrieves the most critical accessibility issues, prioritized by:
-
-1. **Severity**: EXTREME → HIGH → MEDIUM → LOW
-2. **Site Impact**: Number of locations affected across the site
-3. **Page Impact**: Number of occurrences on individual pages
-
-**Parameters**: None (uses configured domain)
-
-**Returns**: JSON data with structured issue information including severity, WCAG level, occurrence counts, and unique identifiers.
-
-### `getIssueRemediation`
-
-Provides detailed remediation guidance for a specific accessibility issue.
-
-**Parameters**:
-
-- `issueDisplayName` (string, required): The unique identifier for the accessibility issue
-
-**Returns**: Comprehensive fix guidance including:
-
-- Problem summary and WCAG references
-- Current problematic code
-- Suggested code fixes with examples
-- Step-by-step remediation instructions
-- Links to tutorials and additional resources
-
-### `resolveIssue`
+**To generate a token:**
 
-Marks the specified issue as resolved in accessFlow.
-Note: If the next audit still detects this issue, it will be reopened automatically.
-
-**Parameters**:
+1. Go to your **Profile** menu in the top right corner and select **Token management**.
+2. Select **Generate token**.
+3. Enter a token name.
+4. Select **AI MCP token** and then **Generate token**.
+5. Copy the token and store it securely. You won't be able to see it again.
 
-- `issueDisplayName` (string, required): The unique identifier for the accessibility issue
+## Configuration
 
-## 📋 Usage
+Add the configuration to your MCP client (this varies by client), usually in the file `mcp.json`.
 
-### Configuration
+### Configure the accessFlow MCP server locally
 
-Add the following configuration to your MCP client (e.g., VS Code Copilot Agent):
+Enter your copied token into `API_KEY`:
 
 ```json
 {
@@ -76,29 +51,111 @@ Add the following configuration to your MCP client (e.g., VS Code Copilot Agent)
 
 #### Configuration Parameters
 
-- **`API_KEY`** (required): Your accessFlow API key for authentication
-- **`DOMAIN`** (required): The domain of your application being analyzed (e.g., `example.com` - without protocol)
+| Parameter | Required | Description |
+|-----------|----------|-------------|
+| `API_KEY` | Yes | Your accessFlow API key for authentication |
+| `DOMAIN` | Yes | The domain of your application being analyzed (e.g., `https://example.com`) |
+
+### Connect to the accessFlow MCP server remotely
+
+Connect remotely to the accessFlow MCP server: `flow-mcp.accessibe.com`
+
+```json
+{
+  "mcpServers": {
+    "flow-mcp": {
+      "type": "http",
+      "url": "https://flow-mcp.accessibe.com/mcp",
+      "headers": {
+        "Authorization": "Bearer <FLOW_MCP_API_KEY>",
+        "X-Domain": "mysite.com"
+      }
+    }
+  }
+}
+```
+
+#### Configuration Parameters
+
+| Parameter | Required | Description |
+|-----------|----------|-------------|
+| `Authorization` | Yes | Your accessFlow bearer token and API key for authentication |
+| `X-Domain` | Yes | The domain of your application being analyzed (e.g., `https://example.com`) |
+
+## MCP Server Commands
+
+Once configured, you can run commands through your MCP client to identify accessibility issues and get remediation guidance. You can use natural language or the command name.
 
-### 3. Example Usage
+### Get most urgent issues
 
-Once configured, you can interact with the server through your MCP client:
+#### `getMostUrgentIssues`
+
+Retrieves the most critical accessibility issues, prioritized by:
+
+1. **Severity**: Extreme → High → Medium → Low
+2. **Site impact**: Number of locations affected across the site
+3. **Page impact**: Number of occurrences on individual pages
+
+**Parameters**: None (uses the configured domain)
+
+**Returns**: JSON data with structured issue information including severity, WCAG level, occurrence counts, and unique identifiers.
 
-**Get Priority Issues:**
+**Example**:
 
 ```text
 "Show me the most urgent accessibility issues for my site"
 ```
 
-**Get Specific Remediation:**
+### Get issue remediation guidance
+
+#### `getIssueRemediation`
+
+Provides detailed remediation guidance for a specific accessibility issue.
+
+**Parameters**:
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `issueDisplayName` | string | Yes | The unique identifier for the accessibility issue |
+
+**Returns**: Comprehensive fix guidance including:
+
+- Problem summary and WCAG references
+- Current problematic code
+- Suggested code fixes with examples
+- Step-by-step remediation instructions
+- Links to tutorials and additional resources
+
+**Example**:
 
 ```text
 "Get remediation guidance for issue: Decorative-Content-6d277a13ba"
 ```
 
+### Mark an issue as resolved
+
+#### `resolveIssue`
+
+Marks the specified issue as resolved in accessFlow.
+
+> **Note:** If the next audit still detects this issue, it will be reopened automatically.
+
+**Parameters**:
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `issueDisplayName` | string | Yes | The unique identifier for the accessibility issue |
+
+**Example**:
+
+```text
+"Resolve issue id Footer-Landmark-e3c792e8b8"
+```
+
 ## Supported Clients
 
 This MCP server works with AI agents in IDEs and other MCP-compatible clients:
 
-- **VS Code Copilot**: Integrates with GitHub Copilot in VS Code
+- **VS Code Copilot**: Integrates with Microsoft Copilot in VS Code
 - **Cursor**: Works with Cursor's AI assistant
 - **Other MCP Clients**: Any application supporting the Model Context Protocol