@mcp-shark/mcp-shark 1.5.3 → 1.5.5

package/ui/server/swagger/paths/logs.js

@@ -0,0 +1,87 @@
+/**
+ * Logs endpoints - MCP Shark server logs
+ */
+
+export const logsPaths = {
+  '/api/composite/logs': {
+    get: {
+      tags: ['Logs'],
+      summary: 'Get MCP Shark server logs',
+      description: 'Retrieve logs from the MCP Shark server',
+      parameters: [
+        {
+          name: 'limit',
+          in: 'query',
+          description: 'Maximum number of log entries',
+          schema: { type: 'integer', default: 1000 },
+        },
+        {
+          name: 'offset',
+          in: 'query',
+          description: 'Number of log entries to skip',
+          schema: { type: 'integer', default: 0 },
+        },
+      ],
+      responses: {
+        200: {
+          description: 'List of log entries',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: { $ref: '#/components/schemas/LogEntry' },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/composite/logs/clear': {
+    post: {
+      tags: ['Logs'],
+      summary: 'Clear all logs',
+      description: 'Delete all log entries',
+      responses: {
+        200: {
+          description: 'Logs cleared successfully',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  success: { type: 'boolean' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/composite/logs/export': {
+    get: {
+      tags: ['Logs'],
+      summary: 'Export logs',
+      description: 'Export logs as a text file',
+      responses: {
+        200: {
+          description: 'Logs file',
+          content: {
+            'text/plain': { schema: { type: 'string' } },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/playground.js

@@ -0,0 +1,49 @@
+/**
+ * Playground endpoints - MCP playground for testing tools and resources
+ */
+
+export const playgroundPaths = {
+  '/api/playground/proxy': {
+    post: {
+      tags: ['Playground'],
+      summary: 'Proxy MCP request',
+      description: 'Proxy a request to an MCP server through the playground',
+      requestBody: {
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['method', 'serverName'],
+              properties: {
+                method: {
+                  type: 'string',
+                  description: 'MCP method to call (e.g., tools/list, prompts/list)',
+                },
+                serverName: { type: 'string', description: 'Name of the MCP server' },
+                params: { type: 'object', description: 'Method parameters' },
+                sessionId: { type: 'string', description: 'Session ID for the request' },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: 'MCP response',
+          content: {
+            'application/json': {
+              schema: { type: 'object' },
+            },
+          },
+        },
+        400: {
+          description: 'Bad request',
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/requests.js

@@ -0,0 +1,178 @@
+/**
+ * Requests endpoints - Traffic capture and request/response analysis
+ */
+
+export const requestsPaths = {
+  '/api/requests': {
+    get: {
+      tags: ['Requests'],
+      summary: 'Get captured requests/packets',
+      description:
+        'Retrieve captured HTTP requests and responses with optional filtering. Supports filtering by session, server, method, status code, and more.',
+      parameters: [
+        {
+          name: 'sessionId',
+          in: 'query',
+          description: 'Filter by session ID',
+          schema: { type: 'string' },
+        },
+        {
+          name: 'serverName',
+          in: 'query',
+          description: 'Filter by server name',
+          schema: { type: 'string' },
+        },
+        {
+          name: 'method',
+          in: 'query',
+          description: 'Filter by HTTP method',
+          schema: { type: 'string' },
+        },
+        {
+          name: 'statusCode',
+          in: 'query',
+          description: 'Filter by HTTP status code',
+          schema: { type: 'integer' },
+        },
+        {
+          name: 'jsonrpcMethod',
+          in: 'query',
+          description: 'Filter by JSON-RPC method',
+          schema: { type: 'string' },
+        },
+        {
+          name: 'search',
+          in: 'query',
+          description: 'Search in request/response content',
+          schema: { type: 'string' },
+        },
+        {
+          name: 'limit',
+          in: 'query',
+          description: 'Maximum number of results',
+          schema: { type: 'integer', default: 5000 },
+        },
+        {
+          name: 'offset',
+          in: 'query',
+          description: 'Number of results to skip',
+          schema: { type: 'integer', default: 0 },
+        },
+      ],
+      responses: {
+        200: {
+          description: 'List of captured requests',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: { $ref: '#/components/schemas/Request' },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/requests/{frameNumber}': {
+    get: {
+      tags: ['Requests'],
+      summary: 'Get request by frame number',
+      description: 'Retrieve a specific captured request/response by its frame number',
+      parameters: [
+        {
+          name: 'frameNumber',
+          in: 'path',
+          required: true,
+          description: 'Frame number of the request',
+          schema: { type: 'integer' },
+        },
+      ],
+      responses: {
+        200: {
+          description: 'Request details',
+          content: {
+            'application/json': {
+              schema: { $ref: '#/components/schemas/Request' },
+            },
+          },
+        },
+        404: {
+          description: 'Request not found',
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/requests/export': {
+    get: {
+      tags: ['Requests'],
+      summary: 'Export captured requests',
+      description: 'Export captured requests in CSV, TXT, or JSON format',
+      parameters: [
+        {
+          name: 'format',
+          in: 'query',
+          description: 'Export format (csv, txt, json)',
+          schema: { type: 'string', enum: ['csv', 'txt', 'json'], default: 'json' },
+        },
+        {
+          name: 'sessionId',
+          in: 'query',
+          description: 'Filter by session ID',
+          schema: { type: 'string' },
+        },
+        {
+          name: 'serverName',
+          in: 'query',
+          description: 'Filter by server name',
+          schema: { type: 'string' },
+        },
+      ],
+      responses: {
+        200: {
+          description: 'Exported data file',
+          content: {
+            'text/csv': { schema: { type: 'string' } },
+            'text/plain': { schema: { type: 'string' } },
+            'application/json': { schema: { type: 'object' } },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/requests/clear': {
+    post: {
+      tags: ['Requests'],
+      summary: 'Clear all captured requests',
+      description: 'Delete all captured traffic from the database',
+      responses: {
+        200: {
+          description: 'Traffic cleared successfully',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  success: { type: 'boolean' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/serverManagement.js

@@ -0,0 +1,169 @@
+/**
+ * Server Management endpoints - MCP Shark server lifecycle management
+ */
+
+export const serverManagementPaths = {
+  '/api/composite/setup': {
+    post: {
+      tags: ['Server Management'],
+      summary: 'Setup and start MCP Shark server',
+      description:
+        'Configure and start the MCP Shark server with a given configuration file. This will process the config, patch it if needed, and start the server.',
+      requestBody: {
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              properties: {
+                filePath: { type: 'string', description: 'Path to config file' },
+                fileContent: { type: 'string', description: 'Config file content' },
+                selectedServices: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  description: 'List of service names to include',
+                },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: 'Server started successfully',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  success: { type: 'boolean' },
+                  message: { type: 'string' },
+                  convertedConfig: { type: 'object' },
+                  updatedConfig: { type: 'object' },
+                  filePath: { type: 'string' },
+                  backupPath: { type: 'string', nullable: true },
+                  warning: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+        400: {
+          description: 'Bad request',
+        },
+        404: {
+          description: 'File not found',
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/composite/stop': {
+    post: {
+      tags: ['Server Management'],
+      summary: 'Stop MCP Shark server',
+      description: 'Stop the running MCP Shark server and restore original configuration',
+      responses: {
+        200: {
+          description: 'Server stopped successfully',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  success: { type: 'boolean' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/composite/status': {
+    get: {
+      tags: ['Server Management'],
+      summary: 'Get server status',
+      description: 'Get the current status of the MCP Shark server',
+      responses: {
+        200: {
+          description: 'Server status',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  running: { type: 'boolean' },
+                  pid: { type: 'integer', nullable: true },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/composite/shutdown': {
+    post: {
+      tags: ['Server Management'],
+      summary: 'Shutdown application',
+      description: 'Gracefully shutdown the entire application',
+      responses: {
+        200: {
+          description: 'Shutdown initiated',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  success: { type: 'boolean' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/composite/servers': {
+    get: {
+      tags: ['Server Management'],
+      summary: 'Get configured servers',
+      description: 'Get a list of all configured MCP servers',
+      responses: {
+        200: {
+          description: 'List of servers',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  servers: {
+                    type: 'array',
+                    items: { type: 'string' },
+                  },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/sessions.js

@@ -0,0 +1,61 @@
+/**
+ * Sessions endpoints - Session management and tracking
+ */
+
+export const sessionsPaths = {
+  '/api/sessions': {
+    get: {
+      tags: ['Sessions'],
+      summary: 'Get all sessions',
+      description: 'Retrieve a list of all captured sessions',
+      responses: {
+        200: {
+          description: 'List of sessions',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: { $ref: '#/components/schemas/Session' },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/sessions/{sessionId}/requests': {
+    get: {
+      tags: ['Sessions'],
+      summary: 'Get requests for a session',
+      description: 'Retrieve all requests belonging to a specific session',
+      parameters: [
+        {
+          name: 'sessionId',
+          in: 'path',
+          required: true,
+          description: 'Session ID',
+          schema: { type: 'string' },
+        },
+      ],
+      responses: {
+        200: {
+          description: 'List of requests for the session',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'array',
+                items: { $ref: '#/components/schemas/Request' },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/settings.js

@@ -0,0 +1,31 @@
+/**
+ * Settings endpoints - Application settings
+ */
+
+export const settingsPaths = {
+  '/api/settings': {
+    get: {
+      tags: ['Settings'],
+      summary: 'Get settings',
+      description: 'Get application settings',
+      responses: {
+        200: {
+          description: 'Application settings',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  token: { type: 'string', nullable: true },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/smartScan/discovery.js

@@ -0,0 +1,97 @@
+/**
+ * Smart Scan - Discovery and cache endpoints
+ */
+
+export const discoveryPaths = {
+  '/api/smartscan/discover': {
+    get: {
+      tags: ['Smart Scan'],
+      summary: 'Discover MCP servers',
+      description: 'Discover MCP servers from configuration files',
+      responses: {
+        200: {
+          description: 'List of discovered servers',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  servers: {
+                    type: 'array',
+                    items: { type: 'string' },
+                  },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/smartscan/cached-results': {
+    post: {
+      tags: ['Smart Scan'],
+      summary: 'Get cached results',
+      description: 'Get cached scan results for a server',
+      requestBody: {
+        required: true,
+        content: {
+          'application/json': {
+            schema: {
+              type: 'object',
+              required: ['serverName'],
+              properties: {
+                serverName: { type: 'string', description: 'Name of the server' },
+              },
+            },
+          },
+        },
+      },
+      responses: {
+        200: {
+          description: 'Cached results',
+          content: {
+            'application/json': {
+              schema: { type: 'object' },
+            },
+          },
+        },
+        404: {
+          description: 'No cached results found',
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+  '/api/smartscan/cache/clear': {
+    post: {
+      tags: ['Smart Scan'],
+      summary: 'Clear scan cache',
+      description: 'Clear all cached scan results',
+      responses: {
+        200: {
+          description: 'Cache cleared',
+          content: {
+            'application/json': {
+              schema: {
+                type: 'object',
+                properties: {
+                  success: { type: 'boolean' },
+                  message: { type: 'string' },
+                },
+              },
+            },
+          },
+        },
+        500: {
+          description: 'Internal server error',
+        },
+      },
+    },
+  },
+};

package/ui/server/swagger/paths/smartScan/index.js

@@ -0,0 +1,13 @@
+/**
+ * Smart Scan endpoints - Aggregates all Smart Scan path definitions
+ */
+
+import { discoveryPaths } from './discovery.js';
+import { scansPaths } from './scans.js';
+import { tokenPaths } from './token.js';
+
+export const smartScanPaths = {
+  ...scansPaths,
+  ...tokenPaths,
+  ...discoveryPaths,
+};