From 9888af8b27af69732df6fdf81346b1db5c4e5bc1 Mon Sep 17 00:00:00 2001
From: Sebastian Benz <sbenz@google.com>
Date: Fri, 19 Sep 2025 12:25:44 +0200
Subject: [PATCH] chore: refactor docs generating

* add script `npm run docs` that builds, generate docs and runs
  formatter to auto fix formatting after doc generation
* rename generate-docs to docs:generate
* update presubmit workflow
* add docs process to contributing.md
---
 .github/workflows/presubmit.yml | 2 +-
 CONTRIBUTING.md                 | 4 ++++
 docs/tool-reference.md          | 2 +-
 package.json                    | 3 ++-
 scripts/generate-docs.ts        | 2 +-
 5 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/presubmit.yml b/.github/workflows/presubmit.yml
index 9f85a4ed1..b7faaf610 100644
--- a/.github/workflows/presubmit.yml
+++ b/.github/workflows/presubmit.yml
@@ -49,7 +49,7 @@ jobs:
         run: npm ci
 
       - name: Generate documents
-        run: npm run generate-docs && npm run format
+        run: npm run docs
 
       - name: Check if autogenerated docs differ
         run: |
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 1b3ae6a1b..80a40c054 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -81,3 +81,7 @@ npx @modelcontextprotocol/inspector node build/src/index.js --log-file=/your/des
 ```
 
 You can use the `DEBUG` environment variable as usual to control categories that are logged.
+
+### Updating documentation
+
+When adding a new tool or updating a tool name or description, make sure to run `npm run docs` to generate the tool reference documentation.
diff --git a/docs/tool-reference.md b/docs/tool-reference.md
index 40854d340..7a4a2b5d3 100644
--- a/docs/tool-reference.md
+++ b/docs/tool-reference.md
@@ -1,4 +1,4 @@
-<!-- AUTO GENERATED DO NOT EDIT - run 'npm run generate-docs' to update-->
+<!-- AUTO GENERATED DO NOT EDIT - run 'npm run docs' to update-->
 
 # Chrome DevTools MCP Tool Reference
 
diff --git a/package.json b/package.json
index de30968ae..f8b61e1ee 100644
--- a/package.json
+++ b/package.json
@@ -12,7 +12,8 @@
     "typecheck": "tsc --noEmit",
     "format": "eslint --cache --fix . ;prettier --write --cache .",
     "check-format": "eslint --cache .; prettier --check --cache .;",
-    "generate-docs": "npm run build && node --experimental-strip-types scripts/generate-docs.ts",
+    "docs": "npm run build && npm run docs:generate && npm run format",
+    "docs:generate": "node --experimental-strip-types scripts/generate-docs.ts",
     "start": "npm run build && node build/src/index.js",
     "start-debug": "DEBUG=mcp:* DEBUG_COLORS=false npm run build && node build/src/index.js",
     "test": "npm run build && node --require ./build/tests/setup.js --test-reporter spec --test-force-exit --test 'build/tests/**/*.test.js'",
diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts
index 104435990..d42db530e 100644
--- a/scripts/generate-docs.ts
+++ b/scripts/generate-docs.ts
@@ -190,7 +190,7 @@ async function generateToolDocumentation(): Promise<void> {
     console.log(`Found ${tools.length} tools`);
 
     // Generate markdown documentation
-    let markdown = `<!-- AUTO GENERATED DO NOT EDIT - run 'npm run generate-docs' to update-->
+    let markdown = `<!-- AUTO GENERATED DO NOT EDIT - run 'npm run docs' to update-->
 
 # Chrome DevTools MCP Tool Reference