3. Script Language > Internet and Network > MCP. - MCP (Model-Context Protocol) server operations > !Server-Operations - Commands for interacting with a running MCP server (signals, actions) > HTP.Simulate

HTP.MCPSimulate

Previous Top Next

SPR Script Language

HTP.MCPSimulate

Injects a command into the MCP server's listener queue for testing.

Intention

This is a powerful debugging and testing command. It allows a script to act like an external client and place a command directly into the MCP server's queue when it's running in Listener Mode. This is invaluable for testing how your main script logic handles incoming commands without needing to set up a separate client application to send them.

By default, the command can only be executed once to prevent accidental loops.

This behavior can be overridden with an optional parameter.

Illustration

✉️ Self-Addressed Stamped Envelope: This command lets your script write a letter (a command), put it in an envelope, and drop it into its own mailbox (the server queue) to test if the mail-handling logic works correctly.

Syntax

HTP.MCPSimulate|$$MODE|$$PAYLOAD[|$$RESET][|$$JID]

Parameter Explanation

P1 - $$MOD - (Variable, Required)

A variable containing the mode of the command to inject. Valid values are the strings "RUNSCR" (to run script code directly) or "RUNPTH" (to run a script from a file path).

P2 - $$PAY - (Variable, Required)

A variable containing the payload for the command. This should be the script code if mode is "RUNSCR", or the file path if mode is "RUNPTH".

P3 - $$RES - (Numeric, Optional)

A numeric flag. If set to a non-zero value (e.g., 1), it will reset the one-time execution lock, allowing HTP.MCPSimulate to be called again. If omitted or 0, the command can only be run once.

Examples

'SPR Script-file: MCP_Server

'===========================================================

'#EXE:?path\

'#SPI:ForceWrite

VAR.$$CFG=?path\mcp_config.json

MCP.Init|$$CFG

MCP.SetLogToFile|1

MCP.SetLogLevel|3

' --- Step 1: Start the Server ---

MCP.Start|$$RES

JIZ.$$RES|Fail

GSB.WaitReady

MCP.ShowWindow|1

' --- Step 2: Create and Queue a Test Script ---

PRT.Generating and queueing a test script...

VAR.$$AIS='$$RES=25$crlf$MCP.ReturnResult|$$RES'

MCP.Simulate|RUNSCR|$$AIS|1|$$JID

IVV.$$JID=0

MBX.Simulate could not create a job.

GTO.Fail

EIF.

PRT.Test job queued with JobID: $$JID

' --- Step 3: Enter the Master Loop (Client Polling & Robot Working) ---

PRT.Entering Master Loop to process queue and wait for test result...

VAR.$$TMR=TIMER ' Start a timeout for the whole test

:MasterLoop

' --- Part A: Act as Robot Worker ---

' Check for any command in the queue and execute it immediately if found.

MCP.GetNextCommand|$$PAY|$$CMD|$$NID

IVV.$$NID!0

$$JID=$$NID

EIF.

' If a command was found (not null)

JIS.$$CMD|:Execute

' --- Part B: Act as Test Client ---

' Check the status of OUR test job.

MCP.CheckJobResult|$$JID|$$STA|$$CON

' Check if the test is finished (completed or failed)

IVS.$$STA=COMPLETED