Web Audit MCP

WebAuditMCP

面向AI代理和开发人员的专业Web审计工具

英语 • 西班牙语 • 葡萄牙语 • 中文

______________________________________________________________________

🌟 什么是WebAuditMCP？

WebAuditMCP是一个全面的web审计MCP（模型上下文协议）服务器，使AI代理能够执行专业级的网站审计。它将多个行业标准工具集成到一个统一的界面中，该界面针对人工智能驱动的工作流程进行了优化。

🛠️ 可用工具

⚡ 快速开始

先决条件

# Required
- Python 3.12+
- Node.js 22+
- VS Code with MCP support

# Optional (for Docker mode)
- Docker Desktop

安装

选项1：本地模式（推荐）

# 1. Clone repository
git clone https://github.com/iberi22/WebAuditMCP.git
cd WebAuditMCP

# 2. Install Python dependencies
pip install -r requirements.txt

# 3. Install Node.js dependencies
cd node-tools
npm install
cd ..

# 4. Install Playwright browsers
playwright install chromium

# 5. Configure environment
cp .env.example .env
# Edit .env with your API keys (WAVE_API_KEY optional)

选项2：Docker模式

# Build and start container
docker-compose -f docker/docker-compose.yml up -d --build

# Check status
docker logs mcp-auditor

VS代码配置

本地模式（STDIO-推荐）

添加到 .vscode/mcp.json:

{
  "servers": {
    "webaudit": {
      "command": "python",
      "args": ["e:\\path\\to\\WebAuditMCP\\mcp\\server.py"],
      "env": {
        "CHROME_MCP_ENABLED": "true",
        "PYTHONUNBUFFERED": "1"
      }
    }
  }
}

Docker模式（HTTP-高级）

添加到 .vscode/mcp.json:

{
  "servers": {
    "auditor-docker": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

备注：Docker HTTP模式需要额外的服务器配置。看 下面的部分。

📝 专业审计提示

我们为全面审计提供久经考验的提示。每个提示都会生成一个 单个Markdown报告 针对AI迭代进行了优化。

快速参考

prompts/
├── complete-audit.md          # Full website audit (all categories)
├── security/
│   ├── headers-audit.md       # HTTP security headers
│   ├── vulnerabilities.md     # OWASP ZAP security scan
│   └── ssl-tls.md            # Certificate and HTTPS validation
├── accessibility/
│   ├── wcag-compliance.md     # WCAG 2.1 AA/AAA compliance
│   ├── screen-reader.md       # Assistive technology testing
│   └── keyboard-navigation.md # Keyboard accessibility
├── performance/
│   ├── core-web-vitals.md     # LCP, FID, CLS metrics
│   ├── lighthouse-full.md     # Complete Lighthouse audit
│   └── mobile-performance.md  # Mobile-specific performance
├── visual/
│   ├── responsive-design.md   # Multi-device layout testing
│   ├── cross-browser.md       # Browser compatibility
│   └── visual-regression.md   # Screenshot comparison
└── styles-layouts/
    ├── design-system.md       # Style consistency audit
    ├── typography.md          # Font and readability
    └── color-contrast.md      # WCAG color contrast ratios

🎯 使用示例

示例1：开发审计（快速）

Using WebAuditMCP, run lighthouse_fast on http://localhost:3000 with device desktop

示例2：完成网站审核

Using WebAuditMCP, perform a comprehensive audit of https://example.com following the complete-audit.md prompt. Generate a single Markdown report with:
1. Executive summary with scores
2. Critical issues by priority
3. Actionable recommendations
4. Before/after comparison if baseline exists

示例3：快速开发检查

Using WebAuditMCP, follow the localhost-audit.md prompt for http://localhost:3000/login

示例4：无障碍合规性

Audit https://website.com for WCAG 2.1 AA compliance using accessibility/wcag-compliance.md. Include:
- Automated axe-core scan
- Manual WAVE review
- Screen reader compatibility notes
- Remediation priority matrix

🔧 工具特定用途

健康检查

# Verify all dependencies and tool availability
health_check()

灯塔绩效审计

# Mobile audit with all categories
audit_lighthouse(
    url="https://example.com",
    device="mobile"
)

# Desktop audit
audit_lighthouse(
    url="https://example.com",
    device="desktop"
)

辅助功能扫描（斧头）

# Desktop accessibility audit
scan_axe(
    url="https://example.com",
    device="desktop"
)

安全标头分析

# Check HTTP security headers
security_headers(url="https://example.com")

响应式设计测试

# Test multiple viewports
responsive_audit(
    url="https://example.com",
    viewports=["375x667", "768x1024", "1920x1080"]
)

OWASP ZAP安全扫描

# Quick baseline security scan (5 minutes)
zap_baseline(
    url="https://example.com",
    minutes=5
)

报表合并

# Merge multiple audit results with budget enforcement
report_merge(
    items=[lighthouse_result, axe_result, security_result],
    budgets={
        "accessibility": 95,
        "performance": 90,
        "security": 85
    }
)

📊 输出格式

所有审核结果返回结构化JSON：

{
  "status": "ok",
  "url": "https://example.com",
  "timestamp": "2025-10-29T03:30:00Z",
  "scores": {
    "overall": 85,
    "performance": 90,
    "accessibility": 95,
    "security": 70
  },
  "issues": [...],
  "recommendations": [...],
  "artifacts": {
    "screenshots": ["path/to/screenshot.png"],
    "reports": ["path/to/report.html"]
  }
}

🌍 语言支持

报告可以用多种语言生成。设置环境变量：

export AUDIT_LANGUAGE=es  # Spanish
export AUDIT_LANGUAGE=pt  # Portuguese
export AUDIT_LANGUAGE=zh  # Chinese
export AUDIT_LANGUAGE=en  # English (default)

🆘 故障排除

Lighthouse失败，显示“找不到命令”：

• 确保已安装Node.js 22+
• 工具将在首次运行时通过自动安装 npx -y lighthouse

Chrome DevTools未连接：

• 检查 CHROME_MCP_ENABLED=true 在环境中
• 验证Chrome/Chromium是否已安装

WAVE API错误：

• 添加 WAVE_API_KEY 到 .env 文件
• 在获取免费API密钥

Lighthouse首次运行时需要互联网：

• 首次执行通过npx下载Lighthouse（需要互联网）
• 后续运行使用缓存版本
• 对于离线模式，请预安装： npm install -g lighthouse

🐳 Docker配置

当前状态：Docker HTTP模式正在开发中。服务器当前支持STDIO传输（本地模式），这是VS Code的推荐配置。

计划中的Docker HTTP配置:

计划在未来的版本中使用以下配置：

{
  "servers": {
    "auditor-docker": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

缺少什么:

• FastMCP HTTP服务器端点配置
• HTTP端点的Docker容器健康检查
• Windows上Docker WSL2问题的疑难解答文档

变通方案：使用本地STDIO模式（请参阅 VS代码配置 上面的部分），它功能齐全，值得推荐。

追踪：实施进度见TASK.md路线图R-D-01至R-D-05部分。

📚 文档

• 完成审核提示 -专业审计模板
• -容器配置
• 更正日志 -1.1.0版本改进
• VS代码集成 -MCP设置指南

🤝 贡献

欢迎投稿！此工具专为AI代理工作流而设计。

📄 许可证

MIT许可证-请参阅 许可证 了解详情。

______________________________________________________________________

🌟 什么是WebAuditMCP？

WebAuditMCP是一个全面的Web审计MCP（Model Context Protocol）服务器，允许人工智能代理对网站进行专业审计。它将多个行业标准工具集成到一个统一的界面中，该界面针对人工智能驱动的工作流进行了优化。

🛠️ 可用的工具

⚡ 快速启动

本地安装：

# 1. Clonar repositorio
git clone https://github.com/tuusuario/WebAuditMCP.git
cd WebAuditMCP

# 2. Instalar dependencias
pip install -r requirements.txt
cd node-tools && npm install && cd ..

# 3. Configurar VS Code
# Agregar servidor MCP en .vscode/mcp.json

# 4. Ejecutar servidor
python mcp/server.py

📝 专业提示

查询文件夹 prompts/ 按类别组织的完整审计模板。

使用示例：

Usando WebAuditMCP, audita https://ejemplo.com siguiendo el prompt prompts/complete-audit.md.
Genera un informe Markdown único con resumen ejecutivo, issues críticos y recomendaciones.

🔧 使用工具

有关完整代码的示例，请参阅英语部分。

📚 文件

• 审计提示 -专业模板
• 更正摘要

______________________________________________________________________

🌟 什么是WebAuditMCP？

WebAuditMCP是一款全面的Web审核服务器，它允许人工智能代理进行专业的网站审核。将多个行业标准工具集成到一个统一的界面中，针对人工智能驱动的工作流程进行了优化。

🛠️ 可用工具

⚡ 快速入门

本地安装 ：

# 1. Clonar repositório
git clone https://github.com/seuusuario/WebAuditMCP.git
cd WebAuditMCP

# 2. Instalar dependências
pip install -r requirements.txt
cd node-tools && npm install && cd ..

# 3. Configurar VS Code
# Adicionar servidor MCP em .vscode/mcp.json

# 4. Executar servidor
python mcp/server.py

📝 专业提示

吃意大利面 prompts/ 按类别组织的完整审计模型。

📚 文档

• 审计员提示
• 修正摘要

______________________________________________________________________

🌟 什么是 WebAuditMCP？

WebAuditMCP 是一个全面的网站审计 MCP（模型上下文协议）服务器，使 AI 代理能够执行专业级网站审计。它将多个行业标准工具集成到一个统一的界面中，针对 AI 驱动的工作流程进行了优化。

🛠️ 可用工具

⚡ 快速开始

本地安装：

# 1. 克隆仓库
git clone https://github.com/yourusername/WebAuditMCP.git
cd WebAuditMCP

# 2. 安装依赖
pip install -r requirements.txt
cd node-tools && npm install && cd ..

# 3. 配置 VS Code
# 在 .vscode/mcp.json 中添加 MCP 服务器

# 4. 运行服务器
python mcp/server.py

📝 专业审计提示

查看 prompts/ 文件夹，获取按类别组织的完整审计模板。

📚 文档

• 审计提示
• 更正摘要

______________________________________________________________________

由以下材料制成❤️ 面向人工智能代理和开发人员

⭐ 如果WebAuditMCP有助于您的工作流程，请启用此仓库！