mcp-redfish: Instructions file for Codex

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.14 recommended; Python 3.13 supported but deprecated (runtime policy)
• 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
# Breaking change: HTTP MCP transports (sse, streamable-http) now require
# authentication. Set MCP_AUTH_MODE (and the matching MCP_AUTH_* variables),
# or set MCP_HTTP_AUTH=false to keep unauthenticated HTTP. stdio is unchanged.
# make run-sse / make run-streamable-http will not start without that env.
# Prefer streamable-http. Non-loopback binds also require exact values in
# FASTMCP_HTTP_ALLOWED_HOSTS. See docs/MCP_AUTH.md for authentication and
# docs/MCP_HTTP_DEPLOYMENT.md for listener, TLS, and deployment settings.
# JWTs require exp and enforce nbf/future iat. Introspection additionally
# requires MCP_AUTH_INTROSPECTION_ISSUER and MCP_AUTH_INTROSPECTION_AUDIENCE;
# private IdPs require the warned MCP_AUTH_INTROSPECTION_ALLOW_PRIVATE=true.
# Loopback/private JWKS (OIDC Proxy, JWT JWKS) requires the warned
# MCP_AUTH_JWKS_ALLOW_PRIVATE=true.
# Non-loopback SSE is refused unless the legacy break-glass setting
# MCP_ALLOW_REMOTE_SSE=true is explicitly set; prefer streamable-http.
make run-sse              # Server-Sent Events transport (fail-closed without auth env)
make run-streamable-http  # Streamable HTTP transport (fail-closed without auth env)

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

# Debug with MCP Inspector
make inspect