.env.example•4.23 kB
# ==============================================================================
# OpenRouter Search MCP Server - Environment Configuration
# ==============================================================================
#
# This file contains example environment variables for the OpenRouter Search
# MCP server. Copy this file to .env and update the values as needed.
#
# IMPORTANT: Never commit your actual .env file to version control!
#
# ==============================================================================
# ------------------------------------------------------------------------------
# Required Configuration
# ------------------------------------------------------------------------------
# OpenRouter API Key (REQUIRED)
# Get your API key from: https://openrouter.ai/keys
# Supports multiple environment variable names:
# - OPENROUTER_API_KEY (primary)
# - OPENROUTER_KEY (alternative)
OPENROUTER_API_KEY=sk-or-v1-your-api-key-here-at-least-20-characters
# ------------------------------------------------------------------------------
# Optional Configuration
# ------------------------------------------------------------------------------
# Default Perplexity Model
# The default model to use for search operations
# Valid values:
# - perplexity/sonar (default)
# - perplexity/sonar-small-chat
# - perplexity/sonar-medium-chat
# - perplexity/sonar-large-chat
# - perplexity/sonar-small-online
# - perplexity/sonar-medium-online
# Default: perplexity/sonar
OPENROUTER_DEFAULT_MODEL=perplexity/sonar
# Request Timeout (milliseconds)
# Maximum time to wait for API responses
# Must be a positive integer
# Default: 30000 (30 seconds)
OPENROUTER_TIMEOUT_MS=30000
# Default Search Parameters
# These values are used as defaults when search parameters are not specified
# Default Maximum Tokens
# Maximum number of tokens in the response
# Valid range: 1-8000, Default: 1000
OPENROUTER_DEFAULT_MAX_TOKENS=1000
# Default Temperature
# Controls randomness in response generation
# Valid range: 0-2, Default: 0.7 (0 = deterministic, 2 = very random)
OPENROUTER_DEFAULT_TEMPERATURE=0.7
# Default Top-P (Nucleus Sampling)
# Probability cutoff for token selection
# Valid range: 0-1, Default: 1.0 (0.1 = only top 10% likely tokens)
OPENROUTER_DEFAULT_TOP_P=1.0
# Default Frequency Penalty
# Penalty for repeated tokens based on frequency
# Valid range: -2 to 2, Default: 0.0 (0 = no penalty)
OPENROUTER_DEFAULT_FREQUENCY_PENALTY=0.0
# Default Presence Penalty
# Penalty for tokens that already appear in the text
# Valid range: -2 to 2, Default: 0.0 (0 = no penalty)
OPENROUTER_DEFAULT_PRESENCE_PENALTY=0.0
# OpenRouter API Base URL
# Base URL for the OpenRouter API
# Must be a valid URL
# Default: https://openrouter.ai/api/v1
OPENROUTER_BASE_URL=https://openrouter.ai/api/v1
# ------------------------------------------------------------------------------
# Application Configuration
# ------------------------------------------------------------------------------
# Log Level
# Controls the verbosity of application logging
# Valid values: error, warn, info, debug, silly
# Default: info
LOG_LEVEL=info
# ------------------------------------------------------------------------------
# Setup Instructions
# ------------------------------------------------------------------------------
#
# 1. Copy this file to .env:
# cp .env.example .env
#
# 2. Edit .env and replace placeholder values with your actual configuration:
# - Set OPENROUTER_API_KEY to your actual OpenRouter API key
# - Adjust optional settings as needed for your environment
#
# 3. Ensure .env is in your .gitignore file to prevent accidental commits
#
# 4. Test your configuration by running:
# npm run dev
#
# ------------------------------------------------------------------------------
# Security Notes
# ------------------------------------------------------------------------------
#
# - API keys are sensitive information - never share them publicly
# - Use different API keys for development, staging, and production
# - Regularly rotate your API keys for security
# - Monitor your API usage in the OpenRouter dashboard
#
# ==============================================================================