Examples & Recipes

Real-world scenarios and practical recipes for PoshMcp.

For comprehensive examples and detailed recipes, see user-guide.md in the repository.

Example 1: Service Health Check Tool

Expose service management commands:

poshmcp create-config
poshmcp update-config --add-function Get-Service
poshmcp update-config --add-function Restart-Service
poshmcp update-config --add-exclude-pattern "*-Dangerous*"

Usage: "Are the Windows Update and Print Spooler services running?"

Example 2: Azure Resource Explorer

Expose Azure management commands:

poshmcp create-config
poshmcp update-config --add-function Get-AzResource
poshmcp update-config --add-function Get-AzResourceGroup
poshmcp update-config --add-function Get-AzVM

poshmcp update-config --add-install-module Az.Accounts --minimum-version 2.0.0
poshmcp update-config --add-install-module Az.Resources

poshmcp update-config --add-import-module Az.Accounts
poshmcp update-config --add-import-module Az.Resources

Startup script:

Connect-AzAccount -Identity -ErrorAction Stop

Usage: "How many VMs do we have in the East US region?"

Example 3: Custom Utility Functions

Define company-specific tools via startup script:

# startup.ps1
function Get-HealthCheck {
    $critical = @('wuauserv', 'spooler', 'w32time')
    $critical | ForEach-Object {
        Get-Service -Name $_ | Select-Object Name, Status, StartType
    }
}

function Get-SystemInfo {
    [PSCustomObject]@{
        ComputerName = $env:COMPUTERNAME
        OSVersion = [System.Environment]::OSVersion.VersionString
        PowerShellVersion = $PSVersionTable.PSVersion.ToString()
        InstallTime = (Get-Item "C:\Windows\System32\kernel32.dll").CreationTime
    }
}

Usage: "Run a health check on critical services"

Example 4: Multi-Module Setup

Expose Azure, storage, and compute commands:

poshmcp create-config

# Include specific commands
poshmcp update-config --add-include-pattern "Get-AzVM"
poshmcp update-config --add-include-pattern "Get-AzResource"
poshmcp update-config --add-include-pattern "Get-Service"
poshmcp update-config --add-include-pattern "Get-Process"

# Exclude dangerous patterns
poshmcp update-config --add-exclude-pattern "Remove-*"
poshmcp update-config --add-exclude-pattern "Invoke-*"

# Install and import modules
poshmcp update-config --add-install-module Az.Accounts --minimum-version 2.0.0
poshmcp update-config --add-install-module Az.Compute

poshmcp update-config --add-import-module Az.Accounts
poshmcp update-config --add-import-module Az.Compute

# Configure module discovery
poshmcp update-config --trust-psgallery
poshmcp update-config --install-timeout-seconds 900

Example 5: Container Deployment

Custom Dockerfile with pre-configured modules:

FROM poshmcp:latest

COPY appsettings.json /app/appsettings.json
COPY startup.ps1 /app/startup.ps1

ENV POSHMCP_CONFIGURATION=/app/appsettings.json
ENV DOTNET_ENVIRONMENT=Production

ENTRYPOINT ["poshmcp", "serve", "--transport", "http"]

Build and run:

docker build -t myorg/poshmcp:production .
docker run -d -p 8080:8080 --name poshmcp-prod myorg/poshmcp:production