@skyramp/mcp 0.0.5 → 0.0.6
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 +2 -2
- package/build/prompts/stopTraceCollectionPrompts.js +2 -2
- package/build/tools/generateContractRestTool.js +0 -1
- package/build/tools/generateFuzzRestTool.js +0 -1
- package/build/tools/generateIntegrationRestTool.js +0 -1
- package/build/tools/generateLoadRestTool.js +0 -1
- package/build/tools/generateSmokeRestTool.js +0 -2
- package/build/tools/startTraceCollectionTool.js +1 -1
- package/build/tools/stopTraceCollectionTool.js +1 -1
- package/build/types/TestTypes.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -135,8 +135,8 @@ This MCP server provides the following tools:
|
|
|
135
135
|
| skyramp_integration_test_generation | Generate an integration test |
|
|
136
136
|
| skyramp_e2e_test_generation | Generate an E2E test |
|
|
137
137
|
| skyramp_ui_test_generation | Generate an UI test |
|
|
138
|
-
|
|
|
139
|
-
|
|
|
138
|
+
| skyramp_start_trace_collection | Start trace collection |
|
|
139
|
+
| skyramp_sop_trace_collection | Stop trace collection |
|
|
140
140
|
| skyramp_execute_test | Execute a Skyramp test |
|
|
141
141
|
|
|
142
142
|
## Available prompts
|
|
@@ -90,7 +90,7 @@ ${playwrightOutput
|
|
|
90
90
|
- DO NOT use the original relative paths provided by the user
|
|
91
91
|
|
|
92
92
|
**Tool Call Requirements:**
|
|
93
|
-
When calling
|
|
93
|
+
When calling skyramp_sop_trace_collection, you MUST use:
|
|
94
94
|
- traceOutputFile: "${absoluteTraceOutputFile}" (this exact absolute path)
|
|
95
95
|
- playwright: ${playwright === "true" ? "true" : "false"}
|
|
96
96
|
- playwrightOutput: "${absolutePlaywrightOutput}" ${!playwrightOutput
|
|
@@ -99,7 +99,7 @@ When calling skyramp_stop_trace_generation, you MUST use:
|
|
|
99
99
|
|
|
100
100
|
**Example Tool Call:**
|
|
101
101
|
\`\`\`
|
|
102
|
-
|
|
102
|
+
skyramp_sop_trace_collection({
|
|
103
103
|
traceOutputFile: "${absoluteTraceOutputFile}",
|
|
104
104
|
playwright: ${playwright === "true" ? "true" : "false"},
|
|
105
105
|
playwrightOutput: "${absolutePlaywrightOutput}"
|
|
@@ -29,7 +29,6 @@ export function registerContractTestTool(server) {
|
|
|
29
29
|
|
|
30
30
|
Contract tests ensure your API implementation matches its OpenAPI/Swagger specification exactly. They validate request/response schemas, status codes, headers, and data types to prevent contract violations and API breaking changes.
|
|
31
31
|
|
|
32
|
-
If the user says create tests for all methods in an endpoint then use "" as method value and skyramp will create all test in one file
|
|
33
32
|
For detailed documentation visit: https://www.skyramp.dev/docs/contract-test`,
|
|
34
33
|
inputSchema: contractTestSchema,
|
|
35
34
|
}, async (params) => {
|
|
@@ -24,7 +24,6 @@ export function registerFuzzTestTool(server) {
|
|
|
24
24
|
|
|
25
25
|
Fuzz tests improve application security and reliability by sending invalid, malformed, or unexpected data to your API endpoints. They help discover edge cases, input validation issues, error handling problems, and potential security vulnerabilities.
|
|
26
26
|
|
|
27
|
-
If the user says create tests for all methods in an endpoint then use "" as method value and skyramp will create all test in one file
|
|
28
27
|
For detailed documentation visit: https://www.skyramp.dev/docs/fuzz-test`,
|
|
29
28
|
inputSchema: fuzzTestSchema,
|
|
30
29
|
annotations: {
|
|
@@ -24,7 +24,6 @@ export function registerIntegrationTestTool(server) {
|
|
|
24
24
|
|
|
25
25
|
Integration tests validate that multiple services, components, or modules work together correctly. They test complex user workflows, service interactions, data flow between systems, and ensure that integrated components function as expected in realistic scenarios.
|
|
26
26
|
|
|
27
|
-
If the user says create tests for all methods in an endpoint then use "" as method value and skyramp will create all test in one file
|
|
28
27
|
For detailed documentation visit: https://www.skyramp.dev/docs/integration-test`,
|
|
29
28
|
inputSchema: integrationTestSchema,
|
|
30
29
|
}, async (params) => {
|
|
@@ -56,7 +56,6 @@ Load tests evaluate your application's performance, scalability, and stability u
|
|
|
56
56
|
|
|
57
57
|
***IMPORTANT**
|
|
58
58
|
-At any given time you can provide duration of the test or test execution count
|
|
59
|
-
-If the user says create tests for all methods in an endpoint then use "" as method value and skyramp will create all test in one file
|
|
60
59
|
|
|
61
60
|
For detailed documentation visit: https://www.skyramp.dev/docs/load-test`,
|
|
62
61
|
inputSchema: loadTestSchema,
|
|
@@ -25,8 +25,6 @@ export function registerSmokeTestTool(server) {
|
|
|
25
25
|
|
|
26
26
|
Smoke testing is a preliminary check used to verify that an endpoint is accessible and returns a valid response. Smoke tests are useful for quickly identifying critical defects after significant changes. They provide rapid validation for basic functionality verification and endpoint accessibility testing.
|
|
27
27
|
|
|
28
|
-
If the user says create tests for all methods in an endpoint then use "" as method value and skyramp will create all test in one file
|
|
29
|
-
|
|
30
28
|
For detailed documentation visit: https://www.skyramp.dev/docs/smoke-test`,
|
|
31
29
|
inputSchema: smokeTestSchema,
|
|
32
30
|
annotations: {
|
|
@@ -3,7 +3,7 @@ import { SkyrampClient } from "@skyramp/skyramp";
|
|
|
3
3
|
import openProxyTerminalTracked from "../utils/proxy-terminal.js";
|
|
4
4
|
import { TELEMETRY_entrypoint_FIELD_NAME } from "../utils/utils.js";
|
|
5
5
|
export function registerTraceTool(server) {
|
|
6
|
-
server.registerTool("
|
|
6
|
+
server.registerTool("skyramp_start_trace_collection", {
|
|
7
7
|
description: `Start trace collection using Skyramp's comprehensive tracing capabilities.
|
|
8
8
|
|
|
9
9
|
Trace collection monitors your application in real-time to capture user interactions, API calls, service communications, and data flows. This captured data is then used to generate comprehensive integration, load, and E2E tests that reflect real-world usage patterns.
|
|
@@ -4,7 +4,7 @@ import { z } from "zod";
|
|
|
4
4
|
import { PLAYWRIGHT_OUTPUT_FILE_FIELD_NAME, TELEMETRY_entrypoint_FIELD_NAME, TRACE_OUTPUT_FILE_FIELD_NAME, validatePath, } from "../utils/utils.js";
|
|
5
5
|
import { logger } from "../utils/logger.js";
|
|
6
6
|
export function registerTraceStopTool(server) {
|
|
7
|
-
server.registerTool("
|
|
7
|
+
server.registerTool("skyramp_sop_trace_collection", {
|
|
8
8
|
description: `Stop trace collection and save captured data using Skyramp's comprehensive tracing capabilities.
|
|
9
9
|
|
|
10
10
|
Stopping trace collection finalizes the monitoring process and exports all captured data to specified files. This includes API calls, service communications, user interactions, and network traffic that occurred during the collection period.
|
package/build/types/TestTypes.js
CHANGED
|
@@ -71,7 +71,7 @@ export const baseTestSchema = {
|
|
|
71
71
|
method: z
|
|
72
72
|
.string()
|
|
73
73
|
.default("")
|
|
74
|
-
.describe(
|
|
74
|
+
.describe('HTTP method to use. DEFAULT: Use empty string ("") to test ALL available methods from OpenAPI schema (recommended). Only specify a specific method (GET, POST, PUT, DELETE, etc.) if user explicitly requests testing a single method only.'),
|
|
75
75
|
apiSchema: z
|
|
76
76
|
.string()
|
|
77
77
|
.default("")
|