.env.sample

# PingOne MCP Server Configuration
# Copy this file to .env and update with your actual values

# =============================================================================
# REQUIRED: PingOne Global Settings
# =============================================================================

# PingOne region where your organization is hosted
# Valid values: north_america, europe, asia_pacific
PING_REGION=north_america

# Your PingOne Organization ID
PING_ORG_ID=your_org_id_here

# Default environment (must match one of the environment names below)
PING_DEFAULT_ENV=Production

# =============================================================================
# REQUIRED: Multi-Environment Configuration
# =============================================================================
# Each environment needs its own credentials and configuration.
# Use sequential numbering: PING_ENV_1_*, PING_ENV_2_*, etc.

# Environment 1: Production
PING_ENV_1_NAME=Production
PING_ENV_1_ALIAS=production,prod,live,prd
PING_ENV_1_ID=env-prod-12345-abcde-67890
PING_ENV_1_CLIENT_ID=prod_client_id_here
PING_ENV_1_CLIENT_SECRET=prod_client_secret_here

# Environment 2: Development  
PING_ENV_2_NAME=Development
PING_ENV_2_ALIAS=development,dev,develop
PING_ENV_2_ID=env-dev-67890-fghij-12345
PING_ENV_2_CLIENT_ID=dev_client_id_here
PING_ENV_2_CLIENT_SECRET=dev_client_secret_here

# Environment 3: Staging
PING_ENV_3_NAME=Staging
PING_ENV_3_ALIAS=staging,stage,qa,test
PING_ENV_3_ID=env-staging-abcde-klmno-67890
PING_ENV_3_CLIENT_ID=staging_client_id_here
PING_ENV_3_CLIENT_SECRET=staging_client_secret_here

# Environment 4: QA
PING_ENV_4_NAME=QA
PING_ENV_4_ALIAS=qa,quality,testing
PING_ENV_4_ID=env-qa-12345-pqrst-abcde
PING_ENV_4_CLIENT_ID=qa_client_id_here
PING_ENV_4_CLIENT_SECRET=qa_client_secret_here

# Environment 5: Demo
PING_ENV_5_NAME=Demo
PING_ENV_5_ALIAS=demo,demonstration,showcase
PING_ENV_5_ID=env-demo-67890-uvwxy-12345
PING_ENV_5_CLIENT_ID=demo_client_id_here
PING_ENV_5_CLIENT_SECRET=demo_client_secret_here

# =============================================================================
# OPTIONAL: Performance Tuning (Advanced Users Only)
# =============================================================================

# Environment type to help determine available tools
# Valid values: administrators, customer, workforce
# Leave empty for auto-detection
PING_ENV_TYPE=

# Network timeout for API requests (seconds)
PING_REQUEST_TIMEOUT=30

# Number of retry attempts for failed requests
PING_MAX_RETRIES=3

# Maximum requests per second (rate limiting)
PING_MAX_REQUESTS_PER_SECOND=50

# Default page size for paginated results
PING_DEFAULT_PAGE_SIZE=100

# Maximum page size allowed
PING_MAX_PAGE_SIZE=1000

# =============================================================================
# MCP CLIENT JSON CONFIGURATION EXAMPLES
# =============================================================================

# OPTION 1: Simple Single Environment Setup (for Claude Desktop)
# {
#   "mcpServers": {
#     "ping-mcp-server": {
#       "command": "python",
#       "args": ["main.py"],
#       "env": {
#         "PING_REGION": "north_america",
#         "PING_ORG_ID": "your_org_id_here",
#         "PING_DEFAULT_ENV": "Production",
#         "PING_ENV_1_NAME": "Production",
#         "PING_ENV_1_ID": "env-prod-12345",
#         "PING_ENV_1_CLIENT_ID": "your_client_id",
#         "PING_ENV_1_CLIENT_SECRET": "your_client_secret"
#       }
#     }
#   }
# }

# OPTION 2: Multi-Environment Setup (for Claude Desktop)
# {
#   "mcpServers": {
#     "ping-mcp-server": {
#       "command": "python", 
#       "args": ["main.py"],
#       "env": {
#         "PING_REGION": "north_america",
#         "PING_ORG_ID": "your_org_id_here",
#         "PING_DEFAULT_ENV": "Production",
#         "PING_ENV_1_NAME": "Production",
#         "PING_ENV_1_ALIAS": "production,prod,live",
#         "PING_ENV_1_ID": "env-prod-12345",
#         "PING_ENV_1_CLIENT_ID": "prod_client_id",
#         "PING_ENV_1_CLIENT_SECRET": "prod_secret",
#         "PING_ENV_2_NAME": "Development",
#         "PING_ENV_2_ALIAS": "development,dev",
#         "PING_ENV_2_ID": "env-dev-67890",
#         "PING_ENV_2_CLIENT_ID": "dev_client_id",
#         "PING_ENV_2_CLIENT_SECRET": "dev_secret"
#       }
#     }
#   }
# }

# OPTION 3: Docker with .env file mount (Recommended for complex setups)
# docker run -v $(pwd)/.env:/app/.env ping-mcp-server
# MCP JSON only needs transport configuration:
# {
#   "mcpServers": {
#     "ping-mcp-server": {
#       "command": "docker",
#       "args": ["run", "-v", "/path/to/.env:/app/.env", "ping-mcp-server"]
#     }
#   }
# }

# =============================================================================
# USAGE EXAMPLES
# =============================================================================

# Default environment queries (uses PING_DEFAULT_ENV):
# - "List users" → Uses Production
# - "Show applications" → Uses Production
# - "Get user groups" → Uses Production

# Specific environment queries:
# - "List users from Development" → Uses Development environment
# - "Show staging applications" → Uses Staging environment
# - "Get QA user groups" → Uses QA environment

# Alias support (case-insensitive):
# - "List prod users" → Uses Production (via 'prod' alias)
# - "Show dev applications" → Uses Development (via 'dev' alias)
# - "Get test groups" → Uses Staging (via 'test' alias)

# Environment discovery:
# - "List available environments" → Shows all configured environments
# - "What environments are configured?" → Shows environment details

# =============================================================================
# MIGRATION FROM OLD FORMAT
# =============================================================================

# OLD FORMAT (deprecated):
# PING_ENVIRONMENTS={"Production":"env-123","Development":"env-456"}

# NEW FORMAT (current):
# PING_ENV_1_NAME=Production
# PING_ENV_1_ID=env-123
# PING_ENV_1_CLIENT_ID=client_123
# PING_ENV_1_CLIENT_SECRET=secret_123
# 
# PING_ENV_2_NAME=Development  
# PING_ENV_2_ID=env-456
# PING_ENV_2_CLIENT_ID=client_456
# PING_ENV_2_CLIENT_SECRET=secret_456

# Benefits of new format:
# - Per-environment credentials
# - Flexible aliases
# - Easy to add/remove environments
# - Works in both .env files and MCP JSON
# - Better Docker support