seo-crawl-audit 0.16.1 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,14 +1,42 @@
1
1
  # SEO Crawl Audit
2
2
 
3
- Free, open-source, local-first SEO crawler and regression audit tool.
3
+ **Find technical SEO issues. Keep the evidence. Catch regressions.**
4
4
 
5
- `seo-audit` crawls server-rendered pages, saves a versioned JSON snapshot,
6
- finds concrete SEO problems, and detects regressions after a deployment. It
7
- needs no account or API key. Page HTML is processed in memory; normalized
8
- results stay in local JSON, checkpoint, CSV, and self-contained HTML files.
5
+ A free, open-source, local-first crawler with HTML reports, versioned JSON
6
+ snapshots and eight MCP tools for Codex, Claude Code and Claude Desktop. Plan a
7
+ bounded crawl, inspect concrete URL findings and compare runs after a deployment.
8
+ No SEO service account or SEO API key is required. Scans default to 100 pages
9
+ and respect robots.txt.
9
10
 
10
- [Open the interactive example report](https://melnixdev.github.io/seo-crawl-audit/)
11
- or [view its source file](https://github.com/MelnixDev/seo-crawl-audit/blob/main/examples/quotes-toscrape-report.html).
11
+ [Explore the example report](https://melnixdev.github.io/seo-crawl-audit/) ·
12
+ [Choose your installation](https://github.com/MelnixDev/seo-crawl-audit/blob/main/docs/native-plugins.md) ·
13
+ [CLI quick start](#requirements-and-installation)
14
+
15
+ ## Choose your client
16
+
17
+ | Client | Package and workspace |
18
+ | --- | --- |
19
+ | **Codex** | ZIP plugin and local marketplace. Configure one explicit, non-overlapping audit workspace before importing. Calls must name that workspace. [Setup](https://github.com/MelnixDev/seo-crawl-audit/blob/main/docs/native-plugins.md#codex-desktop-configure-then-install) |
20
+ | **Claude Code** | Same ZIP, loaded from outside the audited project. Uses Claude Code’s project directory. [Setup](https://github.com/MelnixDev/seo-crawl-audit/blob/main/docs/native-plugins.md#claude-code) |
21
+ | **Claude Desktop** | MCPB extension with a required existing-directory picker. [Setup](https://github.com/MelnixDev/seo-crawl-audit/blob/main/docs/native-plugins.md#claude-desktop-chat) |
22
+
23
+ Native packages are available with **0.17.0**. See the
24
+ [release notes](https://github.com/MelnixDev/seo-crawl-audit/blob/main/docs/releases/0.17.0.md) for exact verification and limitations.
25
+ No public directory listing or client endorsement is implied. The CLI remains
26
+ available through npm; its [quick start](#requirements-and-installation) is below.
27
+
28
+ The crawler sends HTTP requests to your chosen site and keeps artifacts in your
29
+ configured workspace. Your AI client receives tool results under its own data
30
+ policies. A crawl measures observed pages; it does not establish Google indexing,
31
+ rankings, traffic or complete site coverage.
32
+
33
+ ### A real bundled-MCP report
34
+
35
+ ![Report produced by the bundled MCP server from a three-page local fixture](https://raw.githubusercontent.com/MelnixDev/seo-crawl-audit/main/docs/site/media/native-report-pages.png)
36
+
37
+ This report was generated through the plugin’s bundled STDIO MCP server against
38
+ a deliberately small local fixture. It demonstrates actual report output, not an
39
+ installed AI client interface. [Watch the report walkthrough](https://github.com/MelnixDev/seo-crawl-audit/blob/main/docs/site/media/native-workflow.mp4).
12
40
 
13
41
  ## Report preview
14
42
 
@@ -579,7 +607,7 @@ jobs:
579
607
  runs-on: ubuntu-latest
580
608
  steps:
581
609
  - uses: actions/checkout@v4
582
- - uses: MelnixDev/seo-crawl-audit@v0
610
+ - uses: MelnixDev/seo-crawl-audit@v0.17.0
583
611
  id: seo
584
612
  with:
585
613
  url: https://preview.example.com/
@@ -9,7 +9,7 @@ Use this skill when a user asks to audit a website, check SEO regressions, inspe
9
9
 
10
10
  ## Workflow
11
11
 
12
- 1. Start with `seo_audit_plan` when using MCP. Confirm the URL, sitemap mode, page limit, and robots policy before requesting pages.
12
+ 1. Read the bound workspace in MCP initialization and ensure it matches the user's current project. If tools declare a required `workspace` argument, pass the current project's absolute real path; stop on a mismatch and reconfigure the plugin rather than scanning another project. Start with `seo_audit_plan` when using MCP. Confirm the URL, sitemap mode, page limit, and robots policy before requesting pages.
13
13
  2. Run `seo_audit_scan` for a baseline, or `seo_audit_check` with a saved baseline for a regression comparison. Keep the default 100-page limit unless the user explicitly asks for more.
14
14
  3. Use `seo_audit_compare` for two saved snapshots, `seo_audit_history` for a compact read-only trend over saved runs, or `seo_audit_issues` with filters and pagination to inspect concrete findings. Prioritize errors, then warnings, then informational context. Never treat a lower count across an incomplete or policy-changed trend as proven improvement.
15
15
  4. Use `seo_audit_report` when a human-readable HTML artifact is needed. Return artifact paths rather than embedding a large report in chat.