mcp-redfish AGENTS.md

AGENTS.md

Project Overview

The Redfish MCP Server is a Python-based Model Context Protocol (MCP) server that provides a natural language interface for managing infrastructure via Redfish APIs. It uses FastMCP framework and integrates with the Python Redfish library to enable AI agents to interact with Redfish-enabled infrastructure components.

Key Technologies:

• Python 3.13+
• FastMCP framework
• Python Redfish library
• uv for dependency management
• pytest for testing
• ruff for linting and formatting
• mypy for type checking

Development Environment Setup

Quick Start

# Clone and install dependencies
make install  # or 'make dev' for development setup with pre-commit hooks

# Install development dependencies only
make install-dev

# Install test dependencies
make install-test

Using uv directly

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate
uv sync --extra dev --extra test

Pre-commit Setup

make pre-commit-install  # Install pre-commit hooks
make pre-commit-update   # Update hooks to latest versions
make pre-commit-run      # Run hooks on all files

Build and Test Commands

Running the Server

# Recommended: Run with console script
uv run mcp-redfish
# OR use Makefile shortcut:
make run-stdio

# Alternative transports
make run-sse              # Server-Sent Events transport
make run-streamable-http  # Streamable HTTP transport

# Development/CI: Run as module
uv run python -m src.main

# Debug with MCP Inspector
make inspect

Testing

# Run unit tests
make test
# OR directly with pytest:
uv run pytest -v

# Run tests with coverage
make test-cov
# OR directly:
uv run pytest --cov=src --cov-report=xml --cov-report=term-missing --cov-fail-under=70

# Run specific test types (if marked)
uv run pytest -m unit      # Unit tests only
uv run pytest -m integration  # Integration tests only
uv run pytest -m "not slow"   # Skip slow tests