Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 41 additions & 4 deletions src/McpResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import type {ResourceType} from 'puppeteer-core';
import {formatConsoleEvent} from './formatters/consoleFormatter.js';
import {
getFormattedHeaderValue,
getFormattedResponseBody,
getFormattedRequestBody,
getShortDescriptionForRequest,
getStatusFromRequest,
} from './formatters/networkFormatter.js';
Expand All @@ -21,10 +23,16 @@ import {handleDialog} from './tools/pages.js';
import type {ImageContentData, Response} from './tools/ToolDefinition.js';
import {paginate, type PaginationOptions} from './utils/pagination.js';

interface NetworkRequestData {
networkRequestUrl: string;
requestBody?: string;
responseBody?: string;
}

export class McpResponse implements Response {
#includePages = false;
#includeSnapshot = false;
#attachedNetworkRequestUrl?: string;
#attachedNetworkRequestData?: NetworkRequestData;
#includeConsoleData = false;
#textResponseLines: string[] = [];
#formattedConsoleData?: string[];
Expand Down Expand Up @@ -74,7 +82,9 @@ export class McpResponse implements Response {
}

attachNetworkRequest(url: string): void {
this.#attachedNetworkRequestUrl = url;
this.#attachedNetworkRequestData = {
networkRequestUrl: url,
};
}

get includePages(): boolean {
Expand All @@ -89,7 +99,7 @@ export class McpResponse implements Response {
return this.#includeConsoleData;
}
get attachedNetworkRequestUrl(): string | undefined {
return this.#attachedNetworkRequestUrl;
return this.#attachedNetworkRequestData?.networkRequestUrl;
}
get networkRequestsPageIdx(): number | undefined {
return this.#networkRequestsOptions?.pagination?.pageIdx;
Expand Down Expand Up @@ -127,6 +137,22 @@ export class McpResponse implements Response {
}

let formattedConsoleMessages: string[];

if (this.#attachedNetworkRequestData?.networkRequestUrl) {
const request = context.getNetworkRequestByUrl(
this.#attachedNetworkRequestData.networkRequestUrl,
);

this.#attachedNetworkRequestData.requestBody =
await getFormattedRequestBody(request);

const response = request.response();
if (response) {
this.#attachedNetworkRequestData.responseBody =
await getFormattedResponseBody(response);
}
}

if (this.#includeConsoleData) {
const consoleMessages = context.getConsoleData();
if (consoleMessages) {
Expand Down Expand Up @@ -274,10 +300,11 @@ Call ${handleDialog.name} to handle it before continuing.`);

#getIncludeNetworkRequestsData(context: McpContext): string[] {
const response: string[] = [];
const url = this.#attachedNetworkRequestUrl;
const url = this.#attachedNetworkRequestData?.networkRequestUrl;
if (!url) {
return response;
}

const httpRequest = context.getNetworkRequestByUrl(url);
response.push(`## Request ${httpRequest.url()}`);
response.push(`Status: ${getStatusFromRequest(httpRequest)}`);
Expand All @@ -286,6 +313,11 @@ Call ${handleDialog.name} to handle it before continuing.`);
response.push(line);
}

if (this.#attachedNetworkRequestData?.requestBody) {
response.push(`### Request Body`);
response.push(this.#attachedNetworkRequestData.requestBody);
}

const httpResponse = httpRequest.response();
if (httpResponse) {
response.push(`### Response Headers`);
Expand All @@ -294,6 +326,11 @@ Call ${handleDialog.name} to handle it before continuing.`);
}
}

if (this.#attachedNetworkRequestData?.responseBody) {
response.push(`### Response Body`);
response.push(this.#attachedNetworkRequestData.responseBody);
}

const httpFailure = httpRequest.failure();
if (httpFailure) {
response.push(`### Request failed with`);
Expand Down
64 changes: 63 additions & 1 deletion src/formatters/networkFormatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
* SPDX-License-Identifier: Apache-2.0
*/

import type {HTTPRequest} from 'puppeteer-core';
import {isUtf8} from 'node:buffer';

import type {HTTPRequest, HTTPResponse} from 'puppeteer-core';

const BODY_CONTEXT_SIZE_LIMIT = 10000;

export function getShortDescriptionForRequest(request: HTTPRequest): string {
return `${request.url()} ${request.method()} ${getStatusFromRequest(request)}`;
Expand Down Expand Up @@ -37,3 +41,61 @@ export function getFormattedHeaderValue(
}
return response;
}

export async function getFormattedResponseBody(
httpResponse: HTTPResponse,
sizeLimit = BODY_CONTEXT_SIZE_LIMIT,
): Promise<string | undefined> {
try {
const responseBuffer = await httpResponse.buffer();

if (isUtf8(responseBuffer)) {
const responseAsTest = responseBuffer.toString('utf-8');

if (responseAsTest.length === 0) {
return `<empty response>`;
}

return `${getSizeLimitedString(responseAsTest, sizeLimit)}`;
}

return `<binary data>`;
} catch {
// buffer() call might fail with CDP exception, in this case we don't print anything in the context
return;
}
}

export async function getFormattedRequestBody(
httpRequest: HTTPRequest,
sizeLimit: number = BODY_CONTEXT_SIZE_LIMIT,
): Promise<string | undefined> {
if (httpRequest.hasPostData()) {
const data = httpRequest.postData();

if (data) {
return `${getSizeLimitedString(data, sizeLimit)}`;
}

try {
const fetchData = await httpRequest.fetchPostData();

if (fetchData) {
return `${getSizeLimitedString(fetchData, sizeLimit)}`;
}
} catch {
// fetchPostData() call might fail with CDP exception, in this case we don't print anything in the context
return;
}
}

return;
}

function getSizeLimitedString(text: string, sizeLimit: number) {
if (text.length > sizeLimit) {
return `${text.substring(0, sizeLimit) + '... <truncated>'}`;
}

return `${text}`;
}
47 changes: 46 additions & 1 deletion tests/McpResponse.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import assert from 'node:assert';
import {describe, it} from 'node:test';

import {getMockRequest, html, withBrowser} from './utils.js';
import {getMockRequest, getMockResponse, html, withBrowser} from './utils.js';

describe('McpResponse', () => {
it('list pages', async () => {
Expand Down Expand Up @@ -202,6 +202,51 @@ http://example.com GET [pending]`,
});
});

it('add network request when attached with POST data', async () => {
await withBrowser(async (response, context) => {
response.setIncludeNetworkRequests(true);
const httpResponse = getMockResponse();
httpResponse.buffer = () => {
return Promise.resolve(Buffer.from(JSON.stringify({response: 'body'})));
};
httpResponse.headers = () => {
return {
'Content-Type': 'application/json',
};
};
const request = getMockRequest({
method: 'POST',
hasPostData: true,
postData: JSON.stringify({request: 'body'}),
response: httpResponse,
});
context.getNetworkRequests = () => {
return [request];
};
response.attachNetworkRequest(request.url());

const result = await response.handle('test', context);

assert.strictEqual(
result[0].text,
`# test response
## Request http://example.com
Status: [success - 200]
### Request Headers
- content-size:10
### Request Body
${JSON.stringify({request: 'body'})}
### Response Headers
- Content-Type:application/json
### Response Body
${JSON.stringify({response: 'body'})}
## Network requests
Showing 1-1 of 1 (Page 1 of 1).
http://example.com POST [success - 200]`,
);
});
});

it('add network request when attached', async () => {
await withBrowser(async (response, context) => {
response.setIncludeNetworkRequests(true);
Expand Down
Loading