api-mockingbird/dist/tools/addEndpoint.js

MCP server for creating HTTP mock APIs for frontend development

import { randomUUID } from 'crypto';
import { DEFAULT_HTTP_STATUS, DELAY, HTTP_STATUS } from '../constants.js';
import { HTTP_METHOD_SCHEMA, PATH_SCHEMA, PORT_SCHEMA } from '../schemas.js';
import { createErrorResponse, createSuccessResponse, handleToolError, } from '../utils/responses.js';
export const ADD_ENDPOINT_TOOL = {
    name: 'add_endpoint',
    description: 'Add a new mock endpoint to an existing server',
    inputSchema: {
        type: 'object',
        properties: {
            port: PORT_SCHEMA,
            method: {
                ...HTTP_METHOD_SCHEMA,
                description: 'HTTP method for the endpoint',
            },
            path: {
                ...PATH_SCHEMA,
                description: 'URL path for the endpoint (e.g., /api/users)',
            },
            response: {
                type: 'object',
                description: 'Response configuration for the endpoint',
                properties: {
                    status: {
                        type: 'number',
                        description: 'HTTP status code to return',
                        minimum: HTTP_STATUS.MIN_STATUS,
                        maximum: HTTP_STATUS.MAX_STATUS,
                        default: DEFAULT_HTTP_STATUS,
                    },
                    body: {
                        description: 'Response body (can be any JSON-serializable data)',
                    },
                    headers: {
                        type: 'object',
                        description: 'Custom response headers',
                        additionalProperties: {
                            type: 'string',
                        },
                    },
                },
                required: ['body'],
            },
            delay: {
                type: 'number',
                description: `Response delay in milliseconds (${DELAY.MIN}-${DELAY.MAX}ms)`,
                minimum: DELAY.MIN,
                maximum: DELAY.MAX,
            },
        },
        required: ['port', 'method', 'path', 'response'],
    },
};
export async function handleAddEndpoint(serverManager, args) {
    try {
        const { port, method, path, response, delay } = args;
        const { status = DEFAULT_HTTP_STATUS, body, headers } = response;
        const endpoint = {
            id: randomUUID(),
            method,
            path,
            response: {
                status,
                body,
                headers,
            },
            delay,
        };
        const success = await serverManager.addEndpoint(port, endpoint);
        if (success) {
            const delayInfo = delay ? `\nDelay: ${delay}ms` : '';
            return createSuccessResponse(`Endpoint added successfully:\n` +
                `${method} ${path} → ${status}${delayInfo}\n` +
                `Server: http://localhost:${port}${path}\n` +
                `\n` +
                `Configuration auto-saved to .api-mockingbird.local/${port}.json\n` +
                `You can manually edit this file to modify endpoints or use set_endpoint_error tool for error responses`);
        }
        else {
            return createErrorResponse(`Failed to add endpoint: No running server found on port ${port}`);
        }
    }
    catch (error) {
        return handleToolError(error, 'add endpoint');
    }
}