OpenSimulator

Provides an MCP interface to OpenSimulator, exposing admin commands for reading state and managing the grid via REST console integration.

python

GitHub Stars

python

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "sanchorelaxo-opensim-mcp": {
      "command": "opensim-mcp",
      "args": [],
      "env": {
        "OPENSIM_PATH": "YOUR_OPENSIM_PATH",
        "OPENSIM_CONSOLE_URL": "YOUR_CONSOLE_URL",
        "OPENSIM_CONSOLE_PASS": "secret",
        "OPENSIM_CONSOLE_USER": "admin"
      }
    }
  }
}

You can control OpenSimulator through an MCP (Model Context Protocol) server that exposes simulator console commands as high‑level tools. This lets you read server state and perform administrative actions from an MCP client, with secure, scripted, or automated workflows.

How to use

You interact with the MCP server by running a local or remote MCP client that supports the standard MCP command tools. There are three core tools you’ll use to issue commands to OpenSimulator via MCP: get for read-only queries, set for changes and configuration, and run for sending raw console commands when you need full flexibility. The MCP server translates each client command into the corresponding OpenSimulator console operation.

How to install

Prerequisites: you need a Python runtime and a running OpenSimulator instance with the REST console enabled.

# Install the MCP server package in editable mode
pip install -e .

# Run the MCP server (stdio-based runtime)
opensim-mcp

Configuration and runtime details

Configure the MCP server to connect to your OpenSimulator REST console by setting environment variables when you start the server.

Required environment variables (examples) are listed below. Replace the placeholders with your actual values.

export OPENSIM_PATH=~/opensimulator
export OPENSIM_CONSOLE_URL=http://127.0.0.1:9000
export OPENSIM_CONSOLE_USER=admin
export OPENSIM_CONSOLE_PASS=secret

Then start the MCP server with the same environment variables in effect.

## Security and access

Limit access to the MCP server by configuring a strong REST console user (username and password) and by running the MCP server on a protected network or behind an authentication mechanism appropriate for your environment.

## Troubleshooting tips

If you cannot connect to the REST console, verify that the OpenSimulator REST interface is reachable at the URL you configured and that your admin credentials are correct. Check firewall rules and ensure the MCP server process has network access to the REST endpoint.

## Notes on usage patterns

You can query server state with get, apply configuration or operational changes with set, or execute direct console commands with run when you need to issue a command outside the predefined MCP surface.

## Example usage patterns

Read server info

get("show info")

Change a setting (example placeholder)

set("set log level", "debug")

Run a raw console command (escape hatch)

run("command-script myscript.txt")


## Available tools

### get

Read-only queries to retrieve server state and information from the MCP server (e.g., show info, show uptime).

### set

Mutating or configuration actions to change server parameters or perform admin tasks via the MCP surface.

### run

Execute a raw console command, providing full access to the underlying OpenSimulator console when needed.

Built by

VeilStrat

AI signals for GTM teams