@mcpspec/shared 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @mcpspec/shared
|
|
2
|
+
|
|
3
|
+
Internal shared package for [MCPSpec](https://www.npmjs.com/package/mcpspec). Provides TypeScript types, Zod validation schemas, and constants used across all MCPSpec packages.
|
|
4
|
+
|
|
5
|
+
> **You probably want the [`mcpspec`](https://www.npmjs.com/package/mcpspec) CLI package instead.** This package is a dependency of the other MCPSpec packages and is not intended for direct use.
|
|
6
|
+
|
|
7
|
+
## Exports
|
|
8
|
+
|
|
9
|
+
### TypeScript Types
|
|
10
|
+
|
|
11
|
+
- `ConnectionState`, `ConnectionConfig` — Connection state machine
|
|
12
|
+
- `ProcessConfig`, `ManagedProcess` — Process management
|
|
13
|
+
- `TimeoutConfig`, `DEFAULT_TIMEOUTS` — Timeout configuration
|
|
14
|
+
- `RateLimitConfig`, `DEFAULT_RATE_LIMIT` — Rate limiting
|
|
15
|
+
- `TransportType`, `ServerConfig` — Server transport configuration
|
|
16
|
+
- `CollectionDefinition`, `TestDefinition`, `EnvironmentDefinition` — Collection format
|
|
17
|
+
- `AssertionDefinition`, `AssertionType`, `SimpleExpectation`, `ExtractionDefinition` — Assertions
|
|
18
|
+
- `TestRunResult`, `TestResult`, `AssertionResult`, `TestSummary` — Test results
|
|
19
|
+
- `ReporterType` — Reporter selection
|
|
20
|
+
- `SecurityScanMode`, `SeverityLevel`, `SecurityFinding`, `SecurityScanConfig`, `SecurityScanResult` — Security scanning
|
|
21
|
+
- `BenchmarkConfig`, `BenchmarkResult`, `BenchmarkStats` — Performance benchmarking
|
|
22
|
+
- `ProfileEntry`, `WaterfallEntry` — Profiling
|
|
23
|
+
- `MCPScore` — Quality scoring
|
|
24
|
+
- `WSClientMessage`, `WSServerMessage` — WebSocket protocol
|
|
25
|
+
- `ErrorTemplate` — Error formatting
|
|
26
|
+
- `SavedServerConnection`, `SavedCollection`, `TestRunRecord` — API types
|
|
27
|
+
- `ApiResponse`, `ApiListResponse`, `ApiError` — API response wrappers
|
|
28
|
+
|
|
29
|
+
### Zod Schemas
|
|
30
|
+
|
|
31
|
+
- `collectionSchema` — Full collection validation
|
|
32
|
+
- `serverConfigSchema` — Server configuration
|
|
33
|
+
- `testDefinitionSchema` — Test case definition
|
|
34
|
+
- `assertionDefinitionSchema` — Assertion definition
|
|
35
|
+
- `simpleExpectationSchema` — Simple expect syntax
|
|
36
|
+
- `environmentSchema` — Environment variables
|
|
37
|
+
- `timeoutConfigSchema` — Timeout settings
|
|
38
|
+
- `rateLimitConfigSchema` — Rate limit settings
|
|
39
|
+
- `createServerSchema`, `updateServerSchema` — Server API payloads
|
|
40
|
+
- `createCollectionSchema`, `updateCollectionSchema` — Collection API payloads
|
|
41
|
+
- `triggerRunSchema`, `inspectConnectSchema`, `inspectCallSchema` — Action schemas
|
|
42
|
+
- `auditStartSchema`, `benchmarkStartSchema`, `docsGenerateSchema`, `scoreCalculateSchema` — Feature schemas
|
|
43
|
+
|
|
44
|
+
### Constants
|
|
45
|
+
|
|
46
|
+
- `EXIT_CODES` — CLI exit codes (SUCCESS, TEST_FAILURE, ERROR, CONFIG_ERROR, etc.)
|
|
47
|
+
- `ExitCode` — Exit code type
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT
|