list tools

Author: wolfib

README.md

@@ -475,8 +475,6 @@ If you run into any issues, checkout our [troubleshooting guide](./docs/troubles
   - [`list_console_messages`](docs/tool-reference.md#list_console_messages)
   - [`take_screenshot`](docs/tool-reference.md#take_screenshot)
   - [`take_snapshot`](docs/tool-reference.md#take_snapshot)
-- **In-page tools** (1 tools)
-  - [`list_in_page_tools`](docs/tool-reference.md#list_in_page_tools)
 
 <!-- END AUTO GENERATED TOOLS -->
 
@@ -568,11 +566,6 @@ The Chrome DevTools MCP server supports the following configuration option:
   - **Type:** boolean
   - **Default:** `true`
 
-- **`--categoryInPageTools`/ `--category-in-page-tools`**
-  Set to true to enable tools exposed by the inspected page itself
-  - **Type:** boolean
-  - **Default:** `false`
-
 - **`--performanceCrux`/ `--performance-crux`**
   Set to false to disable sending URLs from performance traces to CrUX API to get field performance data.
   - **Type:** boolean

docs/tool-reference.md

@@ -37,8 +37,6 @@
   - [`list_console_messages`](#list_console_messages)
   - [`take_screenshot`](#take_screenshot)
   - [`take_snapshot`](#take_snapshot)
-- **[In-page tools](#in-page-tools)** (1 tools)
-  - [`list_in_page_tools`](#list_in_page_tools)
 
 ## Input automation
 
@@ -399,15 +397,3 @@ in the DevTools Elements panel (if any).
 - **verbose** (boolean) _(optional)_: Whether to include all possible information available in the full a11y tree. Default is false.
 
 ---
-
-## In-page tools
-
-### `list_in_page_tools`
-
-**Description:** Lists all in-page-tools the page exposes for providing runtime information.
-In-page-tools are exposed on the page via the 'window.\_\_dtmcp.executeTool(toolName, params)'
-function where they can be called by '[`evaluate_script`](#evaluate_script)'.
-
-**Parameters:** None
-
----

src/bin/chrome-devtools-mcp-cli-options.ts

@@ -219,7 +219,6 @@ export const cliOptions = {
   categoryInPageTools: {
     type: 'boolean',
     hidden: true,
-    default: false,
     describe:
       'Set to true to enable tools exposed by the inspected page itself',
   },

src/tools/pages.ts

@@ -27,6 +27,7 @@ export const listPages = defineTool(args => {
     schema: {},
     handler: async (_request, response) => {
       response.setIncludePages(true);
+      response.setListInPageTools();
     },
   };
 });
@@ -53,6 +54,7 @@ export const selectPage = defineTool({
     const page = context.getPageById(request.params.pageId);
     context.selectPage(page);
     response.setIncludePages(true);
+    response.setListInPageTools();
     if (request.params.bringToFront) {
       await page.pptrPage.bringToFront();
     }
@@ -82,6 +84,7 @@ export const closePage = defineTool({
       }
     }
     response.setIncludePages(true);
+    response.setListInPageTools();
   },
 });
 
@@ -275,6 +278,7 @@ export const navigatePage = definePageTool({
     }
 
     response.setIncludePages(true);
+    response.setListInPageTools();
   },
 });
 

tests/McpResponse.test.ts

@@ -13,6 +13,14 @@ import {describe, it} from 'node:test';
 import sinon from 'sinon';
 
 import type {ParsedArguments} from '../src/bin/chrome-devtools-mcp-cli-options.js';
+import type {McpContext} from '../src/McpContext.js';
+import type {McpResponse} from '../src/McpResponse.js';
+import {
+  closePage,
+  listPages,
+  navigatePage,
+  selectPage,
+} from '../src/tools/pages.js';
 import type {InsightName} from '../src/trace-processing/parse.js';
 import {
   parseRawTraceBuffer,
@@ -1091,4 +1099,93 @@ describe('inPage tools', () => {
       {categoryInPageTools: true} as ParsedArguments,
     );
   });
+
+  async function testIncludesInPageTools(
+    handlerAction: (
+      response: McpResponse,
+      context: McpContext,
+    ) => Promise<void>,
+    toolName: string,
+  ) {
+    await withMcpContext(
+      async (response, context) => {
+        const mcpPage = context.getSelectedMcpPage();
+        stubToolDiscovery(mcpPage.pptrPage);
+
+        const initScript = `
+          window.__dtmcp = {
+            toolGroup: {
+              name: 'In-Page group',
+              description: 'Test tools',
+              tools: [
+                {
+                  name: 'inPageTool',
+                  description: 'A test tool',
+                  inputSchema: {
+                    type: 'object',
+                    properties: {},
+                  },
+                  execute: () => 'result',
+                },
+              ],
+            },
+          };
+          window.addEventListener('devtoolstooldiscovery', (e) => {
+            e.respondWith(window.__dtmcp?.toolGroup);
+          });
+        `;
+        await mcpPage.pptrPage.evaluateOnNewDocument(initScript);
+        await mcpPage.pptrPage.evaluate(initScript);
+
+        await handlerAction(response, context);
+
+        const {content} = await response.handle(toolName, context);
+        const responseText = getTextContent(content[0]);
+        assert.ok(
+          responseText.includes('inPageTool'),
+          `Should include in-page tool name in the ${toolName} response`,
+        );
+      },
+      undefined,
+      {categoryInPageTools: true} as ParsedArguments,
+    );
+  }
+
+  it('includes in-page tools in list_pages response', async () => {
+    await testIncludesInPageTools(async (response, context) => {
+      const listPagesDef = listPages({
+        categoryInPageTools: true,
+      } as ParsedArguments);
+      await listPagesDef.handler({params: {}}, response, context);
+    }, 'list_pages');
+  });
+
+  it('includes in-page tools in select_page response', async () => {
+    await testIncludesInPageTools(async (response, context) => {
+      const pageId =
+        context.getPageId(context.getSelectedMcpPage().pptrPage) ?? 1;
+      await selectPage.handler({params: {pageId}}, response, context);
+    }, 'select_page');
+  });
+
+  it('includes in-page tools in close_page response', async () => {
+    await testIncludesInPageTools(async (response, context) => {
+      const pageId =
+        context.getPageId(context.getSelectedMcpPage().pptrPage) ?? 1;
+      await closePage.handler({params: {pageId}}, response, context);
+    }, 'close_page');
+  });
+
+  it('includes in-page tools in navigate_page response', async () => {
+    await testIncludesInPageTools(async (response, context) => {
+      await navigatePage.handler(
+        {
+          params: {type: 'url', url: 'about:blank'},
+          page: context.getSelectedMcpPage(),
+        },
+        response,
+        context,
+      );
+    }, 'navigate_page');
+  });
 });

tests/cli.test.ts

@@ -23,8 +23,6 @@ describe('cli args parsing', () => {
     performanceCrux: true,
     'usage-statistics': true,
     usageStatistics: true,
-    'category-in-page-tools': false,
-    categoryInPageTools: false,
   };
 
   it('parses with default args', async () => {

tests/index.test.ts

@@ -72,52 +72,47 @@ describe('e2e', () => {
   });
 
   it('has all tools', async () => {
-    await withClient(
-      async client => {
-        const {tools} = await client.listTools();
-        const exposedNames = tools.map(t => t.name).sort();
-        const files = fs.readdirSync('build/src/tools');
-        const definedNames = [];
-        for (const file of files) {
-          if (
-            file === 'ToolDefinition.js' ||
-            file === 'tools.js' ||
-            file === 'slim'
-          ) {
-            continue;
-          }
-          const fileTools = await import(`../src/tools/${file}`);
-          for (const maybeTool of Object.values<unknown>(fileTools)) {
-            if (typeof maybeTool === 'function') {
-              const tool = (maybeTool as (val: boolean) => ToolDefinition)(
-                false,
-              );
-              if (tool && typeof tool === 'object' && 'name' in tool) {
-                if (tool.annotations?.conditions) {
-                  continue;
-                }
-                definedNames.push(tool.name);
-              }
-              continue;
-            }
-            if (
-              typeof maybeTool === 'object' &&
-              maybeTool !== null &&
-              'name' in maybeTool
-            ) {
-              const tool = maybeTool as ToolDefinition;
+    await withClient(async client => {
+      const {tools} = await client.listTools();
+      const exposedNames = tools.map(t => t.name).sort();
+      const files = fs.readdirSync('build/src/tools');
+      const definedNames = [];
+      for (const file of files) {
+        if (
+          file === 'ToolDefinition.js' ||
+          file === 'tools.js' ||
+          file === 'slim'
+        ) {
+          continue;
+        }
+        const fileTools = await import(`../src/tools/${file}`);
+        for (const maybeTool of Object.values<unknown>(fileTools)) {
+          if (typeof maybeTool === 'function') {
+            const tool = (maybeTool as (val: boolean) => ToolDefinition)(false);
+            if (tool && typeof tool === 'object' && 'name' in tool) {
               if (tool.annotations?.conditions) {
                 continue;
               }
               definedNames.push(tool.name);
             }
+            continue;
+          }
+          if (
+            typeof maybeTool === 'object' &&
+            maybeTool !== null &&
+            'name' in maybeTool
+          ) {
+            const tool = maybeTool as ToolDefinition;
+            if (tool.annotations?.conditions) {
+              continue;
+            }
+            definedNames.push(tool.name);
           }
         }
-        definedNames.sort();
-        assert.deepStrictEqual(exposedNames, definedNames);
-      },
-      ['--category-in-page-tools'],
-    );
+      }
+      definedNames.sort();
+      assert.deepStrictEqual(exposedNames, definedNames);
+    });
   });
 
   it('has experimental in-Page tools', async () => {

tests/tools/inPage.test.ts

@@ -86,7 +86,11 @@ describe('inPage', () => {
           const result = await response.handle('list_in_page_tools', context);
           assert.ok('inPageTools' in result.structuredContent);
           assert.deepEqual(
-            (result.structuredContent as {inPageTools: ToolGroup<ToolDefinition>}).inPageTools,
+            (
+              result.structuredContent as {
+                inPageTools: ToolGroup<ToolDefinition>;
+              }
+            ).inPageTools,
             {},
           );
         },
@@ -110,7 +114,11 @@ describe('inPage', () => {
           const result = await response.handle('list_in_page_tools', context);
           assert.ok('inPageTools' in result.structuredContent);
           assert.strictEqual(
-            (result.structuredContent as {inPageTools: ToolGroup<ToolDefinition>}).inPageTools,
+            (
+              result.structuredContent as {
+                inPageTools: ToolGroup<ToolDefinition>;
+              }
+            ).inPageTools,
             undefined,
           );
         },