|
<< Click to Display Table of Contents >> Navigation: 3. Script Language > Internet and Network > MCP. - MCP (Model-Context Protocol) server operations > Server Operations - Server control and execution > MCP Commands - Server Management |
MiniRobot Language (MRL) - MCP Server Management Commands
MCP.RegisterLMStudio
Register with LM Studio
Purpose
The MCP.RegisterLMStudio command registers the MCP server with LM Studio, a local LLM (Large Language Model) management application. This registration enables bidirectional communication between the MCP server and LM Studio, allowing LLM-based tools and AI integrations to function properly.
This command is particularly useful when:
• Setting up AI-powered tool integrations
• Enabling local LLM capabilities
• Configuring model context protocol with LM Studio
• Initializing AI assistant features
Syntax
MCP.RegisterLMStudio|$$HOST|PORT|$$RETURN_VAR
Parameters
$$HOST - The hostname or IP address of the LM Studio server (typically "localhost" or "127.0.0.1").
PORT - The port number on which LM Studio is listening (default is usually 1234).
$$RETURN_VAR - The variable that will receive the registration result status.
Return Value
The command populates $$RETURN_VAR with a status string containing:
SUCCESS - Registration completed successfully
ERROR: [message] - Registration failed with error description
Examples
' Example 1: Register with local LM Studio (default port)
MCP.RegisterLMStudio|localhost|1234|$$Result
PRT.Registration result: $$Result
' Example 2: Register with custom port and verify
MCP.RegisterLMStudio|127.0.0.1|8080|$$Status
SCH.In|$$Status|SUCCESS|$$IsSuccess
IVV.$$IsSuccess!0
PRT.LM Studio registered successfully!
ELS.
PRT.Registration failed: $$Status
EIF.
' Example 3: Register with dynamic host configuration
ENV.Get|LMSTUDIO_HOST|$$Host
IVV.$$Host!
$$Host=localhost
EIF.
MCP.RegisterLMStudio|$$Host|1234|$$RegResult
Remarks
The MCP.RegisterLMStudio command requires LM Studio to be running and configured to accept MCP connections. Ensure that LM Studio's local server is enabled in the application settings before attempting registration.
Registration is typically performed once during server initialization. The connection remains active until the MCP server or LM Studio is restarted. Re-registration may be required after service restarts.
For security reasons, LM Studio should be running on a trusted network. Avoid exposing LM Studio to public networks without proper authentication mechanisms.
Error Conditions
The command will fail with an error if:
• The host parameter is missing
• The port parameter is missing or invalid
• The return variable parameter is missing
• LM Studio is not running or not accessible
• Network connectivity issues prevent connection
• LM Studio rejects the registration request
See also:
• MCP.RegisterWithHost - Register with Host
• MCP.WriteConfig - Write Configuration