docs: Update README with Best Practices audit details and usage instructions

This commit is contained in:
Emil Neander 2025-03-06 18:31:12 +01:00
parent 0e3614b778
commit 934ac6b43f

View File

@ -1,13 +1,23 @@
# BrowserTools MCP (Fork)
This fork of [BrowserTools MCP](https://github.com/AgentDeskAI/browser-tools-mcp) extends the original browser monitoring toolset with Lighthouse-powered accessibility, performance, and SEO audits, leveraging Puppeteer for headless browser control.
This fork of [BrowserTools MCP](https://github.com/AgentDeskAI/browser-tools-mcp) extends the original browser monitoring toolset with Lighthouse-powered accessibility, performance, and SEO audits, leveraging Puppeteer for headless browser control.
## Key Additions
- **Accessibility Audits**: WCAG-compliant checks using Lighthouse.
- **Accessibility Audits**:
- **Performance Audits**: Analyze page load and runtime efficiency.
- **SEO Audits**: Assess on-page SEO factors and suggest improvements.
- **Best Practices Audit**: Run a best practices audit.
- **Puppeteer Integration**: Enables reliable, headless browser audits.
### Using Audit Tools
#### Before you start
Make sure that you have an active tab in your browser with BrowserTools extension being active.
#### Running audits
The MCP server provides tools to run audits on the current page. Here are example queries you can use to trigger them:
- **Accessibility Audit** (`runAccessibilityAudit`):
@ -22,6 +32,10 @@ The MCP server provides tools to run audits on the current page. Here are exampl
- "How can I improve SEO for this page?"
- "Run an SEO audit."
- "Check SEO on this page."
- **Best Practices Audit** (`runBestPracticesAudit`):
- "Run a best practices audit."
- "Check best practices on this page."
- "Are there any best practices issues on this page?"
## Quick Start