Skip to content

Commit 0eb5c77

Browse files
committed
docs: add note to extension tools
1 parent b3c2707 commit 0eb5c77

3 files changed

Lines changed: 15 additions & 1 deletion

File tree

docs/tool-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,8 @@ in the DevTools Elements panel (if any).
398398

399399
## Extensions
400400

401+
> NOTE: Extensions are not active by default. Use the '--category-extensions' flag
402+
401403
### `install_extension`
402404

403405
**Description:** Installs a Chrome extension from the given path.

scripts/generate-docs.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ import {get_encoding} from 'tiktoken';
1313

1414
import {cliOptions} from '../build/src/bin/chrome-devtools-mcp-cli-options.js';
1515
import type {ParsedArguments} from '../build/src/bin/chrome-devtools-mcp-cli-options.js';
16-
import {ToolCategory, labels} from '../build/src/tools/categories.js';
16+
import {
17+
ToolCategory,
18+
OFF_BY_DEFAULT_CATEGORIES,
19+
labels,
20+
} from '../build/src/tools/categories.js';
1721
import {createTools} from '../build/src/tools/tools.js';
1822

1923
const OUTPUT_PATH = './docs/tool-reference.md';
@@ -351,6 +355,12 @@ async function generateReference(
351355

352356
markdown += `## ${categoryName}\n\n`;
353357

358+
if (OFF_BY_DEFAULT_CATEGORIES.includes(category)) {
359+
const flagName = `--category-${category}`;
360+
361+
markdown += `> NOTE: ${categoryName} are not active by default. Use the '${flagName}' flag\n\n`;
362+
}
363+
354364
// Sort tools within category
355365
categoryTools.sort((a: Tool, b: Tool) => a.name.localeCompare(b.name));
356366

src/tools/categories.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ export const labels = {
2727
[ToolCategory.IN_PAGE]: 'In-page tools',
2828
[ToolCategory.MEMORY]: 'Memory',
2929
};
30+
31+
export const OFF_BY_DEFAULT_CATEGORIES = [ToolCategory.EXTENSIONS];

0 commit comments

Comments
 (0)