@mcpspec/shared 1.0.2 → 1.1.0

package/README.md

@@ -23,7 +23,8 @@ Internal shared package for [MCPSpec](https://www.npmjs.com/package/mcpspec). Pr
 - `MCPScore` — Quality scoring
 - `WSClientMessage`, `WSServerMessage` — WebSocket protocol
 - `ErrorTemplate` — Error formatting
-- `SavedServerConnection`, `SavedCollection`, `TestRunRecord` — API types
+- `Recording`, `RecordingStep`, `RecordingStepDiff`, `RecordingDiff` — Recording & replay types
+- `SavedServerConnection`, `SavedCollection`, `SavedRecording`, `TestRunRecord` — API types
 - `ApiResponse`, `ApiListResponse`, `ApiError` — API response wrappers
 
 ### Zod Schemas
@@ -40,6 +41,7 @@ Internal shared package for [MCPSpec](https://www.npmjs.com/package/mcpspec). Pr
 - `createCollectionSchema`, `updateCollectionSchema` — Collection API payloads
 - `triggerRunSchema`, `inspectConnectSchema`, `inspectCallSchema` — Action schemas
 - `auditStartSchema`, `benchmarkStartSchema`, `docsGenerateSchema`, `scoreCalculateSchema` — Feature schemas
+- `saveRecordingSchema`, `replayRecordingSchema`, `saveInspectRecordingSchema` — Recording schemas
 
 ### Constants
 

package/dist/index.d.ts

@@ -57,6 +57,15 @@ interface TestRunRecord {
     completedAt?: string;
     duration?: number;
 }
+interface SavedRecording {
+    id: string;
+    name: string;
+    description?: string;
+    serverName?: string;
+    data: string;
+    createdAt: string;
+    updatedAt: string;
+}
 interface ApiResponse<T> {
     data: T;
 }
@@ -149,6 +158,7 @@ interface TestDefinition {
     expect?: SimpleExpectation[];
     expectError?: boolean;
     extract?: ExtractionDefinition[];
+    rawResponse?: boolean;
 }
 type SimpleExpectation = {
     exists: string;
@@ -226,6 +236,8 @@ interface SecurityScanConfig {
     acknowledgeRisk?: boolean;
     timeout?: number;
     maxProbesPerTool?: number;
+    excludeTools?: string[];
+    dryRun?: boolean;
 }
 interface SecurityScanResult {
     id: string;
@@ -282,10 +294,49 @@ interface MCPScore {
         documentation: number;
         errorHandling: number;
         schemaQuality: number;
-        performance: number;
+        responsiveness: number;
         security: number;
     };
 }
+interface RecordingStep {
+    tool: string;
+    input: Record<string, unknown>;
+    output: unknown[];
+    isError?: boolean;
+    durationMs?: number;
+}
+interface Recording {
+    id: string;
+    name: string;
+    description?: string;
+    serverName?: string;
+    tools: Array<{
+        name: string;
+        description?: string;
+    }>;
+    steps: RecordingStep[];
+    createdAt: string;
+}
+interface RecordingStepDiff {
+    index: number;
+    tool: string;
+    type: 'matched' | 'changed' | 'added' | 'removed';
+    original?: RecordingStep;
+    replayed?: RecordingStep;
+    outputDiff?: string;
+}
+interface RecordingDiff {
+    recordingId: string;
+    recordingName: string;
+    replayedAt: string;
+    steps: RecordingStepDiff[];
+    summary: {
+        matched: number;
+        changed: number;
+        added: number;
+        removed: number;
+    };
+}
 type WSClientMessage = {
     type: 'subscribe';
     channel: string;
@@ -442,6 +493,7 @@ declare const auditStartSchema: z.ZodObject<{
     env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     mode: z.ZodDefault<z.ZodEnum<["passive", "active", "aggressive"]>>;
     rules: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    excludeTools: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     transport: "stdio" | "sse" | "streamable-http";
     mode: "passive" | "active" | "aggressive";
@@ -450,6 +502,7 @@ declare const auditStartSchema: z.ZodObject<{
     url?: string | undefined;
     env?: Record<string, string> | undefined;
     rules?: string[] | undefined;
+    excludeTools?: string[] | undefined;
 }, {
     transport: "stdio" | "sse" | "streamable-http";
     command?: string | undefined;
@@ -458,6 +511,35 @@ declare const auditStartSchema: z.ZodObject<{
     env?: Record<string, string> | undefined;
     mode?: "passive" | "active" | "aggressive" | undefined;
     rules?: string[] | undefined;
+    excludeTools?: string[] | undefined;
+}>;
+declare const auditDryRunSchema: z.ZodObject<{
+    transport: z.ZodEnum<["stdio", "sse", "streamable-http"]>;
+    command: z.ZodOptional<z.ZodString>;
+    args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    url: z.ZodOptional<z.ZodString>;
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    mode: z.ZodDefault<z.ZodEnum<["passive", "active", "aggressive"]>>;
+    rules: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    excludeTools: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    transport: "stdio" | "sse" | "streamable-http";
+    mode: "passive" | "active" | "aggressive";
+    command?: string | undefined;
+    args?: string[] | undefined;
+    url?: string | undefined;
+    env?: Record<string, string> | undefined;
+    rules?: string[] | undefined;
+    excludeTools?: string[] | undefined;
+}, {
+    transport: "stdio" | "sse" | "streamable-http";
+    command?: string | undefined;
+    args?: string[] | undefined;
+    url?: string | undefined;
+    env?: Record<string, string> | undefined;
+    mode?: "passive" | "active" | "aggressive" | undefined;
+    rules?: string[] | undefined;
+    excludeTools?: string[] | undefined;
 }>;
 declare const benchmarkStartSchema: z.ZodObject<{
     transport: z.ZodEnum<["stdio", "sse", "streamable-http"]>;
@@ -515,6 +597,54 @@ declare const docsGenerateSchema: z.ZodObject<{
     env?: Record<string, string> | undefined;
     format?: "html" | "markdown" | undefined;
 }>;
+declare const saveRecordingSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    serverName: z.ZodOptional<z.ZodString>;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    data: string;
+    description?: string | undefined;
+    serverName?: string | undefined;
+}, {
+    name: string;
+    data: string;
+    description?: string | undefined;
+    serverName?: string | undefined;
+}>;
+declare const replayRecordingSchema: z.ZodObject<{
+    transport: z.ZodEnum<["stdio", "sse", "streamable-http"]>;
+    command: z.ZodOptional<z.ZodString>;
+    args: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    url: z.ZodOptional<z.ZodString>;
+    env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    transport: "stdio" | "sse" | "streamable-http";
+    command?: string | undefined;
+    args?: string[] | undefined;
+    url?: string | undefined;
+    env?: Record<string, string> | undefined;
+}, {
+    transport: "stdio" | "sse" | "streamable-http";
+    command?: string | undefined;
+    args?: string[] | undefined;
+    url?: string | undefined;
+    env?: Record<string, string> | undefined;
+}>;
+declare const saveInspectRecordingSchema: z.ZodObject<{
+    sessionId: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    sessionId: string;
+    description?: string | undefined;
+}, {
+    name: string;
+    sessionId: string;
+    description?: string | undefined;
+}>;
 declare const scoreCalculateSchema: z.ZodObject<{
     transport: z.ZodEnum<["stdio", "sse", "streamable-http"]>;
     command: z.ZodOptional<z.ZodString>;
@@ -1059,4 +1189,4 @@ declare const rateLimitConfigSchema: z.ZodObject<{
     maxConcurrent?: number | undefined;
 }>;
 
-export { type ApiError, type ApiListResponse, type ApiResponse, type AssertionDefinition, type AssertionResult, type AssertionType, type BenchmarkConfig, type BenchmarkResult, type BenchmarkStats, type CollectionDefinition, type ConnectionConfig, type ConnectionState, DEFAULT_RATE_LIMIT, DEFAULT_TIMEOUTS, EXIT_CODES, type EnvironmentDefinition, type ErrorTemplate, type ExitCode, type ExtractionDefinition, type MCPScore, type ManagedProcess, type MessageDirection, type ProcessConfig, type ProfileEntry, type ProtocolLogEntry, type RateLimitConfig, type ReporterType, type SavedCollection, type SavedServerConnection, type SecurityFinding, type SecurityScanConfig, type SecurityScanMode, type SecurityScanResult, type SecurityScanSummary, type ServerConfig, type SeverityLevel, type SimpleExpectation, type TestDefinition, type TestResult, type TestRunRecord, type TestRunResult, type TestSummary, type TimeoutConfig, type TransportType, type WSClientMessage, type WSServerMessage, type WaterfallEntry, assertionDefinitionSchema, auditStartSchema, benchmarkStartSchema, collectionSchema, createCollectionSchema, createServerSchema, docsGenerateSchema, environmentSchema, extractionSchema, inspectCallSchema, inspectConnectSchema, rateLimitConfigSchema, scoreCalculateSchema, serverConfigSchema, simpleExpectationSchema, testDefinitionSchema, timeoutConfigSchema, triggerRunSchema, updateCollectionSchema, updateServerSchema };
+export { type ApiError, type ApiListResponse, type ApiResponse, type AssertionDefinition, type AssertionResult, type AssertionType, type BenchmarkConfig, type BenchmarkResult, type BenchmarkStats, type CollectionDefinition, type ConnectionConfig, type ConnectionState, DEFAULT_RATE_LIMIT, DEFAULT_TIMEOUTS, EXIT_CODES, type EnvironmentDefinition, type ErrorTemplate, type ExitCode, type ExtractionDefinition, type MCPScore, type ManagedProcess, type MessageDirection, type ProcessConfig, type ProfileEntry, type ProtocolLogEntry, type RateLimitConfig, type Recording, type RecordingDiff, type RecordingStep, type RecordingStepDiff, type ReporterType, type SavedCollection, type SavedRecording, type SavedServerConnection, type SecurityFinding, type SecurityScanConfig, type SecurityScanMode, type SecurityScanResult, type SecurityScanSummary, type ServerConfig, type SeverityLevel, type SimpleExpectation, type TestDefinition, type TestResult, type TestRunRecord, type TestRunResult, type TestSummary, type TimeoutConfig, type TransportType, type WSClientMessage, type WSServerMessage, type WaterfallEntry, assertionDefinitionSchema, auditDryRunSchema, auditStartSchema, benchmarkStartSchema, collectionSchema, createCollectionSchema, createServerSchema, docsGenerateSchema, environmentSchema, extractionSchema, inspectCallSchema, inspectConnectSchema, rateLimitConfigSchema, replayRecordingSchema, saveInspectRecordingSchema, saveRecordingSchema, scoreCalculateSchema, serverConfigSchema, simpleExpectationSchema, testDefinitionSchema, timeoutConfigSchema, triggerRunSchema, updateCollectionSchema, updateServerSchema };

package/dist/index.js

@@ -75,7 +75,18 @@ var auditStartSchema = z.object({
   url: z.string().optional(),
   env: z.record(z.string()).optional(),
   mode: z.enum(["passive", "active", "aggressive"]).default("passive"),
-  rules: z.array(z.string()).optional()
+  rules: z.array(z.string()).optional(),
+  excludeTools: z.array(z.string()).optional()
+});
+var auditDryRunSchema = z.object({
+  transport: z.enum(["stdio", "sse", "streamable-http"]),
+  command: z.string().optional(),
+  args: z.array(z.string()).optional(),
+  url: z.string().optional(),
+  env: z.record(z.string()).optional(),
+  mode: z.enum(["passive", "active", "aggressive"]).default("passive"),
+  rules: z.array(z.string()).optional(),
+  excludeTools: z.array(z.string()).optional()
 });
 var benchmarkStartSchema = z.object({
   transport: z.enum(["stdio", "sse", "streamable-http"]),
@@ -97,6 +108,24 @@ var docsGenerateSchema = z.object({
   env: z.record(z.string()).optional(),
   format: z.enum(["markdown", "html"]).default("markdown")
 });
+var saveRecordingSchema = z.object({
+  name: z.string().min(1),
+  description: z.string().optional(),
+  serverName: z.string().optional(),
+  data: z.string().min(1)
+});
+var replayRecordingSchema = z.object({
+  transport: z.enum(["stdio", "sse", "streamable-http"]),
+  command: z.string().optional(),
+  args: z.array(z.string()).optional(),
+  url: z.string().optional(),
+  env: z.record(z.string()).optional()
+});
+var saveInspectRecordingSchema = z.object({
+  sessionId: z.string().min(1),
+  name: z.string().min(1),
+  description: z.string().optional()
+});
 var scoreCalculateSchema = z.object({
   transport: z.enum(["stdio", "sse", "streamable-http"]),
   command: z.string().optional(),
@@ -201,6 +230,7 @@ export {
   DEFAULT_TIMEOUTS,
   EXIT_CODES,
   assertionDefinitionSchema,
+  auditDryRunSchema,
   auditStartSchema,
   benchmarkStartSchema,
   collectionSchema,
@@ -212,6 +242,9 @@ export {
   inspectCallSchema,
   inspectConnectSchema,
   rateLimitConfigSchema,
+  replayRecordingSchema,
+  saveInspectRecordingSchema,
+  saveRecordingSchema,
   scoreCalculateSchema,
   serverConfigSchema,
   simpleExpectationSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcpspec/shared",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",