chore: annotate tools (#351)

Fixes https://github.com/microsoft/playwright-mcp/issues/215

utils/update-readme.js

@@ -28,6 +28,7 @@ import filesTools from '../lib/tools/files.js';
 import installTools from '../lib/tools/install.js';
 import keyboardTools from '../lib/tools/keyboard.js';
 import navigateTools from '../lib/tools/navigate.js';
+import networkTools from '../lib/tools/network.js';
 import pdfTools from '../lib/tools/pdf.js';
 import snapshotTools from '../lib/tools/snapshot.js';
 import tabsTools from '../lib/tools/tabs.js';
@@ -62,6 +63,7 @@ const categories = {
     ...commonTools(true),
     ...installTools,
     ...dialogsTools(true),
+    ...networkTools,
   ],
   'Testing': [
     ...testTools,
@@ -75,74 +77,37 @@ const kStartMarker = `<!--- Generated by ${path.basename(__filename)} -->`;
 const kEndMarker = `<!--- End of generated section -->`;
 
 /**
- * @param {ParsedToolSchema} tool 
+ * @param {import('../src/tools/tool.js').ToolSchema<any>} tool 
  * @returns {string}
  */
 function formatToolForReadme(tool) {
   const lines = /** @type {string[]} */ ([]);
   lines.push(`<!-- NOTE: This has been generated via ${path.basename(__filename)} -->\n\n`);
   lines.push(`- **${tool.name}**\n`);
+  lines.push(`  - Title: ${tool.title}\n`);
   lines.push(`  - Description: ${tool.description}\n`);
 
-  if (tool.parameters && tool.parameters.length > 0) {
+  const inputSchema = /** @type {any} */ (zodToJsonSchema(tool.inputSchema || {}));
+  const requiredParams = inputSchema.required || [];
+  if (inputSchema.properties && Object.keys(inputSchema.properties).length) {
     lines.push(`  - Parameters:\n`);
-    tool.parameters.forEach(param => {
+    Object.entries(inputSchema.properties).forEach(([name, param]) => {
+      const optional = !requiredParams.includes(name);
       const meta = /** @type {string[]} */ ([]);
       if (param.type)
         meta.push(param.type);
-      if (param.optional)
+      if (optional)
         meta.push('optional');
-      lines.push(`    - \`${param.name}\` ${meta.length ? `(${meta.join(', ')})` : ''}: ${param.description}\n`);
+      lines.push(`    - \`${name}\` ${meta.length ? `(${meta.join(', ')})` : ''}: ${param.description}\n`);
     });
   } else {
     lines.push(`  - Parameters: None\n`);
   }
-
+  lines.push(`  - Read-only: **${tool.type === 'readOnly'}**\n`);
   lines.push('\n');
   return lines.join('');
 }
 
-/**
- * @typedef {{
- *   name: any;
- *  description: any;
- *   parameters: {
- *       name: string;
- *     description: string;
- *     optional: boolean;
- *     type: string;
- *   }[];
- *}} ParsedToolSchema
- */
-
-/**
- * @param {import('../src/tools/tool').ToolSchema<any>} schema 
- * @returns {ParsedToolSchema}
- */
-function processToolSchema(schema) {
-  const inputSchema = /** @type {import('zod-to-json-schema').JsonSchema7ObjectType} */ (zodToJsonSchema(schema.inputSchema || {}));
-  if (inputSchema.type !== 'object')
-    throw new Error(`Tool ${schema.name} input schema is not an object`);
-
-  // In JSON Schema, properties are considered optional unless listed in the required array
-  const requiredParams = inputSchema?.required || [];
-
-  const parameters = Object.entries(inputSchema.properties).map(([name, prop]) => {
-    return {
-      name,
-      description: prop.description || '',
-      optional: !requiredParams.includes(name),
-      type: /** @type {any} */ (prop).type,
-    };
-  });
-
-  return {
-    name: schema.name,
-    description: schema.description,
-    parameters
-  };
-}
-
 async function updateReadme() {
   console.log('Loading tool information from compiled modules...');
 
@@ -154,10 +119,8 @@ async function updateReadme() {
 
   for (const [category, categoryTools] of Object.entries(categories)) {
     generatedLines.push(`### ${category}\n\n`);
-    for (const tool of categoryTools) {
-      const scheme = processToolSchema(tool.schema);
-      generatedLines.push(formatToolForReadme(scheme));
-    }
+    for (const tool of categoryTools)
+      generatedLines.push(formatToolForReadme(tool.schema));
   }
 
   const readmePath = path.join(path.dirname(__filename), '..', 'README.md');