AccesibilityHub

使用说明(Markdown格式)

  • 项目简介

    • AccesibilityHub 是一个基于 MCP(Model Context Protocol)的后端服务器实现,旨在为大型语言模型(LLM)客户端提供标准化的上下文服务,用于无障碍分析、工具注册、提示渲染和资源管理。它将无障碍分析工具(例如 axe-core、Pa11y)整合为 MCP 工具,并提供丰富的提示模板和 WCAG/Contrast 相关资源,便于通过 JSON-RPC 与客户端进行交互。
  • 主要功能点

    • 资源托管与访问:提供 WCAG 及对比度阈值等资源的统一访问接口。
    • 工具注册与执行:注册并暴露分析工具(如 axe-core、Pa11y、以及混合分析等),支持通过 MCP 客户端发起分析请求并获取结构化结果。
    • 提示模板定义与渲染:提供全量/快速审核等提示模板,客户端可请求并获得结构化的对话内容。
    • 会话与能力声明:对会话、能力进行声明与跟踪,支持多种传输协议。
    • JSON-RPC 交互:通过 MCP 的约定将请求/响应以 JSON-RPC 的形式进行通信。
  • 安装与运行

    • 直接从仓库获取源码后,按项目常规的 Node.js 运行方式安装依赖并启动服务(需要 Node.js 20+,Chromium/Puppeteer 自动下载)。
    • 服务入口在 src/server.ts,创建并启动 MCP 服务器实例,注册工具、提示与资源,并通过标准的 Stdio 传输提供服务。
  • 服务器配置(MCP 客户端配置示例,JSON格式) 说明:以下配置是供 MCP 客户端连接该 MCP 服务器使用的示例信息,字段含义如下:serverName 为服务器名称,command 为启动命令,args 为启动参数。该信息用于客户端在本地或远程启动并连接 MCP 服务器。实际使用时可依据环境调整参数。 { "serverName": "AccesibilityHub", "command": "npx", "args": ["-y", "AccesibilityHub"], "transport": "stdio" }

  • 基本使用方法

    1. 安装与启动
      • 将仓库中的服务器代码部署在支持 Node.js 的环境中,安装依赖并启动服务器。
      • 启动后,服务器将通过 Stdio 传输接受来自 MCP 客户端的 JSON-RPC 请求,并返回相应的结果。
    2. 客户端接入
      • MCP 客户端需要提供上述配置(serverName、command、args 等),以启动并连接该 MCP 服务器。
      • 客户端可通过定义的工具、提示与资源进行分析、对话模板渲染以及结果渲染。
    3. 与工具/资源交互
      • 客户端可请求分析(如分析网页、HTML 内容),获取结构化的结果(issues、summary、WCAG 参考等)。
      • 客户端可请求各种资源(WCAG 条目、阈值、算法列表等),以及提示模板的渲染输出。
  • 运行环境与要求

    • Node.js 20 及以上
    • Chrome/Chromium(由 Puppeteer 自动下载)
    • 其他依赖项按 package.json 安装
  • 额外说明

    • 该实现包含了完整的服务器端代码、工具实现、资源注册、提示模板以及测试覆盖,具备可运行的 MCP 服务能力。

服务器信息