mirror of
https://github.com/ChromeDevTools/chrome-devtools-mcp.git
synced 2026-09-14 19:45:30 +08:00
docs: fix formatting and indentation of tool descriptions (#2275)
Follow-up on formatting changes introduced by dependency update in #2266 Co-authored-by: Piotr Paulski <piotrpaulski@chromium.org>
This commit is contained in:
+4
-11
@@ -347,20 +347,13 @@
|
||||
|
||||
### `evaluate_script`
|
||||
|
||||
**Description:** Evaluate a JavaScript function inside the currently selected page. Returns the response as JSON,
|
||||
so returned values have to be JSON-serializable.
|
||||
**Description:** Evaluate a JavaScript function inside the currently selected page. Returns the response as JSON, so returned values have to be JSON-serializable.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
- **function** (string) **(required)**: A JavaScript function declaration to be executed by the tool in the currently selected page.
|
||||
Example without arguments: `() => {
|
||||
return document.title
|
||||
}` or `async () => {
|
||||
return await fetch("example.com")
|
||||
}`.
|
||||
Example with arguments: `(el) => {
|
||||
return el.innerText;
|
||||
}`
|
||||
Example without arguments: `() => document.title` or `async () => await fetch("example.com")`.
|
||||
Example with arguments: `(el) => el.innerText`
|
||||
|
||||
- **args** (array) _(optional)_: An optional list of arguments to pass to the function.
|
||||
- **dialogAction** (string) _(optional)_: Handle dialogs while execution. "accept", "dismiss", or string for response of window.prompt. Defaults to accept.
|
||||
@@ -653,7 +646,7 @@ in the DevTools Elements panel (if any).
|
||||
Third-party developer tools can be called via the '[`execute_3p_developer_tool`](#execute_3p_developer_tool)()' MCP tool.
|
||||
Alternatively, third-party developer tools can be executed by calling '[`evaluate_script`](#evaluate_script)' and adding the
|
||||
following command to the script:
|
||||
'window.__dtmcp.executeTool(toolName, params)'
|
||||
`window.__dtmcp.executeTool(toolName, params)`
|
||||
This might be helpful when the third-party developer tools return non-serializable values or when composing
|
||||
third-party developer tools with additional functionality. (requires flag: --categoryExperimentalThirdParty=true)
|
||||
|
||||
|
||||
@@ -240,14 +240,14 @@ export const commands: Commands = {
|
||||
},
|
||||
evaluate_script: {
|
||||
description:
|
||||
'Evaluate a JavaScript function inside the currently selected page. Returns the response as JSON,\nso returned values have to be JSON-serializable.',
|
||||
'Evaluate a JavaScript function inside the currently selected page. Returns the response as JSON, so returned values have to be JSON-serializable.',
|
||||
category: 'Debugging',
|
||||
args: {
|
||||
function: {
|
||||
name: 'function',
|
||||
type: 'string',
|
||||
description:
|
||||
'A JavaScript function declaration to be executed by the tool in the currently selected page.\nExample without arguments: `() => {\n return document.title\n}` or `async () => {\n return await fetch("example.com")\n}`.\nExample with arguments: `(el) => {\n return el.innerText;\n}`\n',
|
||||
'A JavaScript function declaration to be executed by the tool in the currently selected page.\nExample without arguments: `() => document.title` or `async () => await fetch("example.com")`.\nExample with arguments: `(el) => el.innerText`\n',
|
||||
required: true,
|
||||
},
|
||||
args: {
|
||||
@@ -653,7 +653,7 @@ export const commands: Commands = {
|
||||
},
|
||||
list_3p_developer_tools: {
|
||||
description:
|
||||
"Lists all third-party developer tools the page exposes for providing runtime information.\n Third-party developer tools can be called via the 'execute_3p_developer_tool()' MCP tool.\n Alternatively, third-party developer tools can be executed by calling 'evaluate_script' and adding the\n following command to the script:\n 'window.__dtmcp.executeTool(toolName, params)'\n This might be helpful when the third-party developer tools return non-serializable values or when composing\n third-party developer tools with additional functionality. (requires flag: --categoryExperimentalThirdParty=true)",
|
||||
"Lists all third-party developer tools the page exposes for providing runtime information.\nThird-party developer tools can be called via the 'execute_3p_developer_tool()' MCP tool.\nAlternatively, third-party developer tools can be executed by calling 'evaluate_script' and adding the\nfollowing command to the script:\n`window.__dtmcp.executeTool(toolName, params)`\nThis might be helpful when the third-party developer tools return non-serializable values or when composing\nthird-party developer tools with additional functionality. (requires flag: --categoryExperimentalThirdParty=true)",
|
||||
category: 'Third-party',
|
||||
args: {},
|
||||
},
|
||||
|
||||
+3
-10
@@ -17,8 +17,7 @@ export type Evaluatable = Page | Frame | WebWorker;
|
||||
export const evaluateScript = defineTool(cliArgs => {
|
||||
return {
|
||||
name: 'evaluate_script',
|
||||
description: `Evaluate a JavaScript function inside the currently selected page${cliArgs?.categoryExtensions ? ' or service worker' : ''}. Returns the response as JSON,
|
||||
so returned values have to be JSON-serializable.`,
|
||||
description: `Evaluate a JavaScript function inside the currently selected page${cliArgs?.categoryExtensions ? ' or service worker' : ''}. Returns the response as JSON, so returned values have to be JSON-serializable.`,
|
||||
annotations: {
|
||||
category: ToolCategory.DEBUGGING,
|
||||
readOnlyHint: false,
|
||||
@@ -27,14 +26,8 @@ so returned values have to be JSON-serializable.`,
|
||||
...(cliArgs?.experimentalPageIdRouting ? pageIdSchema : {}),
|
||||
function: zod.string().describe(
|
||||
`A JavaScript function declaration to be executed by the tool in the currently selected page.
|
||||
Example without arguments: \`() => {
|
||||
return document.title
|
||||
}\` or \`async () => {
|
||||
return await fetch("example.com")
|
||||
}\`.
|
||||
Example with arguments: \`(el) => {
|
||||
return el.innerText;
|
||||
}\`
|
||||
Example without arguments: \`() => document.title\` or \`async () => await fetch("example.com")\`.
|
||||
Example with arguments: \`(el) => el.innerText\`
|
||||
`,
|
||||
),
|
||||
args: zod
|
||||
|
||||
@@ -45,12 +45,12 @@ declare global {
|
||||
export const listThirdPartyDeveloperTools = definePageTool({
|
||||
name: 'list_3p_developer_tools',
|
||||
description: `Lists all third-party developer tools the page exposes for providing runtime information.
|
||||
Third-party developer tools can be called via the 'execute_3p_developer_tool()' MCP tool.
|
||||
Alternatively, third-party developer tools can be executed by calling 'evaluate_script' and adding the
|
||||
following command to the script:
|
||||
'window.__dtmcp.executeTool(toolName, params)'
|
||||
This might be helpful when the third-party developer tools return non-serializable values or when composing
|
||||
third-party developer tools with additional functionality.`,
|
||||
Third-party developer tools can be called via the 'execute_3p_developer_tool()' MCP tool.
|
||||
Alternatively, third-party developer tools can be executed by calling 'evaluate_script' and adding the
|
||||
following command to the script:
|
||||
\`window.__dtmcp.executeTool(toolName, params)\`
|
||||
This might be helpful when the third-party developer tools return non-serializable values or when composing
|
||||
third-party developer tools with additional functionality.`,
|
||||
annotations: {
|
||||
category: ToolCategory.THIRD_PARTY,
|
||||
readOnlyHint: true,
|
||||
|
||||
Reference in New Issue
Block a user