MCP Redfish Go

🚀 Redfish MCP Server (Go)

A high - performance MCP (Model Context Protocol) server implemented in Go, designed to interact with Redfish - enabled infrastructure. It allows AI agents and applications to access Redfish API endpoints via natural language, facilitating intelligent management and monitoring of data center infrastructure.

🚀 Quick Start

# Clone the repository
git clone https://github.com/theoriginalaiexplorer/mcp-redfish-go.git
cd mcp-redfish-go

# Build the server
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# Configure environment
export REDFISH_HOSTS='[{"address": "192.168.1.100", "username": "admin", "password": "secret"}]'

# Run the server
./bin/redfish-mcp

✨ Features

• 🚀 High Performance: Implemented in native Go, with compiled binaries and a low memory footprint.
• 🔍 Redfish API Integration: Fully supports Redfish v1.x API specifications.
• 🤖 MCP Compatible: Seamlessly integrates with MCP clients and AI assistants.
• 🔐 Secure Authentication: Supports Basic and Session - based authentication.
• 🌐 Multiple Transports: Offers stdio, SSE, and streamable - http transport options.
• 🔄 Concurrent Operations: Utilizes goroutine - based concurrent discovery and requests.
• 📊 Structured Data Access: Retrieves JSON - based resource data with headers.
• 🛠️ Extensible Architecture: Features a modular design for easy customization.

📦 Installation

Prerequisites

• Go 1.21 or later
• Access to Redfish - enabled infrastructure

Building from Source

# Clone the repository
git clone https://github.com/theoriginalaiexplorer/mcp-redfish-go.git
cd mcp-redfish-go

# Initialize Go module
go mod tidy

# Build for your platform
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# Or build for multiple platforms
make go-build-all

Pre - built Binaries

Download the latest release binaries from the Releases page for:

• Linux (amd64)
• macOS (amd64)
• Windows (amd64)

💻 Usage Examples

list_servers

Lists all configured Redfish servers that can be accessed.

Example usage:

List all available Redfish servers

Response:

{
  "servers": ["192.168.1.100", "192.168.1.101"]
}

get_resource_data

Fetches data from a specific Redfish resource endpoint.

Parameters:

• url: The Redfish resource URL (e.g., https://192.168.1.100/redfish/v1/Systems/1)

Example usage:

Get the system information from https://192.168.1.100/redfish/v1/Systems/1

Response:

{
  "headers": {
    "content-type": ["application/json"],
    "etag": ["\"12345\""]
  },
  "data": {
    "@odata.id": "/redfish/v1/Systems/1",
    "Name": "System1",
    "Manufacturer": "Example Corp"
  }
}

📚 Documentation

Configuration

The server supports configuration through environment variables or JSON files. Configuration is validated at startup to ensure proper setup.

Configuration Methods

1. JSON File (Recommended for complex configurations):

   ./bin/redfish-mcp --config config.json
   

2. Environment Variables (Default):

   export REDFISH_HOSTS='[{"address": "192.168.1.100"}]'
   ./bin/redfish-mcp
   

JSON Configuration File

Create a config.json file with the complete configuration:

{
  "redfish": {
    "hosts": [
      {
        "address": "192.168.1.100",
        "port": 443,
        "username": "admin",
        "password": "secret123",
        "auth_method": "session",
        "tls_server_ca_cert": "/path/to/ca-cert.pem"
      }
    ],
    "port": 443,
    "auth_method": "session",
    "username": "default_user",
    "password": "default_pass",
    "tls_server_ca_cert": "",
    "insecure_skip_verify": false,
    "discovery_enabled": false,
    "discovery_interval": 30
  },
  "mcp": {
    "transport": "stdio",
    "log_level": "INFO"
  }
}

Accessing Servers Without SSL Certificates

For development or testing with Redfish servers that have self - signed or invalid SSL certificates, you can skip certificate verification:

Environment Variable:

export REDFISH_INSECURE_SKIP_VERIFY=true

JSON Configuration:

{
  "redfish": {
    "insecure_skip_verify": true
  }
}

⚠️ Important Note

Only use insecure_skip_verify in development or trusted environments. This option disables SSL certificate verification, making connections vulnerable to man - in - the - middle attacks.

Environment Variables

*Required when not using JSON config file

Host Configuration

Each host in REDFISH_HOSTS or the JSON file can specify:

• address (required): IP or hostname
• port (optional): Port number
• username (optional): Host - specific username
• password (optional): Host - specific password
• auth_method (optional): basic or session
• tls_server_ca_cert (optional): Custom CA certificate path

Validation

The server validates configuration on startup and exits with detailed error messages if invalid.

Running the Server

Basic Usage

# Build the server
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# Set configuration
export REDFISH_HOSTS='[{"address": "192.168.1.100", "username": "admin", "password": "secret"}]'

# Run with stdio transport (default)
./bin/redfish-mcp

# Or use a config file
./bin/redfish-mcp --config redfish-config.json

Transports

The server supports multiple MCP transport mechanisms:

stdio Transport (Default)

Standard input/output communication for direct integration with MCP clients.

export MCP_TRANSPORT="stdio"
./bin/redfish-mcp

SSE Transport (Server - Sent Events)

Network - based communication over HTTP for remote clients.

export MCP_TRANSPORT="sse"
./bin/redfish-mcp
# Server will be available at http://localhost:8000/sse

streamable - http Transport

Alternative HTTP - based transport for specific MCP implementations.

export MCP_TRANSPORT="streamable-http"
./bin/redfish-mcp

Makefile Targets

Use the provided Makefile for common operations:

make go-build      # Build the binary
make go-run        # Run the server
make go-test       # Run tests
make go-fmt        # Format code
make go-vet        # Lint code

Integration with MCP Clients

Claude Desktop

Add the server to your claude_desktop_config.json:

{
  "mcpServers": {
    "redfish": {
      "command": "/path/to/bin/redfish-mcp",
      "env": {
        "REDFISH_HOSTS": "[{\"address\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"secret123\"}]",
        "MCP_TRANSPORT": "stdio"
      }
    }
  }
}

VS Code with GitHub Copilot

Configure in your VS Code settings or .vscode/mcp.json:

{
  "mcp": {
    "servers": {
      "redfish": {
        "command": "/path/to/bin/redfish-mcp",
        "env": {
          "REDFISH_HOSTS": "[{\"address\": \"192.168.1.100\", \"username\": \"admin\", \"password\": \"secret123\"}]",
          "MCP_TRANSPORT": "stdio"
        }
      }
    }
  }
}

MCP Inspector

Test the server with the MCP Inspector:

npx @modelcontextprotocol/inspector /path/to/bin/redfish-mcp

For more information, see the VS Code documentation.

Testing

Unit Tests

Run the Go test suite:

# Run all tests
go test ./...

# Run with race detection
go test -race ./...

# Run with coverage
go test -cover ./...

# Using Makefile
make go-test

MCP Inspector

Test the server interactively with the MCP Inspector:

# Build and test
go build -o bin/redfish-mcp ./cmd/redfish-mcp
npx @modelcontextprotocol/inspector ./bin/redfish-mcp

Integration Testing

The server can be tested against real Redfish hardware or emulators. Ensure your REDFISH_HOSTS configuration points to accessible endpoints.

Example Use Cases

• AI Assistants: Enable LLMs to fetch infrastructure data via Redfish API.
• Chatbots & Virtual Agents: Retrieve data and personalize responses.

Development

Prerequisites

• Go 1.21 or later
• Git

Setup

# Clone the repository
git clone https://github.com/theoriginalaiexplorer/mcp-redfish-go.git
cd mcp-redfish-go

# Install dependencies
go mod tidy

# Build
go build ./cmd/redfish-mcp

Development Workflow

# Format code
go fmt ./...

# Lint code
go vet ./...

# Run tests
go test ./...

# Build for development
go build -o bin/redfish-mcp ./cmd/redfish-mcp

# Run the server
./bin/redfish-mcp

Project Structure

.
├── cmd/redfish-mcp/          # Main application
│   └── main.go              # Entry point
├── pkg/                     # Go packages
│   ├── config/              # Configuration management
│   │   ├── config.go        # Config structs and validation
│   │   ├── env.go           # Environment parsing
│   │   └── config_test.go   # Unit tests
│   ├── redfish/             # Redfish client and discovery
│   │   ├── client.go        # HTTP client with retry logic
│   │   ├── discovery.go     # SSDP discovery
│   │   └── types.go         # Type definitions
│   ├── mcp/                 # MCP server implementation
│   │   └── server.go        # MCP server setup and tools
│   └── common/              # Shared utilities
│       └── hosts.go         # Host management
├── .github/workflows/       # CI/CD workflows
│   └── release.yml          # Release automation
├── Makefile                 # Build and development tasks
└── README.md               # This file

Code Quality

• Formatting: go fmt for consistent formatting
• Linting: go vet for static analysis
• Testing: Comprehensive unit tests with go test
• Modules: Go modules for dependency management

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes with tests
4. Run go test ./... and go vet ./...
5. Submit a pull request

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Acknowledgments

• Model Context Protocol for the protocol specification
• DMTF Redfish for the API standard
• Go community for the excellent tooling and libraries