chore: update doc generation to specify flag

Author: nroscino

scripts/generate-cli.ts

@@ -11,7 +11,12 @@ import {Client} from '@modelcontextprotocol/sdk/client/index.js';
 import {StdioClientTransport} from '@modelcontextprotocol/sdk/client/stdio.js';
 
 import {parseArguments} from '../build/src/bin/chrome-devtools-mcp-cli-options.js';
-import {labels, ToolCategory} from '../build/src/tools/categories.js';
+import {CONDITION_TO_FLAG, buildFlag} from '../build/src/index.js';
+import {
+  labels,
+  ToolCategory,
+  OFF_BY_DEFAULT_CATEGORIES,
+} from '../build/src/tools/categories.js';
 import {createTools} from '../build/src/tools/tools.js';
 
 const OUTPUT_PATH = path.join(
@@ -83,10 +88,7 @@ function schemaToCLIOptions(schema: JsonSchema): CliOption[] {
   const properties = schema.properties;
   return Object.entries(properties).map(([name, prop]) => {
     const isRequired = required.includes(name);
-    let description = prop.description || '';
-    if (isRequired) {
-      description += ' (required)';
-    }
+    const description = prop.description || '';
     if (typeof prop.type !== 'string') {
       throw new Error(
         `Property ${name} has a complex type not supported by CLI.`,
@@ -107,12 +109,12 @@ async function generateCli() {
   const tools = await fetchTools();
 
   const staticTools = createTools(parseArguments());
-  const toolNameToCategory = new Map<string, string>();
+  const toolNameToCategoryEnum = new Map<string, string>();
+  const toolNameToConditions = new Map<string, string[]>();
+
   for (const tool of staticTools) {
-    toolNameToCategory.set(
-      tool.name,
-      labels[tool.annotations.category as keyof typeof labels],
-    );
+    toolNameToCategoryEnum.set(tool.name, tool.annotations.category);
+    toolNameToConditions.set(tool.name, tool.annotations.conditions || []);
   }
 
   // Sort tools by name
@@ -134,7 +136,7 @@ async function generateCli() {
         return false;
       }
       // Skipping in_page tools as they are not launched yet
-      if (toolNameToCategory.get(tool.name) === labels[ToolCategory.IN_PAGE]) {
+      if (toolNameToCategoryEnum.get(tool.name) === ToolCategory.IN_PAGE) {
         return false;
       }
       return true;
@@ -151,15 +153,40 @@ async function generateCli() {
     for (const opt of options) {
       args[opt.name] = opt;
     }
-    const category = toolNameToCategory.get(tool.name);
-    if (!category) {
+
+    const categoryEnum = toolNameToCategoryEnum.get(tool.name);
+    if (!categoryEnum) {
       throw new Error(`Tool ${tool.name} has no category.`);
     }
+    const category = labels[categoryEnum as unknown as keyof typeof labels];
     if (!tool.description) {
-      throw new Error(`Tool ${tool.name} is missing descripttion`);
+      throw new Error(`Tool ${tool.name} is missing description`);
     }
+
+    let description = tool.description;
+    const requiredFlags: string[] = [];
+
+    const isOffByDefault = OFF_BY_DEFAULT_CATEGORIES.includes(categoryEnum);
+    if (isOffByDefault) {
+      const categoryFlag = buildFlag(categoryEnum);
+      requiredFlags.push(`--${categoryFlag}=true`);
+    }
+
+    const conditions = toolNameToConditions.get(tool.name) || [];
+    for (const condition of conditions) {
+      const flag =
+        CONDITION_TO_FLAG[condition as keyof typeof CONDITION_TO_FLAG];
+      if (flag) {
+        requiredFlags.push(`--${flag}=true`);
+      }
+    }
+
+    if (requiredFlags.length > 0) {
+      description += ` (requires flag: ${requiredFlags.join(', ')})`;
+    }
+
     commands[tool.name] = {
-      description: tool.description,
+      description,
       category,
       args,
     };