db-mcp: Instructions file for Claude Code

CLAUDE.md

db-mcp CLAUDE.md is an instructions file for Claude Code from apelogic-ai/db-mcp. It costs 3,650 tokens per session, scanned A, original, MIT.

Repository instructions for db-mcp, a server that lets Claude Desktop query databases using everyday language. It describes the project structure, supported database work, and planned features.

In plain words
What is it for?
Use it when modifying db-mcp, including its database-schema inspection, natural-language SQL generation, multiple database backends, or Python monorepo structure.
Why use it?
It gives an coding agent the project context needed to work consistently in the repository. It also explains terms such as MCP, a standard way for AI tools to connect to external data and services.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is apelogic-ai/db-mcp's own configuration. It tells Claude Code how to work on db-mcp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything db-mcp configures →

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is cd packages/data && uv run pytest tests/ -q; cd ../...

Reuse

Borrowing it

Nothing to install: this file belongs to apelogic-ai/db-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/apelogic-ai/db-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/apelogic-ai/db-mcp

Made for: Claude Code.

Wrote 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.

agentmods badge for db-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/apelogic-ai/db-mcp/claude-md.svg)](https://agentmods.dev/instructions/apelogic-ai/db-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/apelogic-ai/db-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/apelogic-ai/db-mcp/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 3,650 This file is loaded in full into every session.
When invoked 3,650 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

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.

ModelPer sessionOnce invoked
Fable 5.1 $0.03650 $0.03650
Opus 5 $0.01825 $0.01825
Sonnet 5 $0.00730 $0.00730
Haiku 4.5 $0.00365 $0.00365

Measured 8d ago against content hash 6fa7369825af, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

db-mcp 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 8d 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.

CLAUDE.md · 399 lines

How it starts

The opening of the file, as written. The whole thing — 399 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

db-mcp is an MCP (Model Context Protocol) server that enables Claude Desktop to query databases using natural language. It was extracted from the semantic-grid project as a standalone component.

The server:

  • Introspects database schemas automatically
  • Builds a semantic understanding of data through interactive onboarding
  • Generates and validates SQL from natural language
  • Supports multiple database backends

Roadmap Vision

The docs/ directory contains design documents for planned features:

  • Metrics Layer (metrics-layer.md) - Semantic metrics definitions for consistent business KPIs
  • Knowledge Extraction Agent (knowledge-extraction-agent.md) - Background agent that learns from query traces
  • Electron Desktop App (electron-port-feasibility.md) - Desktop GUI with Electron shell + db-mcp sidecar
  • Semantic Data Gateway (data-gateway.md) - Unified gateway for multiple data sources (CSV, BI tools, dbt)

Repository Structure

This is a Python monorepo managed with UV workspaces:

db-mcp/
├── packages/
│   ├── core/                    # Main application package (db-mcp)
│   │   ├── src/db_mcp/          # Source code
│   │   ├── tests/               # Test suite
│   │   ├── scripts/             # Build scripts
│   │   └── pyproject.toml       # Package config
│   ├── models/                  # Shared data models (db-mcp-models)
│   │   ├── src/db_mcp_models/
│   │   └── pyproject.toml
│   └── ui/                      # Next.js UI application
│       ├── app/                 # App Router pages
│       ├── components/          # React components
│       ├── lib/                 # BICP client, contexts
│       └── package.json
├── docs/                        # Design documents
├── scripts/                     # Installation scripts
├── .github/workflows/           # CI/CD (release.yml)
├── pyproject.toml               # Workspace root config
└── uv.lock                      # Dependency lockfile

Read the full file on GitHub · 399 lines

Changes

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.

  1. 8d ago First seen · 399 lines · 3,650 tokens per session scan A 6fa7369825af

Subscribe to this mod's changes

db-mcp CLAUDE.md is an instructions file published in the GitHub repository apelogic-ai/db-mcp (6 stars, last pushed 4mo ago), licensed MIT. It adds 3,650 tokens to every session, about $0.0182 per session on Opus 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-08-31.

Related

Other instructions, from other repositories

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.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

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).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

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.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens