model-finops
CLAUDE.md0 starsChanged 4 months agoMITView on GitHub
When user says "start day": This project does NOT use OpenAI APIs or models. NEVER: Use instead: This is a hard rule. No exceptions. Current Status: Supabase Migration Complete! πβ¨ Version: 4.0.0 (Supabase + Semantic Caching + Multi-Tenant) Type: Multi-Tenant AI/ML Cost Optimization Service with Semantic Caching The AI Cost Optimizer is a production-ready FastAPI service that intelligently routes LLM prompts to optimal AI models using semantic caching, multi-tenant RLS, and async-first architecture. It serves as both a standalone APIβ¦
- Reads credentials
- Installs packages
- Sends data out
- Commits and pushes
In this repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- ai-cost-optimizerSkill
The file
We split this CLAUDE.md into the rules it gives an agent
12 rules. About 0 are common, 8 are distinctive, and 4 are very specific to this project.
β0
Common Β· estimate
Many files like this have a rule of this kind.
β8
Distinctive Β· estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 5
When user says "start day":
- Distinctive: line 18
Create OpenAI-compatible endpoints or drop-in replacements
- Distinctive: line 20
Use GPT-3.5, GPT-4, or any OpenAI model names
- Very specific: line 186
Create a .env file with:
- Distinctive: line 448
All cost calculations in USD cents for precision
- Distinctive: line 449
Use dependency injection for API clients
- Distinctive: line 508
Verify absolute path in Claude Desktop config
- Very specific: line 509
Check COST_OPTIMIZER_API_URL environment variable
- Very specific: line 514
Verify API keys in .env file
- Distinctive: line 515
Check provider service status
- Very specific: line 520
Check Supabase credentials in .env
- Distinctive: line 521
Verify pgvector extension is enabled
β βCommonβ is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. βVery specificβ is our guess from the words: it names a file, a command, a setting or the project itself.
Files
CLAUDE.md - Model FinOps (modelfinops.com)
Start Day Protocol
When user says "start day":
- Read CLAUDE.md
git status+git log --oneline -5- List blockers and next 3 priorities
CRITICAL RULE: NO OPENAI
This project does NOT use OpenAI APIs or models. NEVER:
- Reference OpenAI SDK, GPT models, or
openaipackage - Create OpenAI-compatible endpoints or drop-in replacements
- Suggest OpenAI as a provider option
- Use GPT-3.5, GPT-4, or any OpenAI model names
Use instead:
- Claude (Anthropic) - Primary for complex reasoning
- Gemini (Google) - Cost-effective, large context
- DeepSeek - Cheapest for bulk processing
- Groq - Ultra-fast inference (LPU)
- Cerebras - Fast inference (wafer-scale)
- OpenRouter - Multi-model gateway (but NOT for OpenAI models)
This is a hard rule. No exceptions.
1. Project Status & Overview
Current Status: Supabase Migration Complete! πβ¨ Version: 4.0.0 (Supabase + Semantic Caching + Multi-Tenant) Type: Multi-Tenant AI/ML Cost Optimization Service with Semantic Caching
The AI Cost Optimizer is a production-ready FastAPI service that intelligently routes LLM prompts to optimal AI models using semantic caching, multi-tenant RLS, and async-first architecture. It serves as both a standalone API and an MCP (Model Context Protocol) server for Claude Desktop integration.
π MAJOR UPGRADE - Supabase Migration (COMPLETE!):
- β Semantic Caching: pgvector-powered fuzzy matching (3x better cache hit rate!)
- β Multi-Tenancy: Row-Level Security (RLS) for data isolation
- β Async-First: All database operations non-blocking
- β Managed PostgreSQL: Supabase replaces SQLite + Redis
- β Real-time Subscriptions: Supabase Realtime (replaces custom WebSocket)
- β JWT Authentication: Secure user authentication with automatic RLS
- β ML Embeddings: Local 384D vectors (sentence-transformers)
Previous Features (Still Active):
- β A/B Testing Framework: Experiment tracking with statistical analysis
- β Intelligent Auto-Routing: Learning-based model selection with hybrid validation
- β Strategy Pattern Architecture: Pluggable routing strategies (complexity, learning, hybrid)
- β Metrics & Analytics: Comprehensive routing performance tracking and ROI analysis
Core Features:
- Multi-provider support (Gemini, Claude, Cerebras, OpenRouter)
- Semantic caching with 95% similarity threshold (fuzzy matching!)
- Multi-tenant user isolation via RLS
- Real-time metrics streaming via Supabase Realtime
- JWT-based authentication
- Claude Desktop MCP integration
- Fallback routing for reliability
2. Technology Stack
Core Framework & Runtime
- Language: Python 3.8+
- Web Framework: FastAPI (with automatic OpenAPI docs)
- ASGI Server: Uvicorn with standard extras
- Environment Management: python-dotenv
Database & Backend (Supabase Platform)
- Database: Supabase PostgreSQL (managed, production-ready)
- Vector Extension: pgvector for 384D embeddings (IVFFlat indexing)
- Authentication: Supabase Auth with JWT (HS256)
- Row-Level Security: 18 RLS policies across 7 tables for multi-tenancy
- Real-time: Supabase Realtime for live metrics streaming
- Python Client: supabase-py>=2.3.0
- Data Validation: Pydantic v2
- HTTP Client: httpx for async API calls
AI/ML Components
- Primary Providers: Google Gemini, Anthropic Claude, Cerebras, OpenRouter
- Embeddings: sentence-transformers (all-MiniLM-L6-v2, 384 dimensions)
- ML Framework: PyTorch (GPU/CPU auto-detection)
- Semantic Search: Cosine similarity with 95% threshold
- RoutingEngine: Strategy pattern-based routing orchestrator
- ComplexityStrategy: Keyword + length-based scoring (baseline)
- LearningStrategy: Learning-based recommendations from performance data
- HybridStrategy: Learning with complexity validation (default for auto_route=true)
- MetricsCollector: Async tracking of routing decisions, costs, confidence levels
- ExperimentTracker: A/B testing with deterministic user assignment
- Token Counting: Custom token estimation logic
Development & Testing
- Testing: pytest with asyncio support
- Containerization: Docker & Docker Compose
- Migrations: Supabase SQL migrations
- Code Quality: Pre-commit hooks (if configured)
3. Development Workflow
Initial Setup
# Clone and setup
git clone <repository>
cd ai-cost-optimizer
# Environment setup
cp .env.example .env
# Edit .env with your Supabase credentials and API keys:
# - SUPABASE_URL=https://your-project.supabase.co
# - SUPABASE_ANON_KEY=eyJhbGc...
# - SUPABASE_SERVICE_KEY=eyJhbGc...
# - SUPABASE_JWT_SECRET=your-jwt-secret
# - GOOGLE_API_KEY, ANTHROPIC_API_KEY, etc.
# Install dependencies (includes ML models)
pip install -r requirements.txt
pip install -r mcp/requirements.txt
# Run database migrations (via Supabase SQL Editor)
# 1. Go to https://supabase.com/dashboard/project/YOUR_PROJECT/sql
# 2. Run migrations/supabase_part1_extensions.sql
# 3. Run migrations/supabase_create_tables.sql
# 4. Run migrations/supabase_part2_schema_fixed.sqlRunning the Application
Development Mode:
# Run FastAPI with auto-reload
python app/main.py
# or
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000Production Mode:
# Using Docker
docker-compose up --build
# Or directly
uvicorn app.main:app --host 0.0.0.0 --port 8000Testing
# Run all tests
pytest
# Run with coverage
pytest --cov=app tests/
# Run specific test file
pytest tests/test_routing.py -vBuilding & Deployment
# Build Docker image
docker build -t ai-cost-optimizer .
# Run with Docker
docker run -p 8000:8000 --env-file .env ai-cost-optimizer4. Environment Variables
Create a .env file with:
Required - Supabase Configuration
# Supabase Backend (REQUIRED)
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_ANON_KEY=eyJhbGc... # Public anon key (respects RLS)
SUPABASE_SERVICE_KEY=eyJhbGc... # Admin service key (bypasses RLS)
SUPABASE_JWT_SECRET=your-jwt-secret # For JWT validation
SUPABASE_DB_PASSWORD=your-db-password # Database passwordRequired - AI Provider Keys (at least one)
# Gemini (Recommended for free tier)
GOOGLE_API_KEY=your_gemini_key
# Anthropic Claude
ANTHROPIC_API_KEY=your_claude_key
# OpenRouter (Fallback)
OPENROUTER_API_KEY=your_openrouter_key
# Cerebras (Optional)
CEREBRAS_API_KEY=your_cerebras_keyOptional Configuration
# Service Configuration
COST_OPTIMIZER_API_URL=http://localhost:8000
LOG_LEVEL=INFO
# MCP Server (for Claude Desktop)
MCP_SERVER_PORT=8001
# Embedding Configuration
EMBEDDING_MODEL_NAME=sentence-transformers/all-MiniLM-L6-v2
EMBEDDING_DEVICE=cpu # or 'cuda' for GPU
SIMILARITY_THRESHOLD=0.95 # Cache hit threshold (0-1)5. Key Files & Their Purposes
Core Application
app/main.py- FastAPI application entry point, route definitions, lifespan managementapp/auth.py- JWT authentication middleware and dependencies (170 lines)app/routing/- Prompt analysis and model routing logicapp/routing/engine.py- RoutingEngine with strategy patternapp/routing/metrics_async.py- AsyncMetricsCollector (350 lines)
app/providers/- API clients for different LLM providersapp/services/routing_service.py- High-level routing orchestration (async)app/models/- Pydantic models for request/response schemas
Database & Backend (Supabase)
app/database/supabase_client.py- Async Supabase client wrapper (350 lines)app/database/cost_tracker_async.py- AsyncCostTracker with semantic caching (900+ lines)app/embeddings/generator.py- EmbeddingGenerator using sentence-transformers (280 lines)app/experiments/tracker_async.py- AsyncExperimentTracker for A/B testing (450 lines)migrations/supabase_part1_extensions.sql- pgvector, extensions, RPC functionsmigrations/supabase_create_tables.sql- 9 table definitionsmigrations/supabase_part2_schema_fixed.sql- RLS policies (18 policies across 7 tables)
MCP Integration
mcp/server.py- MCP server implementation for Claude Desktopmcp/requirements.txt- MCP-specific dependencies
Configuration & Deployment
requirements.txt- Main application dependencies (includes Supabase, ML libs)Dockerfile- Containerization configurationdocker-compose.yml- Multi-service setup.env.example- Environment template with Supabase configuration
Documentation
.claude/CLAUDE.md- This file (project overview for AI assistants)docs/REALTIME_SETUP.md- Guide for Supabase Realtime integration (400+ lines)
Testing
tests/- Test suite with unit and integration teststests/conftest.py- Shared pytest fixtures for Supabasetests/test_routing.py- Routing logic teststests/test_providers.py- Provider API teststests/test_experiment_*.py- A/B testing framework teststests/test_metrics_*.py- Metrics collection and caching tests
6. Testing Approach
Test Structure
# Example test pattern
def test_prompt_routing_simple():
"""Test that simple prompts route to Gemini"""
prompt = "Hello, how are you?"
result = router.analyze_prompt(prompt)
assert result.provider == "gemini"
assert result.is_complex == False
def test_provider_fallback():
"""Test fallback behavior when primary provider fails"""
# Mock primary provider to fail
# Verify fallback to OpenRouterRunning Tests
# Complete test suite
pytest
# Specific test category
pytest tests/test_routing.py
pytest tests/test_providers.py
# With verbose output
pytest -v --tb=short
# Test coverage report
pytest --cov=app --cov-report=htmlTest Data
- Mock API responses for providers
- Sample prompts of varying complexity
- Database state management with fixtures
7. Deployment
Backend (FastAPI)
# Local development
python app/main.py
# Docker
docker-compose up --buildFrontend (Next.js Dashboard)
- Production URL: https://modelfinops.com
- Vercel Project: modelfinops (scientia-capital) β Root Directory MUST be set to
frontend - Stack: Next.js 16, React 19, Tailwind CSS, Shadcn/ui
cd frontend
npm run dev # Local development
vercel --prod # Deploy to productionEnvironment Variables (Vercel Dashboard)
NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGc...
NEXT_PUBLIC_API_URL=https://YOUR_POD_ID-8000.proxy.runpod.netApple Silicon Build Instructions
Important: Apple Silicon Macs (M1/M2/M3) use ARM64 architecture, but RunPod uses x86_64/amd64. You cannot build Docker images locally that will run on RunPod.
Solution 1: GitHub Actions (Recommended)
Push to main branch to trigger automatic build:
git push origin main
# Workflow triggers on changes to: app/**, requirements.txt, Dockerfile
# Manual trigger: Go to GitHub Actions β Run workflowImage pushed to: ghcr.io/scientiacapital/ai-cost-optimizer:latest
Solution 2: Manual buildx (One-off builds)
# Setup buildx (one-time)
docker buildx create --use --name multiarch
# Build and push for linux/amd64 (GHCR)
docker buildx build --platform linux/amd64 --push \
-t ghcr.io/scientiacapital/ai-cost-optimizer:latest .
# Or push to Docker Hub (username: tmk74)
docker buildx build --platform linux/amd64 --push \
-t docker.io/tmk74/ai-cost-optimizer:latest .Docker Registry Options
- GHCR:
ghcr.io/scientiacapital/ai-cost-optimizer:latest - Docker Hub:
docker.io/tmk74/ai-cost-optimizer:latest(username:tmk74)
RunPod Deployment
Pod Configuration:
- Container Image:
ghcr.io/scientiacapital/ai-cost-optimizer:latest - Container Disk: 20GB
- Volume Disk: 10GB (mount to
/app/model_cache) - Expose Port: 8000
- GPU: None for testing (
$0.10/hr), RTX 4090 for production ($0.74/hr)
Environment Variables (RunPod Dashboard):
# Required
SUPABASE_URL=https://your-project.supabase.co
SUPABASE_ANON_KEY=eyJhbGc...
SUPABASE_SERVICE_KEY=eyJhbGc...
SUPABASE_JWT_SECRET=your-jwt-secret
GOOGLE_API_KEY=your-key
ANTHROPIC_API_KEY=your-key
# Configuration
PORT=8000
LOG_LEVEL=INFO
EMBEDDING_DEVICE=cpu # Change to 'cuda' for GPU pods
CORS_ORIGINS=https://modelfinops.com
TORCH_HOME=/app/model_cacheVerify Deployment:
curl https://YOUR_POD_ID-8000.proxy.runpod.net/health
# Expected: {"status": "healthy"}8. Coding Standards
FastAPI Specific Standards
# Use Pydantic v2 style
from pydantic import BaseModel, Field
class PromptRequest(BaseModel):
prompt: str = Field(..., min_length=1, max_length=10000)
user_id: str | None = Field(None, description="Optional user identifier")
# Use async/await for I/O operations
@app.post("/chat")
async def chat_endpoint(request: PromptRequest):
result = await router.route_prompt(request.prompt)
return ChatResponse(**result.dict())Project-Specific Conventions
- Provider classes must implement
send_message()method - All cost calculations in USD cents for precision
- Use dependency injection for API clients
- Log all routing decisions and costs
Error Handling Pattern
try:
response = await provider.send_message(prompt)
except ProviderError as e:
logger.warning(f"Provider {provider.name} failed: {e}")
return await fallback_provider.send_message(prompt)9. Common Tasks & Commands
Development Tasks
# Start development server
python app/main.py
# Run tests
pytest
# Check code style (if configured)
flake8 app/ tests/
# Format code (if configured)
black app/ tests/MCP Server Management
# Test MCP server directly
python mcp/server.py
# Update Claude Desktop config
# Edit: ~/Library/Application Support/Claude/claude_desktop_config.jsonDebugging Commands
# Check API health
curl http://localhost:8000/health
# Test routing directly
curl -X POST http://localhost:8000/chat \
-H "Content-Type: application/json" \
-d '{"prompt": "Explain quantum computing"}'10. Troubleshooting Tips
Common Issues
MCP Server Not Connecting:
- Verify absolute path in Claude Desktop config
- Check
COST_OPTIMIZER_API_URLenvironment variable - Restart Claude Desktop completely (don't just relaunch)
Provider API Errors:
- Verify API keys in
.envfile - Check provider service status
- Review API rate limits and quotas
Database Issues:
- Check Supabase credentials in
.env - Verify pgvector extension is enabled
Debug Mode
# Enable debug logging
import logging
logging.basicConfig(level=logging.DEBUG)
# Or set in environment
LOG_LEVEL=DEBUGHealth Check Endpoints
GET /health- Service statusGET /providers- Available provider statusGET /costs/summary- Cost tracking summary
Performance Monitoring
- Monitor response times in logs
- Track token usage patterns
- Review cost per provider in database
Maintenance Note: Regularly update provider API clients as LLM providers frequently change their interfaces and pricing structures.
See Also:
docs/COMMERCIALIZATION.mdfor revenue models and go-to-market strategydocs/REALTIME_SETUP.mdfor real-time metrics integration guide
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

