Borrowing it
Nothing to install: this file belongs to luiscarbonel1991/nlp2sql. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/luiscarbonel1991/nlp2sql/main/CLAUDE.mdgit clone --depth 1 https://github.com/luiscarbonel1991/nlp2sqlWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/instructions/luiscarbonel1991/nlp2sql/claude-md)<a href="https://agentmods.dev/instructions/luiscarbonel1991/nlp2sql/claude-md"><img src="https://agentmods.dev/badge/instructions/luiscarbonel1991/nlp2sql/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/instructions/luiscarbonel1991/nlp2sql/claude-md"><img src="https://agentmods.dev/badge/instructions/luiscarbonel1991/nlp2sql/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.01413 | $0.01413 |
| Opus 5.5 | $0.00565 | $0.00565 |
| Sonnet 5.5 | $0.00283 | $0.00283 |
| Haiku 4.5 | $0.00141 | $0.00141 |
Grade A, and why
nlp2sql CLAUDE.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 157 lines — stays where its author put it; the contents beside it link to each section on GitHub.
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Project Overview
nlp2sql is an enterprise-ready Python library that converts natural language queries to SQL using multiple AI providers (OpenAI, Anthropic Claude, Google Gemini). Built with Clean Architecture principles for production scale (1000+ tables).
Documentation
| Document | Description |
|---|---|
README.md |
Overview and Quick Start |
docs/ARCHITECTURE.md |
Component Diagram and Data Flow |
docs/API.md |
Python API and CLI Reference |
docs/CONFIGURATION.md |
Environment Variables (single source of truth) |
docs/ENTERPRISE.md |
Large Scale Features and Migration |
docs/Redshift.md |
Amazon Redshift Integration |
Development Commands
# Install dependencies
uv sync
# Run tests
uv run pytest # All tests
uv run pytest tests/test_basic.py -v # Single test file
uv run pytest -m "not integration" # Skip integration tests
# Code quality
uv run ruff format . # Format code
uv run ruff check . # Lint code
uv run mypy src/ # Type checking
# CLI usage
uv run nlp2sql --help
uv run nlp2sql query --database-url "postgresql://testuser:testpass@localhost:5432/testdb" --question "How many users?"
# Docker test databases
cd docker && docker compose up -d # Start databases
# Simple DB: postgresql://testuser:testpass@localhost:5432/testdb
# Enterprise DB: postgresql://demo:demo123@localhost:5433/enterprise
# Redshift (LocalStack): redshift://testuser:testpass123@localhost:5439/testdb
Architecture
The codebase follows Clean Architecture (Hexagonal/Ports & Adapters):
src/nlp2sql/
├── core/ # Business entities (pure Python, no external dependencies)
│ ├── entities.py # Query, SQLQuery, DatabaseType
│ └── database_prompts.py # SQL dialect hints for AI providers
├── ports/ # Interfaces/abstractions (contracts)
│ ├── ai_provider.py # AIProviderPort - interface for AI providers
│ ├── embedding_provider.py # EmbeddingProviderPort - interface for embeddings
│ ├── schema_repository.py # SchemaRepositoryPort - database schema access
│ └── cache.py, query_optimizer.py, schema_strategy.py
├── adapters/ # External implementations
│ ├── openai_adapter.py # OpenAI GPT implementation
│ ├── anthropic_adapter.py # Anthropic Claude implementation
│ ├── gemini_adapter.py # Google Gemini implementation
│ ├── postgres_repository.py # PostgreSQL schema repository
│ ├── redshift_adapter.py # Amazon Redshift repository
│ ├── local_embedding_adapter.py # sentence-transformers embeddings
│ └── openai_embedding_adapter.py # OpenAI embeddings
├── services/ # Application services (orchestration)
│ └── query_service.py # QueryGenerationService - main orchestrator
├── schema/ # Schema management
│ ├── schema_manager.py # Coordinates filtering and strategies
│ ├── schema_analyzer.py # Scores schema relevance
│ ├── schema_embedding_manager.py # FAISS vector embeddings
│ └── example_store.py # ExampleStore - FAISS-indexed few-shot examples
├── config/ # Configuration (Pydantic Settings)
├── exceptions/ # Custom exceptions hierarchy
└── cli.py # Click-based CLI
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 1mo ago First seen · 157 lines · 1,413 tokens per session scan A 63c86165bb11
nlp2sql CLAUDE.md is an instructions file published in the GitHub repository luiscarbonel1991/nlp2sql (8 stars, last pushed 8d ago), licensed MIT. It adds 1,413 tokens to every session, about $0.0057 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-04.
Other instructions, from other repositories
vscode buildNext.instructions.md
Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).
next.js AGENTS.md
AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.
vscode oss-third-party-notices.instructions.md
Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).
langchain AGENTS.md
AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.
vscode copilot-instructions.md
Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).
deno copilot-instructions.md
Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.