shutdown_simulator
Safely shut down the Xcelium simulator to preserve SHM waveform data during debug sessions. Use this tool to close databases and terminate simulations without losing critical debugging information.
Instructions
Safely shutdown the simulator, preserving SHM waveform data.
Closes all SHM databases and terminates xmsim gracefully. Always use this instead of disconnect_simulator when ending a debug session. WARNING: exit or pkill will lose SHM data. This is the only safe way.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/xcelium_mcp/server.py:390-405 (handler)Implementation of the shutdown_simulator tool, which safely shuts down the simulator using the bridge and clears the connection.
async def shutdown_simulator() -> str: """Safely shutdown the simulator, preserving SHM waveform data. Closes all SHM databases and terminates xmsim gracefully. Always use this instead of disconnect_simulator when ending a debug session. WARNING: exit or pkill will lose SHM data. This is the only safe way. """ global _bridge bridge = _get_bridge() try: resp = await bridge.execute_safe("__SHUTDOWN__") return f"Simulator shutdown: {resp.body}" except (ConnectionError, asyncio.TimeoutError): return "Simulator shutdown completed (connection closed)." finally: _bridge = None