Skip to main content

​
Description

Starts server mode in Roblox Studio (“Run” mode), which runs only the server-side code without a client. Useful for testing server scripts and backend logic. Requires StudioTestService to be available.

​
Endpoint

run_server

​
Parameters

This tool takes no parameters.

​
Response

​
ok
boolean
Returns true if server mode was started successfully
​
mode
string
Returns "server" to indicate the mode that was started
​
error
string
Error message if server mode could not be started

​
Examples

​
Start server mode

{}
Response: 
{
  "ok": true,
  "mode": "server"
}

​
Already running

{}
Response: 
{
  "error": "Already running — stop first"
}

​
Service unavailable

{}
Response: 
{
  "error": "StudioTestService not available"
}

​
Notes

  • Server mode only runs server-side scripts
  • No client is spawned, so client scripts won’t execute
  • Useful for testing ServerScriptService scripts
  • Must stop the session before starting another mode
  • Use stop_play to stop server mode

Build docs developers (and LLMs) love

Get started for freeTalk to us