Vitess-AI-Agent/env.example at main · neutron-simlab/Vitess-AI-Agent · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# =============================================================================
# VITESS AI AGENT CONFIGURATION
# =============================================================================
# Copy this file to .env and fill in your actual values
# Remove the .example extension: cp .env.example .env
#
# CUSTOM ENV PATH SUPPORT:
# Set VITESS_ENV_PATH environment variable to load .env from custom location:
# export VITESS_ENV_PATH=/path/to/your/.env
# This allows keeping sensitive configs outside your project directory

# =============================================================================
# CORE API KEYS (REQUIRED)
# =============================================================================

# OpenAI API Key - Get from https://platform.openai.com/api-keys
OPENAI_API_KEY=sk-your-openai-api-key-here

# =============================================================================
# LLM PROVIDER CONFIGURATION
# =============================================================================

# Default provider to use (openai, blablador)
DEFAULT_PROVIDER=openai

# Fallback provider if default fails
FALLBACK_PROVIDER=blablador

# Default OpenAI model
DEFAULT_MODEL=gpt-4o-mini-2024-07-18

# LLM request settings
MAX_TOKENS=4000
TIMEOUT_SECONDS=60
MAX_RETRIES=3

# =============================================================================
# BLABLADOR SETTINGS (Optional - OpenAI-compatible API)
# =============================================================================

# Blablador API credentials
BLABLADOR_API_KEY=your-blablador-api-key-here
BLABLADOR_BASE_URL=https://api.helmholtz-blablador.fz-juelich.de/v1/
BLABLADOR_DEFAULT_MODEL=alias-fast-experiment

# =============================================================================
# LANGSMITH SETTINGS (Optional but recommended for tracing)
# =============================================================================

# Enable LangSmith tracing for debugging and monitoring
LANGSMITH_TRACING=false

# LangSmith configuration (only needed if LANGSMITH_TRACING=true)
LANGSMITH_ENDPOINT=https://api.smith.langchain.com
LANGSMITH_API_KEY=your-langsmith-api-key-here
LANGSMITH_PROJECT=Vitess-AI-Agent

# =============================================================================
# MCP TOOL PATHS (REQUIRED - Update paths to match your project structure)
# =============================================================================

# Path to read-in module MCP tools
READIN_MCP_PATH=./src/vitess_ai/mcp/readin_module_tools.py

# Path to guide module MCP tools
GUIDE_MCP_PATH=./src/vitess_ai/mcp/guide_module_tools.py

# Path to writeout module MCP tools
WRITEOUT_MCP_PATH=./src/vitess_ai/mcp/writeout_module_tools.py

# Path to filter module MCP tools
FILTER_MCP_PATH=./src/vitess_ai/mcp/filter_module_tools.py

# Path to supervisor CLI MCP tools
SUPERVISOR_MCP_PATH=./src/vitess_ai/mcp/supervisor_cli_tools.py

# =============================================================================
# VITESS SIMULATION ENVIRONMENT (REQUIRED - Neutron experiment simulation paths)
# =============================================================================

# Vitess modules installation path
# This should point to your Vitess software modules directory
VITESS_MODULES_PATH=/path/to/vitess/modules

# Vitess project directory path
# This should point to your specific neutron experiment project directory
VITESS_PROJECT_PATH=/path/to/your/vitess/project

# Vitess log file path
# Imaginary file name/path for Vitess logging configuration
VITESS_LOG_PATH=/path/to/vitess/logfile.log

# =============================================================================
# ENVIRONMENT SETTINGS
# =============================================================================

# Environment mode (development, staging, production)
ENVIRONMENT=development

# Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
LOG_LEVEL=INFO

# =============================================================================
# DEVELOPMENT NOTES
# =============================================================================

# To get started:
# 1. Copy this file: cp .env.example .env
# 2. Get OpenAI API key from: https://platform.openai.com/api-keys
# 3. Update MCP tool paths to match your project structure
# 4. Set up your Vitess simulation environment paths:
#    - VITESS_MODULES_PATH: Point to Vitess installation
#    - VITESS_PROJECT_PATH: Point to your neutron experiment project
#    - VITESS_LOG_PATH: Point to desired log file path (imaginary file name)
# 5. (Optional) Set up LangSmith for tracing: https://smith.langchain.com/
# 6. (Optional) Configure Blablador if you have access

# For neutron experiment simulations:
# - Ensure Vitess is properly installed and accessible
# - Verify all Vitess paths exist and log file path is properly configured
# - Test your Vitess environment before running AI agents
# - Check that your neutron experiment files are in the project path

# For production:
# - Set ENVIRONMENT=production
# - Consider enabling LANGSMITH_TRACING=true for monitoring
# - Use secure methods to set API keys (don't commit .env to git!)
# - Ensure Vitess paths are properly configured and log file path is set correctly

# Security reminder:
# - Never commit your .env file to version control
# - Add .env to your .gitignore file
# - Use environment-specific files (.env.development, .env.production)
# - In production, use secure secret management instead of .env files
# - Ensure Vitess directories have appropriate permissions