History

René Cannaò 08cc2dbaa5 Merge commit from fork fix(security): MCP run_sql_readonly multi-statement bypass (CVE-2026-48774 / GHSA-7wh6-2vcc-gcm4)		1 month ago
..
ANOMALY_DETECTION	…
GH-Actions	…
LLM_Bridge	…
MCP	…
RAG	…
VECTOR_FEATURES	…
agents	…
ai-generated	…
internal	…
mysqlx	…
plugin-chassis	…
proxysql_cluster	…
release_notes	…
ssl_keylog	…
tsdb	…
vector-search-test	…
AI-DOCUMENTATION-FRAMEWORK.md	…
Aurora_Automated_Testing.md	…
BUILD-MACOS.md	…
GENAI.md	…
PLUGIN_API.md	…
PROMETHEUS_PROTOCOL_LABELS.md	…
README.md	…
RELEASE_NOTES_WORKFLOW.md	…
Read_Only_Testing.md	…
SQLite3-Server.md	…
Stats_Tables.md	…
Two_Phase_Discovery_Implementation.md	…
coredump_filters_documentation.md	…
ffto_design.md	…
killed_client_connections_documentation.md	…
multi_agent_database_discovery.md	…
pgsql_servers_ssl_params.md	…
query_rules_groups_documentation.md	…
rag-documentation.md	…
rag-doxygen-documentation-summary.md	…
rag-doxygen-documentation.md	…
rag-examples.md	…
tap_test_guide.md	…

README.md

ProxySQL Documentation Guide

Documentation Structure

ProxySQL documentation is organized into different tiers to help developers find the information they need:

🔬 AI-Generated Documentation (Exploration Guides)

The ai-generated/ directory contains documentation created by AI assistants to help developers explore the codebase:

⚠️ Important Notice: AI-generated documentation may contain inaccuracies and should be used as a starting point for exploration only. Always verify critical information against the actual source code.

Available AI-generated guides:

ai-generated/DOCUMENTATION-INDEX.md - Comprehensive index of all documentation
ai-generated/architecture/ARCHITECTURE-OVERVIEW.md - System architecture and design patterns
ai-generated/architecture/PROJECT-LAYOUT.md - Directory structure and module organization
ai-generated/architecture/VISUAL-GUIDE.md - Architecture diagrams and visual references
ai-generated/architecture/TEST-PIPELINE.md - Testing framework and CI/CD workflows
ai-generated/architecture/RELEASE-PIPELINE.md - Release process and packaging

Status: NON-VERIFIED

Last AI Update: 2025-09-11
Maintainer: Rene Cannao

📋 Human-Verified Documentation

Critical documentation that has been reviewed and verified by maintainers:

README.md - Main project overview and quick start
INSTALL.md - Installation instructions
FAQ.md - Frequently asked questions

🔧 Internal Documentation

Detailed technical documentation for specific components:

doc/internal/ - In-depth technical guides
doc/release_notes/ - Release notes and changelogs

Using AI-Generated Documentation

Start Here: Use AI-generated docs to understand the codebase structure
Verify Information: Always cross-reference with actual source code
Report Issues: Help improve accuracy by reporting discrepancies

Contributing to Documentation

AI Documentation: Contributions are welcome - please verify against source code
Verified Documentation: Follow the existing review process
Framework: See AI-DOCUMENTATION-FRAMEWORK.md for guidelines

This approach provides the benefits of AI-generated assistance while being transparent about limitations and reducing verification overhead.