LMC MCP Server

🚀 OpenDSS MCP Server

This project is an OpenDSS server built using the Model Context Protocol (MCP) framework. It enables power system simulation tools to interact with Large Language Models (LLMs) via the MCP protocol.

🚀 Quick Start

Start the Server

# Run in development mode with a debugging interface
mcp dev -m opendss_mcp.server

# Install to Claude Desktop
mcp install -m opendss_mcp.server

Basic Usage Example

from mcp.server.fastmcp import FastMCP
from opendss_mcp.models.opendss import OpenDSSModel

# Create an OpenDSS MCP server
mcp = FastMCP("OpenDSS Server")

# Compile a DSS file
@mcp.tool()
def compile_dss_file(file_path: str) -> dict:
    """Compile a DSS file"""
    model = OpenDSSModel()
    return model.compile_dss_file(file_path)

✨ Features

• Support the core functions of OpenDSS power system simulation.
• Expose OpenDSS functions and data through the MCP protocol.
• Provide easy - to - use resources, tools, and prompt templates.
• Support common tasks for power system analysis and operation.

📦 Installation

Prerequisites

• Python 3.10 or higher
• OpenDSS installation (via opendssdirect.py)

Installation Steps

Install using uv (recommended):

uv install git+https://github.com/your-username/opendss-mcp.git

Or install using pip:

pip install git+https://github.com/your-username/opendss-mcp.git

💻 Usage Examples

Basic Usage

from mcp.server.fastmcp import FastMCP
from opendss_mcp.models.opendss import OpenDSSModel

# Create an OpenDSS MCP server
mcp = FastMCP("OpenDSS Server")

# Compile a DSS file
@mcp.tool()
def compile_dss_file(file_path: str) -> dict:
    """Compile a DSS file"""
    model = OpenDSSModel()
    return model.compile_dss_file(file_path)

Advanced Usage

# Advanced scenarios can be further extended based on basic usage, such as handling multiple DSS files or complex power system analysis.

📚 Documentation

Tools

• compile_dss_file: Compile a DSS file.
• execute_command: Execute an OpenDSS command.
• solve: Solve the power system.
• get_power_flow: Get the power flow results.
• get_voltages: Get voltage information.
• get_losses: Get loss information.

Resources

• circuit://current: Get current circuit information.
• elements://{type}: Get information about elements of a specified type.
• buses://list: Get a list of all buses.
• results://{result_type}: Get result data of a specified type.

Prompt Templates

• analyze_circuit: Prompt template for circuit analysis.
• solve_power_flow: Prompt template for solving power flow.
• explain_results: Prompt template for explaining results.

🤝 Contribution

Welcome to submit issue reports and contribute code. Please ensure that the submitted code complies with the project's coding standards.

📄 License

MIT