django-mcp-sql CLAUDE.md

mcp_sql — agent guidance

The full architecture, file map, settings shape, OAuth surface, curated-view pattern, naming map, and the complete "Watch out" list live in docs/architecture.md (shipped in the wheel). Read it before touching anything non-trivial here. Operational runbooks: docs/role-setup.md (DB role + grants) and docs/oauth.md (OAuth + MCP transport).

This package is distributed standalone as django-mcp-sql (see pyproject.toml, RELEASING.md). It must stay consumer-agnostic: no imports from the surrounding project in production code OR tests; every consumer-specific value comes from the MCP_SQL settings dict. The test suite runs standalone via make test here (settings: tests/settings.py).

Load-bearing invariants (full rationale in docs/architecture.md)

• Only SET LOCAL, never bare SET — transaction-mode pgbouncer would leak session GUCs onto reused backends. session.enter_readonly_session is the single helper; never inline a partial copy.
• The default DB alias must never serve MCP reads. The guarantee is the executor's connection.alias == DB_ALIAS assert, NOT the router (routers can't intercept explicit connections[...]). The router only blocks migrations on the read alias.
• Parser check ordering is a pinned contract (test_parser.TestCheckOrdering) — security reasons fire before ergonomic ones so audit rows name the real problem. Reorder with care.
• run_query results are fenced: rows (and error) come back as a per-response random-UUID <untrusted-data-…> string, not a list — the prompt-injection boundary. list_tables/describe_table are not fenced.
• MCPOAuth2Authentication is mounted on /mcp/sql/ only — never in REST_FRAMEWORK["DEFAULT_AUTHENTICATION_CLASSES"]; the view self-declares IsAuthenticated so stock DRF defaults can't pierce the package.
• Per-request FastMCP instantiation is deliberate (tool closures over the authenticated user). Tools are async def, dispatch ORM work via sync_to_async(..., thread_sensitive=False), and every dispatch is wrapped in _close_conns_after — keep all three properties for any new tool.
• Curated-view migrations live in the OWNING app, use CREATE OR REPLACE VIEW forward SQL (column-additive) and carry state_operations=[CreateModel(..., managed=False)].