DBchat AGENTS.md

A repository guide for DBChat, a Java 17 Maven project that includes an MCP server, database services, tests, and build scripts.

In plain words
What is it for?
Use it when developing DBChat, locating source and test files, selecting database build profiles, running the server, or executing protocol and integration tests.
Why use it?
It gives contributors the project layout, naming and architecture conventions, and the commands needed to build, run, and test the code.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/skanga/dbchat/agents-md
Clone the repo
git clone --depth 1 https://github.com/skanga/DBchat

Made for: Codex, OpenCode.

Per session 676 This file is loaded in full into every session.
When invoked 676 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00676 $0.00676
Opus 5 $0.00338 $0.00338
Sonnet 5 $0.00135 $0.00135
Haiku 4.5 $0.00068 $0.00068

Measured 2d ago against content hash ea8275be6396, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

DBchat AGENTS.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 2d 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.

AGENTS.md · 65 lines

How it starts

The opening of the file, as written. The whole thing — 65 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

DBChat is a Maven-based Java 17 project. Key locations:

  • src/main/java/com/skanga/mcp: MCP server, HTTP handler, config, DB services, prompts, workflows, insights.
  • src/main/java/com/skanga/demo and src/main/java/com/skanga/init: demo data and client config helpers.
  • src/main/resources: runtime resources (optional config).
  • src/test/java/com/skanga: JUnit 5 tests, integration tests, and performance tests.
  • build.sh, release.sh, RELEASE.bat: build/release helpers.
  • test-mcp-protocol.py, test-mcp-server.py: protocol smoke tests.
  • target/: Maven build output (generated).

Build, Test, and Development Commands

Common workflows use Maven profiles for DB driver variants:

mvn clean package                    # default drivers
mvn clean package -P standard-databases
./build.sh standard --skip-tests     # scripted build variants

Run locally with a config file or env vars:

java -jar target/dbchat-4.0.0.jar --config_file=dbchat.conf

Architecture Overview

DBChat is an MCP server that runs in stdio or HTTP mode. McpServer and McpHttpHandler accept JSON-RPC, route calls to services, and return typed responses. Core services include:

  • db package for JDBC access and resource discovery.
  • prompts, workflow, and insights for structured prompts, multi-step workflows, and captured analysis.
  • config for CLI/env/config parsing and resource management.

Coding Style & Naming Conventions

  • Java 17, 4-space indentation, keep packages under com.skanga.
  • Classes use PascalCase, methods/fields use camelCase.
  • Tests end in *Test.java, integration tests use *IntegrationTest.java.
  • Follow the Google Java Style guidance referenced in INSTALL.md.

Testing Guidelines

Frameworks: JUnit 5, Mockito, AssertJ, Testcontainers, and JaCoCo coverage.

mvn test
mvn test -Dtest=McpServerTest
mvn verify -P standard-databases

Maintain the existing high coverage (documentation cites ~90% lines) and add tests for new behavior or bug fixes.

Read the full file on GitHub · 65 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. 2d ago First seen · 65 lines · 676 tokens per session scan A ea8275be6396

Subscribe to this mod's changes

DBchat AGENTS.md is an instructions file published in the GitHub repository skanga/DBchat (97 stars, last pushed 4mo ago), licensed Apache-2.0. It adds 676 tokens to every session, about $0.0034 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-30.

Related

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

microsoft/vscode · 6,785 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

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,182 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,345 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

next.js 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