JinDaGe - A11y MCP Details

article

README

🚀 A11y MCP 服务器

A11y MCP 服务器是一个借助 axe - core 开展网页可访问性审核的 Model Context Protocol (MCP) 服务器。它能与您钟爱的 AI 助手（如 Cline、Cursor、GH Copilot）搭配使用，助力 AI 为您修复可访问性问题！

🚀 快速开始

A11y MCP 服务器可对网页进行可访问性审核，并与 AI 助手结合修复问题。配置完成后，就能让 AI 助手利用它开展工作啦。

✨ 主要特性

能对任意网页开展详尽的可访问性审核。
可获取网页可访问性问题的摘要。
能够按照特定的 WCAG 标准对审核结果进行过滤。
可在结果里包含 HTML 片段，便于调试。

📦 安装指南

全局安装

npm install -g a11y-mcp

直接使用 npx

npx a11y-mcp

📚 详细文档

配置

若要让此 MCP 服务器与 Cline 协同工作，需将其添加到您的 MCP 设置配置文件中。

MCP 配置

在 mcpServers 对象中添加如下内容：

{
  "mcpServers": {
    "a11y": {
      "command": "npx",
      "args": ["a11y-mcp"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

可用工具

audit_webpage

对网页执行详细可访问性审核。

参数：

url（必需）：要审核的网页 URL
includeHtml（可选）：是否包含 HTML 片段在结果中（默认：false）
tags（可选）：要检查的具体可访问性标签数组（例如，wcag2a、wcag2aa、wcag21a、best - practice）

示例：

使用 a11y MCP 服务器审核 example.com 的可访问性问题

get_summary

获取网页的可访问性问题摘要。

参数：

url（必需）：要审核的网页 URL

示例：

给我 example.com 的可访问性问题摘要

示例用法

配置完成后，您可以指示 Claude 使用 MCP 服务器执行可访问性审核：

"你能检查 example.com 是否存在可访问性问题吗？"
"审核我的网站 https://mywebsite.com 以符合 WCAG 2.1 AA 标准"
"给我 https://example.com 的可访问性问题摘要"
"检查我本地开发服务器 http://localhost:3000 是否存在任何关键的可访问性问题"

开发

若要在本地运行服务器进行开发，可执行以下命令：

npm start

发布

该项目包含一个发布脚本，用于帮助版本控制和发布到 npm。脚本处理版本递增、运行测试、创建 Git 标签以及发布到 npm。

发布新版本

# 确保脚本是可执行的
chmod +x release.sh

# 发布补丁版本（默认）
./release.sh

# 发布小版本
./release.sh --minor

# 发布主要版本
./release.sh --major

# 发布特定版本
./release.sh --version=1.2.3

# 跳过 Git 操作
./release.sh --skip-git

# 干运行（不做任何更改）
./release.sh --dry-run

# 强制发布，即使有未提交的更改
./release.sh --force

获取更多信息

./release.sh --help

📄 许可证

MPL 2.0

致谢

该项目基于杰出的作品 [axe - core](https://github.com/dequelabs/axe - core) 构建。

A11y