@democratize-quality/mcp-server 1.2.0 → 1.2.1

package/src/tools/api/api-request.js

@@ -0,0 +1,660 @@
+/**
+ * Copyright (C) 2025 Democratize Quality
+ *
+ * This file is part of Democratize Quality MCP Server.
+ *
+ * Democratize Quality MCP Server is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Democratize Quality MCP Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Democratize Quality MCP Server. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+const ToolBase = require('../base/ToolBase');
+const https = require('https');
+const http = require('http');
+const { URL } = require('url');
+
+let z;
+try {
+    // import Zod
+    const zod = require('zod');
+    z = zod.z || zod.default?.z || zod;
+    if (!z || typeof z.object !== 'function') {
+        throw new Error('Zod not properly loaded');
+    }
+} catch (error) {
+    console.error('Failed to load Zod:', error.message);
+    // Fallback: create a simple validation function
+    z = {
+        object: (schema) => ({ parse: (data) => data }),
+        string: () => ({ optional: () => ({}) }),
+        enum: () => ({ optional: () => ({}) }),
+        record: () => ({ optional: () => ({}) }),
+        any: () => ({ optional: () => ({}) }),
+        number: () => ({ optional: () => ({}) }),
+        array: () => ({ optional: () => ({}) })
+    };
+}
+
+// Input schema for the API request tool
+const chainStepSchema = z.object({
+    name: z.string(),
+    method: z.enum(['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']).optional(),
+    url: z.string(),
+    headers: z.record(z.string()).optional(),
+    data: z.any().optional(),
+    expect: z.object({
+        status: z.number().optional(),
+        contentType: z.string().optional(),
+        body: z.any().optional(),
+        bodyRegex: z.string().optional()
+    }).optional(),
+    extract: z.record(z.string()).optional() // { varName: 'field' }
+});
+
+const apiRequestInputSchema = z.object({
+    sessionId: z.string().optional(), // New: session management
+    // Single-request legacy mode
+    method: z.enum(['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']).optional(),
+    url: z.string().optional(),
+    headers: z.record(z.string()).optional(),
+    data: z.any().optional(),
+    expect: z.object({
+        status: z.number().optional(),
+        contentType: z.string().optional(),
+        body: z.any().optional(),
+        bodyRegex: z.string().optional()
+    }).optional(),
+    // Chaining mode
+    chain: z.array(chainStepSchema).optional()
+});
+
+// --- In-memory session store ---
+const sessionStore = global.__API_SESSION_STORE__ || new Map();
+global.__API_SESSION_STORE__ = sessionStore;
+
+/**
+ * API Request Tool - Perform HTTP API requests with validation and session management
+ */
+class ApiRequestTool extends ToolBase {
+    static definition = {
+        name: "api_request",
+        description: "Perform HTTP API requests with validation, session management, and request chaining capabilities for comprehensive API testing.",
+        input_schema: {
+            type: "object",
+            properties: {
+                sessionId: {
+                    type: "string",
+                    description: "Optional session ID for managing related requests"
+                },
+                method: {
+                    type: "string",
+                    enum: ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"],
+                    description: "HTTP method for the request"
+                },
+                url: {
+                    type: "string",
+                    description: "Target URL for the HTTP request"
+                },
+                headers: {
+                    type: "object",
+                    additionalProperties: { type: "string" },
+                    description: "HTTP headers as key-value pairs"
+                },
+                data: {
+                    description: "Request body data (JSON object, string, etc.)"
+                },
+                expect: {
+                    type: "object",
+                    properties: {
+                        status: {
+                            type: "number",
+                            description: "Expected HTTP status code"
+                        },
+                        contentType: {
+                            type: "string",
+                            description: "Expected content type"
+                        },
+                        body: {
+                            description: "Expected response body content"
+                        },
+                        bodyRegex: {
+                            type: "string",
+                            description: "Regex pattern to match against response body"
+                        }
+                    },
+                    description: "Validation expectations for the response"
+                },
+                chain: {
+                    type: "array",
+                    items: {
+                        type: "object",
+                        properties: {
+                            name: {
+                                type: "string",
+                                description: "Step name for reference in chaining"
+                            },
+                            method: {
+                                type: "string",
+                                enum: ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"],
+                                description: "HTTP method for this step"
+                            },
+                            url: {
+                                type: "string",
+                                description: "URL for this step (supports templating)"
+                            },
+                            headers: {
+                                type: "object",
+                                additionalProperties: { type: "string" },
+                                description: "Headers for this step"
+                            },
+                            data: {
+                                description: "Data for this step"
+                            },
+                            expect: {
+                                type: "object",
+                                properties: {
+                                    status: { type: "number" },
+                                    contentType: { type: "string" },
+                                    body: {},
+                                    bodyRegex: { type: "string" }
+                                },
+                                description: "Validation expectations"
+                            },
+                            extract: {
+                                type: "object",
+                                additionalProperties: { type: "string" },
+                                description: "Fields to extract for use in subsequent steps"
+                            }
+                        },
+                        required: ["name", "url"]
+                    },
+                    description: "Chain of requests to execute sequentially"
+                }
+            },
+            additionalProperties: false
+        }
+    };
+
+    constructor() {
+        super();
+        this.sessionStore = sessionStore;
+    }
+
+    /**
+     * Simple validation function as fallback if Zod fails
+     */
+    validateInput(input) {
+        // Basic validation
+        if (typeof input !== 'object' || input === null) {
+            throw new Error('Input must be an object');
+        }
+
+        // If chain is provided, validate chain structure
+        if (input.chain && Array.isArray(input.chain)) {
+            for (let i = 0; i < input.chain.length; i++) {
+                const step = input.chain[i];
+                if (!step.name || !step.url) {
+                    throw new Error(`Chain step ${i}: missing required fields 'name' or 'url'`);
+                }
+                if (step.method && !['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'].includes(step.method)) {
+                    throw new Error(`Chain step ${i}: invalid method '${step.method}'`);
+                }
+            }
+        }
+
+        // For single request mode, url is required if no chain
+        if (!input.chain && !input.url) {
+            throw new Error('URL is required for single request mode');
+        }
+
+        if (input.method && !['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'].includes(input.method)) {
+            throw new Error(`Invalid method '${input.method}'`);
+        }
+
+        return input;
+    }
+
+    async execute(parameters) {
+        try {
+            // Validate input - try Zod first, fallback to simple validation
+            let input;
+            try {
+                if (typeof apiRequestInputSchema.parse === 'function') {
+                    input = apiRequestInputSchema.parse(parameters);
+                } else {
+                    input = this.validateInput(parameters);
+                }
+            } catch (zodError) {
+                console.warn('Zod validation failed, using fallback validation:', zodError.message);
+                input = this.validateInput(parameters);
+            }
+
+            // --- Session Management ---
+            const uuid = () => {
+                if (typeof crypto !== 'undefined' && typeof crypto.randomUUID === 'function')
+                    return crypto.randomUUID();
+                // Simple pseudo-unique fallback: not cryptographically secure, but fine for session IDs
+                return 'session-' + Date.now().toString(36) + '-' + Math.random().toString(36).slice(2, 10);
+            };
+
+            const sessionId = input.sessionId || uuid();
+            if (!sessionStore.has(sessionId)) {
+                sessionStore.set(sessionId, {
+                    sessionId,
+                    startTime: new Date().toISOString(),
+                    logs: [],
+                    status: 'running'
+                });
+            }
+            const session = sessionStore.get(sessionId);
+
+            // --- API CHAINING SUPPORT ---
+            function renderTemplate(str, vars) {
+                if (typeof str !== 'string') return str;
+                return str.replace(/\{\{\s*([\w.]+)\s*\}\}/g, (_, path) => {
+                    const [step, ...rest] = path.split('.');
+                    let val = vars[step];
+                    for (const p of rest)
+                        val = val?.[p];
+                    return val !== undefined ? String(val) : '';
+                });
+            }
+
+            function extractFields(obj, extract) {
+                const result = {};
+                if (!extract || typeof extract !== 'object') return result;
+                
+                for (const [k, path] of Object.entries(extract)) {
+                    if (typeof path !== 'string') continue;
+                    const parts = path.split('.');
+                    let val = obj;
+                    for (const p of parts) {
+                        val = val?.[p];
+                        if (val === undefined) break;
+                    }
+                    result[k] = val;
+                }
+                return result;
+            }
+
+            // If 'chain' is present, execute steps sequentially
+            if (Array.isArray(input.chain)) {
+                const stepVars = {};
+                const results = [];
+
+                for (const step of input.chain) {
+                    // Validate step has required fields
+                    if (!step.name || !step.url) {
+                        throw new Error(`Invalid chain step: missing name or url`);
+                    }
+
+                    // Render templates in url, headers, data
+                    const url = renderTemplate(step.url, stepVars);
+                    const headers = {};
+                    for (const k in (step.headers || {})) {
+                        headers[k] = renderTemplate(step.headers[k], stepVars);
+                    }
+
+                    let data = step.data;
+                    if (typeof data === 'string') {
+                        data = renderTemplate(data, stepVars);
+                    } else if (typeof data === 'object' && data !== null) {
+                        // Handle object data with template rendering
+                        try {
+                            data = JSON.parse(renderTemplate(JSON.stringify(data), stepVars));
+                        } catch (e) {
+                            // If JSON parsing fails, keep original data
+                            console.warn('Failed to parse templated data, using original:', e.message);
+                        }
+                    }
+
+                    // Execute request using Node.js built-in modules
+                    const response = await this.makeHttpRequest(
+                        step.method || 'GET',
+                        url,
+                        headers,
+                        data
+                    );
+
+                    const status = response.statusCode;
+                    const statusText = response.statusMessage || '';
+                    const contentType = response.headers['content-type'] || '';
+                    let responseBody = response.body;
+
+                    if (contentType.includes('application/json')) {
+                        try {
+                            responseBody = JSON.parse(response.body);
+                        } catch (e) {
+                            // Keep as string if JSON parsing fails
+                        }
+                    }
+
+                    // Validation
+                    const expect = step.expect || {};
+                    const validation = {
+                        status: expect.status ? status === expect.status : true,
+                        contentType: expect.contentType ? contentType.includes(expect.contentType) : true
+                    };
+
+                    let bodyValidation = { matched: true, reason: 'No body expectation set.' };
+                    if (expect.body !== undefined) {
+                        if (typeof responseBody === 'object' && responseBody !== null && typeof expect.body === 'object') {
+                            bodyValidation.matched = Object.entries(expect.body).every(
+                                ([k, v]) => JSON.stringify(responseBody[k]) === JSON.stringify(v)
+                            );
+                            bodyValidation.reason = bodyValidation.matched
+                                ? 'Partial/exact body match succeeded.'
+                                : 'Partial/exact body match failed.';
+                        } else if (typeof expect.body === 'string') {
+                            bodyValidation.matched = JSON.stringify(responseBody) === expect.body || responseBody === expect.body;
+                            bodyValidation.reason = bodyValidation.matched
+                                ? 'Exact string match succeeded.'
+                                : 'Exact string match failed.';
+                        } else {
+                            bodyValidation.matched = false;
+                            bodyValidation.reason = 'Body type mismatch.';
+                        }
+                    }
+                    if (expect.bodyRegex) {
+                        try {
+                            const pattern = new RegExp(expect.bodyRegex);
+                            const target = typeof responseBody === 'string' ? responseBody : JSON.stringify(responseBody);
+                            const regexMatch = pattern.test(target);
+                            bodyValidation = {
+                                matched: regexMatch,
+                                reason: regexMatch ? 'Regex match succeeded.' : 'Regex match failed.'
+                            };
+                        } catch (regexError) {
+                            bodyValidation = {
+                                matched: false,
+                                reason: `Invalid regex pattern: ${regexError.message}`
+                            };
+                        }
+                    }
+
+                    // Extract variables
+                    const extracted = step.extract ? extractFields(responseBody, step.extract) : {};
+                    // Add extracted variables directly to stepVars for template rendering
+                    Object.assign(stepVars, extracted);
+                    // Also store step results for reference (including all response data)
+                    stepVars[step.name] = { 
+                        ...extracted, 
+                        body: responseBody, 
+                        status, 
+                        contentType,
+                        // Add common response fields for easier access
+                        id: responseBody?.id,
+                        userId: responseBody?.userId,
+                        title: responseBody?.title
+                    };
+
+                    // Record step result
+                    results.push({
+                        name: step.name,
+                        status,
+                        statusText,
+                        contentType,
+                        body: responseBody,
+                        expectations: step.expect || {},
+                        validation,
+                        bodyValidation,
+                        extracted
+                    });
+
+                    // Log to session
+                    session.logs.push({
+                        type: 'request',
+                        request: {
+                            method: step.method || 'GET',
+                            url,
+                            headers,
+                            data
+                        },
+                        response: {
+                            status,
+                            statusText,
+                            contentType,
+                            body: responseBody
+                        },
+                        expectations: step.expect || {},
+                        validation,
+                        bodyValidation,
+                        timestamp: new Date().toISOString()
+                    });
+                }
+
+                // Log to session
+                session.logs.push({
+                    type: 'chain',
+                    steps: results,
+                    timestamp: new Date().toISOString()
+                });
+                session.status = 'completed';
+
+                return {
+                    content: [{
+                        type: 'text',
+                        text: JSON.stringify({ sessionId, results }, null, 2)
+                    }]
+                };
+            }
+
+            // --- SINGLE REQUEST MODE (legacy) ---
+            const { method, url, headers, data, expect } = input;
+
+            // Validate required parameters for single request mode
+            if (!url)
+                throw new Error('URL is required for single request mode');
+
+            const response = await this.makeHttpRequest(
+                method || 'GET',
+                url,
+                headers,
+                data
+            );
+
+            const status = response.statusCode;
+            const statusText = response.statusMessage || '';
+            const contentType = response.headers['content-type'] || '';
+            let responseBody = response.body;
+
+            if (contentType.includes('application/json')) {
+                try {
+                    responseBody = JSON.parse(response.body);
+                } catch (e) {
+                    // Keep as string if JSON parsing fails
+                }
+            }
+
+            // Basic validation
+            const validation = {
+                status: expect?.status ? status === expect.status : true,
+                contentType: expect?.contentType ? contentType.includes(expect?.contentType) : true
+            };
+
+            // --- Enhanced Response Body Validation ---
+            let bodyValidation = { matched: true, reason: 'No body expectation set.' };
+            if (expect?.body !== undefined) {
+                if (typeof responseBody === 'object' && responseBody !== null && typeof expect.body === 'object') {
+                    // Partial match: all keys/values in expect.body must be present in responseBody
+                    bodyValidation.matched = Object.entries(expect.body).every(
+                        ([k, v]) => JSON.stringify(responseBody[k]) === JSON.stringify(v)
+                    );
+                    bodyValidation.reason = bodyValidation.matched
+                        ? 'Partial/exact body match succeeded.'
+                        : 'Partial/exact body match failed.';
+                } else if (typeof expect.body === 'string') {
+                    bodyValidation.matched = JSON.stringify(responseBody) === expect.body || responseBody === expect.body;
+                    bodyValidation.reason = bodyValidation.matched
+                        ? 'Exact string match succeeded.'
+                        : 'Exact string match failed.';
+                } else {
+                    bodyValidation.matched = false;
+                    bodyValidation.reason = 'Body type mismatch.';
+                }
+            }
+            if (expect?.bodyRegex) {
+                try {
+                    const pattern = new RegExp(expect.bodyRegex);
+                    const target = typeof responseBody === 'string' ? responseBody : JSON.stringify(responseBody);
+                    const regexMatch = pattern.test(target);
+                    bodyValidation = {
+                        matched: regexMatch,
+                        reason: regexMatch ? 'Regex match succeeded.' : 'Regex match failed.'
+                    };
+                } catch (regexError) {
+                    bodyValidation = {
+                        matched: false,
+                        reason: `Invalid regex pattern: ${regexError.message}`
+                    };
+                }
+            }
+            // --- End Enhanced Validation ---
+
+            // Log to session
+            if (session && session.logs) {
+                session.logs.push({
+                    type: 'single',
+                    request: {
+                        method: method || 'GET',
+                        url,
+                        headers,
+                        data
+                    },
+                    response: {
+                        status,
+                        statusText,
+                        contentType,
+                        body: responseBody
+                    },
+                    expectations: expect || {},
+                    validation,
+                    bodyValidation,
+                    timestamp: new Date().toISOString()
+                });
+            }
+
+            return {
+                content: [{
+                    type: 'text',
+                    text: JSON.stringify({
+                        ok: validation.status && validation.contentType && bodyValidation.matched,
+                        status,
+                        statusText,
+                        contentType,
+                        body: responseBody,
+                        validation,
+                        bodyValidation
+                    }, null, 2)
+                }]
+            };
+
+        } catch (error) {
+            // Error handling for API request execution
+            const errorMessage = error.message || 'Unknown error occurred';
+            console.error('ApiRequestTool execution error:', errorMessage);
+            
+            return {
+                content: [{
+                    type: 'text',
+                    text: JSON.stringify({
+                        error: true,
+                        message: errorMessage,
+                        stack: error.stack
+                    }, null, 2)
+                }]
+            };
+        }
+    }
+
+    /**
+     * Make HTTP request using Node.js built-in modules
+     */
+    async makeHttpRequest(method, urlString, headers = {}, data, timeout = 30000) {
+        return new Promise((resolve, reject) => {
+            let url;
+            try {
+                url = new URL(urlString);
+            } catch (urlError) {
+                reject(new Error(`Invalid URL: ${urlString}`));
+                return;
+            }
+
+            const isHttps = url.protocol === 'https:';
+            const lib = isHttps ? https : http;
+
+            const options = {
+                hostname: url.hostname,
+                port: url.port || (isHttps ? 443 : 80),
+                path: url.pathname + url.search,
+                method: method.toUpperCase(),
+                headers: {
+                    'User-Agent': 'Democratize-Quality-MCP/1.0',
+                    ...headers
+                },
+                timeout
+            };
+
+            // Adding Content-Length for requests with body
+            if (data) {
+                const bodyString = typeof data === 'string' ? data : JSON.stringify(data);
+                options.headers['Content-Length'] = Buffer.byteLength(bodyString);
+
+                if (!options.headers['Content-Type']) {
+                    options.headers['Content-Type'] = typeof data === 'object'
+                        ? 'application/json'
+                        : 'text/plain';
+                }
+            }
+
+            const req = lib.request(options, (res) => {
+                let body = '';
+
+                res.on('data', (chunk) => {
+                    body += chunk;
+                });
+
+                res.on('end', () => {
+                    resolve({
+                        statusCode: res.statusCode,
+                        headers: res.headers,
+                        body: body
+                    });
+                });
+            });
+
+            req.on('error', (error) => {
+                reject(new Error(`Request failed: ${error.message}`));
+            });
+
+            req.on('timeout', () => {
+                req.destroy();
+                reject(new Error(`Request timeout after ${timeout}ms`));
+            });
+
+            // Write back request body if present
+            if (data) {
+                try {
+                    const bodyString = typeof data === 'string' ? data : JSON.stringify(data);
+                    req.write(bodyString);
+                } catch (writeError) {
+                    reject(new Error(`Failed to write request body: ${writeError.message}`));
+                    return;
+                }
+            }
+
+            req.end();
+        });
+    }
+}
+
+module.exports = ApiRequestTool;