validate_performance_gtmetrix
Analyze website performance using GTmetrix API to test page speed, identify optimization opportunities, and generate performance reports for web development.
Instructions
Analyze website performance using GTmetrix. Requires API key (free tier available).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| apiKey | Yes | GTmetrix API key (required) | |
| location | No | Test location (e.g., vancouver-canada) | |
| browser | No | Browser type (e.g., chrome) |
Implementation Reference
- src/performance/gtmetrix.ts:57-119 (handler)The core handler function that executes the GTmetrix performance analysis by creating a test via the GTmetrix API v2.0 and returning initial results.export async function analyzeGTmetrix( url: string, options: GTmetrixOptions ): Promise<GTmetrixResult> { try { if (!options.apiKey) { throw new Error('GTmetrix API key is required. Get one at https://gtmetrix.com/api/'); } // Start test const testResponse = await fetch('https://gtmetrix.com/api/2.0/tests', { method: 'POST', headers: { 'Authorization': `Basic ${Buffer.from(options.apiKey + ':').toString('base64')}`, 'Content-Type': 'application/vnd.api+json', }, body: JSON.stringify({ data: { type: 'test', attributes: { url, location: options.location || 'vancouver-canada', browser: options.browser || 'chrome', }, }, }), }); if (!testResponse.ok) { throw new Error(`GTmetrix API error: ${testResponse.status} ${testResponse.statusText}`); } const testData: GTmetrixResponse = await testResponse.json(); const testId = testData.data.id; // Poll for results (simplified - returns immediately with test ID) // For complete implementation, would poll until state === 'completed' return { tool: 'gtmetrix', success: testData.data.attributes.state !== 'error', url, test_id: testId, status: testData.data.attributes.state as any, lighthouse_score: testData.data.attributes.lighthouse_score, pagespeed_score: testData.data.attributes.pagespeed_score, yslow_score: testData.data.attributes.yslow_score, fully_loaded_time: testData.data.attributes.fully_loaded_time, page_bytes: testData.data.attributes.page_bytes, page_elements: testData.data.attributes.page_elements, report_url: testData.data.attributes.report_url, error: testData.data.attributes.error, raw: testData, }; } catch (error) { return { tool: 'gtmetrix', success: false, url, status: 'error', error: error instanceof Error ? error.message : String(error), }; } }
- index.ts:144-157 (registration)MCP tool registration including name, description, and JSON input schema.{ name: 'validate_performance_gtmetrix', description: 'Analyze website performance using GTmetrix. Requires API key (free tier available).', inputSchema: { type: 'object', properties: { url: { type: 'string' }, apiKey: { type: 'string', description: 'GTmetrix API key (required)' }, location: { type: 'string', description: 'Test location (e.g., vancouver-canada)' }, browser: { type: 'string', description: 'Browser type (e.g., chrome)' }, }, required: ['url', 'apiKey'], }, },
- index.ts:40-45 (schema)Zod schema used for runtime validation of tool arguments in the dispatch handler.const GTmetrixArgsSchema = z.object({ url: z.string().url(), apiKey: z.string(), location: z.string().optional(), browser: z.string().optional(), });
- index.ts:331-339 (handler)Dispatch handler case that validates arguments and calls the analyzeGTmetrix implementation.case 'validate_performance_gtmetrix': { const validatedArgs = GTmetrixArgsSchema.parse(args); const result = await analyzeGTmetrix(validatedArgs.url, { apiKey: validatedArgs.apiKey, location: validatedArgs.location, browser: validatedArgs.browser, }); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }] }; }
- src/performance/gtmetrix.ts:7-50 (helper)TypeScript interfaces defining options, API response, and result types for the GTmetrix tool.export interface GTmetrixOptions { /** API key (required - get from https://gtmetrix.com/api/) */ apiKey: string; /** Test location (e.g., 'vancouver-canada') */ location?: string; /** Browser (e.g., 'chrome', 'firefox') */ browser?: string; } export interface GTmetrixResponse { data: { id: string; type: string; attributes: { state: string; error?: string; report_url?: string; lighthouse_score?: number; pagespeed_score?: number; yslow_score?: number; fully_loaded_time?: number; page_bytes?: number; page_elements?: number; }; }; } export interface GTmetrixResult { tool: 'gtmetrix'; success: boolean; url: string; test_id?: string; status: 'queued' | 'started' | 'completed' | 'error'; lighthouse_score?: number; pagespeed_score?: number; yslow_score?: number; fully_loaded_time?: number; page_bytes?: number; page_elements?: number; report_url?: string; error?: string; raw?: GTmetrixResponse; }