Structurizr DSL Debug MCP

🚀 Structurizr DSL Debugger for Cursor

A specialized tool for debugging Structurizr DSL syntax issues in the Cursor IDE. This tool integrates with Cursor via the Model Context Protocol (MCP) to enable real-time Structurizr DSL error detection, analysis, and repair suggestions.

🚀 Quick Start

The Structurizr DSL Debugger for Cursor is designed to help you debug Structurizr DSL syntax issues efficiently. It integrates with Cursor via the Model Context Protocol (MCP) to provide real-time error detection and repair suggestions.

✨ Features

• 🔍 Real-time Error Detection - Automatically captures syntax errors in Structurizr DSL files.
• 🛠️ Repair Suggestions - Offers intelligent suggestions to correct common DSL errors.
• 🔄 Browser Integration - Connects to Chrome and opens the Structurizr page to monitor errors.
• 🧩 Cursor IDE Integration - Seamlessly integrates with Cursor using the MCP tool.
• ⚙️ Configurability - Supports custom Structurizr port configuration.
• 📊 Error History - Maintains a log of captured errors for review.

📦 Installation

Requirements

• Node.js version 14 or higher.
• Cursor IDE.
• Google Chrome browser with remote debugging enabled.
• Structurizr Lite running locally (usually on port 8080).

Steps

1. Clone this repository:

   git clone https://github.com/your-username/structurizr-dsl-debugger.git
   cd structurizr-dsl-debugger
   

2. Install dependencies:

   npm install
   

3. Set up Cursor IDE integration:

   npm run setup
   

💻 Usage Examples

Starting Structurizr

1. Run Structurizr Lite (if not already running):

   docker run -it --rm -p 8080:8080 -v /path/to/workspace:/workspace structurizr/lite
   

Using the Debugger

1. Start Chrome browser and enable remote debugging:

   google-chrome --remote-debugging-port=9222 http://localhost:8080
   

2. Start the DSL debugger:

   # Standard start (default port 8080)
   npm start
   
   # Use a custom Structurizr port
   STRUCTURIZR_PORT=9090 npm start
   
   # Use the launcher with interactive prompts
   npm run debug
   

3. Use the MCP tool in Cursor IDE:

   connectToBrowser: { "debugPort": 9222, "structurizrPort": 8080 }
   getDslErrors: { "count": 5 }
   clearDslErrors: {}
   fixDslError: { "line": 776, "fix": "动态 ContainerName ErrorHandlingFlow {" }
   

Simplified Version

If you encounter issues with the main debugger, you can try the simplified version:

node simplified-dsl-debugger.js

Use shorter MCP tool names:

connect: { "port": 9222 }
errors: { "count": 5 }
fix: { "line": 776, "solution": "动态 ContainerName ErrorHandlingFlow {" }

Tool Scripts

• Capture errors directly:

  npm run capture
  

• View captured errors:

  npm run errors
  

📚 Documentation

Troubleshooting

Chrome Browser Connection Issues

• Ensure Chrome is running and remote debugging is enabled on port 9222.
• Check if any other programs are using the remote debugging port.
• Try restarting Chrome browser:

  chrome --remote-debugging-port=9222
  

MCP Tool Issues

• If MCP connection fails, ensure the target process is running and allows remote debugging requests.

Port Conflict Issues

• Check if any other programs are using the specified ports (e.g., 8080 or 9222).
• Try configuring and connecting with different ports.

📄 License

This project is licensed under the MIT License.