@samanhappy/mcphub 0.9.3 → 0.9.4

package/dist/services/openApiGeneratorService.js

@@ -0,0 +1,256 @@
+import { getServersInfo } from './mcpService.js';
+import config from '../config/index.js';
+import { loadSettings } from '../config/index.js';
+/**
+ * Convert MCP tool input schema to OpenAPI parameter or request body schema
+ */
+function convertToolSchemaToOpenAPI(tool) {
+    const schema = tool.inputSchema;
+    if (!schema || typeof schema !== 'object') {
+        return {};
+    }
+    // If schema has properties, convert them to parameters or request body
+    if (schema.properties && typeof schema.properties === 'object') {
+        const properties = schema.properties;
+        const required = Array.isArray(schema.required) ? schema.required : [];
+        // For simple tools with only primitive parameters, use query parameters
+        const hasComplexTypes = Object.values(properties).some((prop) => prop.type === 'object' ||
+            prop.type === 'array' ||
+            (prop.type === 'string' && prop.enum && prop.enum.length > 10));
+        if (!hasComplexTypes && Object.keys(properties).length <= 10) {
+            // Use query parameters for simple tools
+            const parameters = Object.entries(properties).map(([name, prop]) => ({
+                name,
+                in: 'query',
+                required: required.includes(name),
+                description: prop.description || `Parameter ${name}`,
+                schema: {
+                    type: prop.type || 'string',
+                    ...(prop.enum && { enum: prop.enum }),
+                    ...(prop.default !== undefined && { default: prop.default }),
+                    ...(prop.format && { format: prop.format }),
+                },
+            }));
+            return { parameters };
+        }
+        else {
+            // Use request body for complex tools
+            const requestBody = {
+                required: required.length > 0,
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties,
+                            ...(required.length > 0 && { required }),
+                        },
+                    },
+                },
+            };
+            return { requestBody };
+        }
+    }
+    return {};
+}
+/**
+ * Generate OpenAPI operation from MCP tool
+ */
+function generateOperationFromTool(tool, serverName) {
+    const { parameters, requestBody } = convertToolSchemaToOpenAPI(tool);
+    const operation = {
+        summary: tool.description || `Execute ${tool.name} tool`,
+        description: tool.description || `Execute the ${tool.name} tool from ${serverName} server`,
+        operationId: `${serverName}_${tool.name}`,
+        tags: [serverName],
+        ...(parameters && parameters.length > 0 && { parameters }),
+        ...(requestBody && { requestBody }),
+        responses: {
+            '200': {
+                description: 'Successful tool execution',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                content: {
+                                    type: 'array',
+                                    items: {
+                                        type: 'object',
+                                        properties: {
+                                            type: { type: 'string' },
+                                            text: { type: 'string' },
+                                        },
+                                    },
+                                },
+                                isError: { type: 'boolean' },
+                            },
+                        },
+                    },
+                },
+            },
+            '400': {
+                description: 'Bad request - invalid parameters',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                error: { type: 'string' },
+                                message: { type: 'string' },
+                            },
+                        },
+                    },
+                },
+            },
+            '500': {
+                description: 'Internal server error',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                error: { type: 'string' },
+                                message: { type: 'string' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    };
+    return operation;
+}
+/**
+ * Generate OpenAPI specification from MCP tools
+ */
+export function generateOpenAPISpec(options = {}) {
+    const serverInfos = getServersInfo();
+    // Filter servers based on options
+    const filteredServers = serverInfos.filter((server) => server.status === 'connected' &&
+        (!options.serverFilter || options.serverFilter.includes(server.name)));
+    // Collect all tools from filtered servers
+    const allTools = [];
+    for (const serverInfo of filteredServers) {
+        const tools = options.includeDisabledTools
+            ? serverInfo.tools
+            : serverInfo.tools.filter((tool) => tool.enabled !== false);
+        for (const tool of tools) {
+            allTools.push({ tool, serverName: serverInfo.name });
+        }
+    }
+    // Generate paths from tools
+    const paths = {};
+    for (const { tool, serverName } of allTools) {
+        const operation = generateOperationFromTool(tool, serverName);
+        const { requestBody } = convertToolSchemaToOpenAPI(tool);
+        // Create path for the tool
+        const pathName = `/tools/${serverName}/${tool.name}`;
+        const method = requestBody ? 'post' : 'get';
+        if (!paths[pathName]) {
+            paths[pathName] = {};
+        }
+        paths[pathName][method] = operation;
+    }
+    const settings = loadSettings();
+    // Get server URL
+    const baseUrl = options.serverUrl ||
+        settings.systemConfig?.install?.baseUrl ||
+        `http://localhost:${config.port}`;
+    const serverUrl = `${baseUrl}${config.basePath}/api`;
+    // Generate OpenAPI document
+    const openApiDoc = {
+        openapi: '3.0.3',
+        info: {
+            title: options.title || 'MCPHub API',
+            description: options.description ||
+                'OpenAPI specification for MCP tools managed by MCPHub. This enables integration with OpenWebUI and other OpenAPI-compatible systems.',
+            version: options.version || '1.0.0',
+            contact: {
+                name: 'MCPHub',
+                url: 'https://github.com/samanhappy/mcphub',
+            },
+            license: {
+                name: 'ISC',
+                url: 'https://github.com/samanhappy/mcphub/blob/main/LICENSE',
+            },
+        },
+        servers: [
+            {
+                url: serverUrl,
+                description: 'MCPHub API Server',
+            },
+        ],
+        paths,
+        components: {
+            schemas: {
+                ToolResponse: {
+                    type: 'object',
+                    properties: {
+                        content: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    type: { type: 'string' },
+                                    text: { type: 'string' },
+                                },
+                            },
+                        },
+                        isError: { type: 'boolean' },
+                    },
+                },
+                ErrorResponse: {
+                    type: 'object',
+                    properties: {
+                        error: { type: 'string' },
+                        message: { type: 'string' },
+                    },
+                },
+            },
+            securitySchemes: {
+                bearerAuth: {
+                    type: 'http',
+                    scheme: 'bearer',
+                    bearerFormat: 'JWT',
+                },
+            },
+        },
+        security: [
+            {
+                bearerAuth: [],
+            },
+        ],
+        tags: filteredServers.map((server) => ({
+            name: server.name,
+            description: `Tools from ${server.name} server`,
+        })),
+    };
+    return openApiDoc;
+}
+/**
+ * Get available server names for filtering
+ */
+export function getAvailableServers() {
+    const serverInfos = getServersInfo();
+    return serverInfos.filter((server) => server.status === 'connected').map((server) => server.name);
+}
+/**
+ * Get statistics about available tools
+ */
+export function getToolStats() {
+    const serverInfos = getServersInfo();
+    const serverBreakdown = serverInfos.map((server) => ({
+        name: server.name,
+        toolCount: server.tools.length,
+        status: server.status,
+    }));
+    const totalTools = serverInfos
+        .filter((server) => server.status === 'connected')
+        .reduce((sum, server) => sum + server.tools.length, 0);
+    return {
+        totalServers: serverInfos.filter((server) => server.status === 'connected').length,
+        totalTools,
+        serverBreakdown,
+    };
+}
+//# sourceMappingURL=openApiGeneratorService.js.map

package/dist/services/openApiGeneratorService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openApiGeneratorService.js","sourceRoot":"","sources":["../../src/services/openApiGeneratorService.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,MAAM,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAiBlD;;GAEG;AACH,SAAS,0BAA0B,CAAC,IAAU;IAI5C,MAAM,MAAM,GAAG,IAAI,CAAC,WAAkB,CAAC;IAEvC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,uEAAuE;IACvE,IAAI,MAAM,CAAC,UAAU,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QAEvE,wEAAwE;QACxE,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CACpD,CAAC,IAAS,EAAE,EAAE,CACZ,IAAI,CAAC,IAAI,KAAK,QAAQ;YACtB,IAAI,CAAC,IAAI,KAAK,OAAO;YACrB,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,CACjE,CAAC;QAEF,IAAI,CAAC,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YAC7D,wCAAwC;YACxC,MAAM,UAAU,GAAgC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAC5E,CAAC,CAAC,IAAI,EAAE,IAAI,CAAgB,EAAE,EAAE,CAAC,CAAC;gBAChC,IAAI;gBACJ,EAAE,EAAE,OAAO;gBACX,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACjC,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,aAAa,IAAI,EAAE;gBACpD,MAAM,EAAE;oBACN,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,QAAQ;oBAC3B,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;oBACrC,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;oBAC5D,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;iBAC5C;aACF,CAAC,CACH,CAAC;YAEF,OAAO,EAAE,UAAU,EAAE,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,qCAAqC;YACrC,MAAM,WAAW,GAAgC;gBAC/C,QAAQ,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC;gBAC7B,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU;4BACV,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC;yBACzC;qBACF;iBACF;aACF,CAAC;YAEF,OAAO,EAAE,WAAW,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,SAAS,yBAAyB,CAAC,IAAU,EAAE,UAAkB;IAC/D,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACrE,MAAM,SAAS,GAA8B;QAC3C,OAAO,EAAE,IAAI,CAAC,WAAW,IAAI,WAAW,IAAI,CAAC,IAAI,OAAO;QACxD,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,eAAe,IAAI,CAAC,IAAI,cAAc,UAAU,SAAS;QAC1F,WAAW,EAAE,GAAG,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE;QACzC,IAAI,EAAE,CAAC,UAAU,CAAC;QAClB,GAAG,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC;QAC1D,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;QACnC,SAAS,EAAE;YACT,KAAK,EAAE;gBACL,WAAW,EAAE,2BAA2B;gBACxC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,OAAO,EAAE;oCACP,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;4CACxB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;yCACzB;qCACF;iCACF;gCACD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;6BAC7B;yBACF;qBACF;iBACF;aACF;YACD,KAAK,EAAE;gBACL,WAAW,EAAE,kCAAkC;gBAC/C,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCACzB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;6BAC5B;yBACF;qBACF;iBACF;aACF;YACD,KAAK,EAAE;gBACL,WAAW,EAAE,uBAAuB;gBACpC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCACzB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;6BAC5B;yBACF;qBACF;iBACF;aACF;SACF;KACF,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAoC,EAAE;IACxE,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,kCAAkC;IAClC,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CACxC,CAAC,MAAM,EAAE,EAAE,CACT,MAAM,CAAC,MAAM,KAAK,WAAW;QAC7B,CAAC,CAAC,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CACxE,CAAC;IAEF,0CAA0C;IAC1C,MAAM,QAAQ,GAA8C,EAAE,CAAC;IAE/D,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,OAAO,CAAC,oBAAoB;YACxC,CAAC,CAAC,UAAU,CAAC,KAAK;YAClB,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC;QAE9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,MAAM,KAAK,GAA0B,EAAE,CAAC;IAExC,KAAK,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,yBAAyB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9D,MAAM,EAAE,WAAW,EAAE,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAC;QAEzD,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,UAAU,UAAU,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACrD,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;QAE5C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrB,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACtC,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;IAChC,iBAAiB;IACjB,MAAM,OAAO,GACX,OAAO,CAAC,SAAS;QACjB,QAAQ,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO;QACvC,oBAAoB,MAAM,CAAC,IAAI,EAAE,CAAC;IACpC,MAAM,SAAS,GAAG,GAAG,OAAO,GAAG,MAAM,CAAC,QAAQ,MAAM,CAAC;IAErD,4BAA4B;IAC5B,MAAM,UAAU,GAAuB;QACrC,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,YAAY;YACpC,WAAW,EACT,OAAO,CAAC,WAAW;gBACnB,sIAAsI;YACxI,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,OAAO;YACnC,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,GAAG,EAAE,sCAAsC;aAC5C;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,KAAK;gBACX,GAAG,EAAE,wDAAwD;aAC9D;SACF;QACD,OAAO,EAAE;YACP;gBACE,GAAG,EAAE,SAAS;gBACd,WAAW,EAAE,mBAAmB;aACjC;SACF;QACD,KAAK;QACL,UAAU,EAAE;YACV,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,OAAO,EAAE;4BACP,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE;gCACL,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oCACxB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iCACzB;6BACF;yBACF;wBACD,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;qBAC7B;iBACF;gBACD,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACzB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC5B;iBACF;aACF;YACD,eAAe,EAAE;gBACf,UAAU,EAAE;oBACV,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE,QAAQ;oBAChB,YAAY,EAAE,KAAK;iBACpB;aACF;SACF;QACD,QAAQ,EAAE;YACR;gBACE,UAAU,EAAE,EAAE;aACf;SACF;QACD,IAAI,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACrC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,WAAW,EAAE,cAAc,MAAM,CAAC,IAAI,SAAS;SAChD,CAAC,CAAC;KACJ,CAAC;IAEF,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB;IACjC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACpG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY;IAK1B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACnD,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM;QAC9B,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,CAAC,CAAC,CAAC;IAEJ,MAAM,UAAU,GAAG,WAAW;SAC3B,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC;SACjD,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEzD,OAAO;QACL,YAAY,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,MAAM;QAClF,UAAU;QACV,eAAe;KAChB,CAAC;AACJ,CAAC"}