Last updated: 2026-02-12

AI Integrations & MCP

Jam SQL Studio is designed as an AI-native SQL IDE. There are three ways to leverage AI with your databases: the built-in AI Chat Sidebar for conversational assistance right in the editor, the AI Workspace for file-backed collaboration with AI agents, and MCP Server for external AI tools to safely interact with your databases.

Quick Start: Connect Your AI Tool

Get your AI coding assistant connected to Jam SQL Studio in under 2 minutes. Choose your tool below:

Claude Code CLI

Claude Code can connect to Jam SQL Studio via MCP to query your databases directly from the terminal.

Step 1: Enable MCP Server in Jam SQL Studio

  1. Open Jam SQL Studio
  2. Go to Settings (gear icon) → AI Integrations tab
  3. Toggle Enable MCP server to ON
  4. Copy the Endpoint URL (e.g., http://127.0.0.1:14507/mcp)
  5. Click Show next to the token, then Copy the token

Step 2: Configure Claude Code

You have two options for configuring MCP servers:

Option A: User scope (available across all projects) — create or edit ~/.claude.json:

{
  "mcpServers": {
    "jam-sql": {
      "type": "http",
      "url": "http://127.0.0.1:14507/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN_HERE"
      }
    }
  }
}

Option B: Project scope (shared with your team) — create .mcp.json in your project root:

{
  "mcpServers": {
    "jam-sql": {
      "type": "http",
      "url": "${JAM_SQL_MCP_ENDPOINT:-http://127.0.0.1:14507/mcp}",
      "headers": {
        "Authorization": "Bearer ${JAM_SQL_MCP_TOKEN}"
      }
    }
  }
}

Project-scope config supports environment variable expansion with ${VAR} syntax.

Option C: Use the CLI to add the server directly:

claude mcp add --transport http jam-sql http://127.0.0.1:14507/mcp \
  --header "Authorization: Bearer YOUR_TOKEN_HERE" \
  --scope user

Step 3: Verify Connection

Run Claude Code and check that the server is connected:

claude mcp list

Or inside Claude Code, type /mcp to see connected servers.

Codex CLI

OpenAI's Codex CLI uses a TOML configuration file for MCP servers.

Step 1: Enable MCP Server in Jam SQL Studio

  1. Open Jam SQL Studio
  2. Go to Settings (gear icon) → AI Integrations tab
  3. Toggle Enable MCP server to ON
  4. Copy the Endpoint URL (e.g., http://127.0.0.1:14507/mcp)
  5. Click Show next to the token, then Copy the token

Step 2: Configure Codex

Add the MCP server to ~/.codex/config.toml:

[mcp_servers.jam-sql]
url = "http://127.0.0.1:14507/mcp"
bearer_token_env_var = "JAM_SQL_MCP_TOKEN"

Then set the token in your shell profile (~/.zshrc or ~/.bashrc):

export JAM_SQL_MCP_TOKEN="YOUR_TOKEN_HERE"

Alternative: Use the CLI to add the server:

codex mcp add jam-sql --url http://127.0.0.1:14507/mcp

Step 3: Verify Connection

Inside Codex, type /mcp to see active MCP servers.

Troubleshooting: If Jam SQL's AI Chat Sidebar shows unexpected argument '--json', your Codex CLI is incompatible with session resume. Update Codex CLI and confirm codex exec resume --help lists --json.

Claude Desktop (Advanced - Requires Node 20+)

Note: Claude Desktop only supports stdio transport, not HTTP. This requires using the mcp-remote proxy which needs Node.js 20+ installed separately.

⚠️ Known Limitation: Claude Desktop ships with Node.js 18, but mcp-remote requires Node.js 20+. You must have Node 20+ installed and configure Claude Desktop to use it.

Step 1: Verify Node.js 20+

Check your Node version:

node --version  # Must be v20.0.0 or higher

If you don't have Node 20+, install it via nodejs.org or a version manager like nvm.

Step 2: Enable MCP Server in Jam SQL Studio

  1. Open Jam SQL Studio
  2. Go to Settings (gear icon) → AI Integrations tab
  3. Toggle Enable MCP server to ON
  4. Copy the Endpoint URL and Bearer Token

Step 3: Configure Claude Desktop

Edit the config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "jam-sql": {
      "command": "/path/to/node20+/bin/npx",
      "args": [
        "-y",
        "mcp-remote",
        "http://127.0.0.1:14507/mcp",
        "--header",
        "Authorization:${JAM_SQL_TOKEN}"
      ],
      "env": {
        "JAM_SQL_TOKEN": "Bearer YOUR_TOKEN_HERE"
      }
    }
  }
}

Important: Replace /path/to/node20+/bin/npx with the actual path to npx from your Node 20+ installation. Examples:

  • nvm (macOS/Linux): ~/.nvm/versions/node/v22.x.x/bin/npx
  • Homebrew (macOS): /opt/homebrew/bin/npx (if Node 20+ is default)
  • Windows: C:\\Program Files\\nodejs\\npx.cmd

Step 4: Restart Claude Desktop

Quit and reopen Claude Desktop. You should see "jam-sql" in the MCP tools menu (hammer icon).

Troubleshooting: If you see ReferenceError: File is not defined, your npx path is using Node 18 or older. Update the path to point to Node 20+.
Other Tools / Direct HTTP

Any tool that supports HTTP can connect to Jam SQL Studio's MCP server.

Direct HTTP Access

Make HTTP POST requests to the MCP endpoint with JSON-RPC 2.0:

curl -X POST http://127.0.0.1:14507/mcp \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}'

Environment Variables (for custom integrations)

If your tool supports environment-based config:

export JAM_SQL_MCP_ENDPOINT="http://127.0.0.1:14507/mcp"
export JAM_SQL_MCP_TOKEN="YOUR_TOKEN_HERE"

LangChain / AutoGen / Custom Agents

Use any MCP client library or make direct HTTP calls to the endpoint. The server implements the standard Model Context Protocol specification.

Troubleshooting

  • Connection refused? Make sure Jam SQL Studio is running and MCP server is enabled in Settings.
  • 401 Unauthorized? Double-check your token — it must match exactly (no extra spaces).
  • Port mismatch? The port number may vary. Copy the endpoint URL from Jam SQL Studio settings (or click the MCP row in the AI menu — it shows 127.0.0.1:<port>).

AI Chat Sidebar

The AI Chat Sidebar brings conversational AI directly into the Query Editor and SQL Notebooks. Click the AI button in the toolbar to open a chat panel alongside your work.

No extra subscription required. The AI Chat Sidebar uses your locally installed AI CLI. Jam SQL Studio reuses your existing CLI setup — it does not proxy, bill, or require any additional AI subscription or API key configuration.

Supported AI Backends

The AI Chat Sidebar supports two AI backends. Install either or both — Jam SQL auto-detects available CLIs:

  • Claude CLI (Claude Code) — Anthropic's AI coding assistant
  • Codex CLI — OpenAI's command-line coding agent

When both CLIs are installed, a segmented control in the sidebar header lets you switch between them. Your preference is saved and applied to new tabs automatically.

How It Works

  1. Install Claude CLI or Codex CLI (or both)
  2. Open a Query Editor or SQL Notebook
  3. Click the AI button in the toolbar to open the chat sidebar
  4. Ask your AI about your SQL — it can read your editor content, run queries, and update your code

Features

  • Database-aware — the AI auto-connects to the MCP server for schema introspection and query execution
  • Editor integration — the AI can update your SQL directly in the editor
  • Notebook support — In SQL Notebooks, the AI understands your cell structure and can add, edit, and execute cells on your behalf
  • @-mentions — type @ to reference database objects from the Object Explorer
  • Streaming responses — see answers appear in real-time with inline tool call indicators
  • Session continuity — conversations persist across tab switches and session restores
  • Multi-backend — switch between Claude and Codex with a single click; each manages its own authentication
  • Zero configuration — if a supported CLI is installed, the sidebar auto-connects to the MCP server. No API keys to paste into Jam SQL.
  • Privacy — all communication happens locally between the app and the CLI binary on your machine

Understanding the Three Approaches

Jam SQL Studio offers flexibility in how you work with AI. Depending on your workflow, you might prefer one approach or combine them:

AI Chat Sidebar vs AI Workspace vs MCP Server

AspectAI Chat SidebarAI WorkspaceMCP Server
Where it runsRight panel in Query Editor / SQL NotebookInside Jam SQL Studio (integrated terminal)External AI tools (Claude Desktop, Codex CLI, etc.)
Best forQuick questions, SQL help, interactive editingFile-backed iteration with AI agentsComplex analysis, multi-step tasks from external tools
Context sharingAutomatic: editor content, connection, database objectsFile-backed: .sql files, CLAUDE.md, schema exportsMCP resources: live snapshots of tabs, editors, results
ConfigurationInstall Claude CLI or Codex CLIEnable AI Workspace in SettingsEnable MCP Server, copy endpoint + token to AI tool

AI Workspace (Inside the App)

The AI Workspace provides file-backed query tabs that sync bidirectionally with .sql files. Combined with the integrated terminal, this enables AI agents (like Claude Code) to edit your queries in real-time.

Pro Feature: AI Workspace sync features (file sync, schema export, context files) require Pro. The AI Terminal itself is free for all users.

AI Workspace Features

  • Bidirectional file sync — Query tabs sync to .sql files; AI edits the file, your tab updates automatically
  • Auto-generated contextCLAUDE.md and AGENTS.md contain connection info, schema summary, and recent execution results
  • Schema export — Detailed table/view/procedure definitions exported to .schema/ for granular @table mentions
  • Results history — Query results saved to .history/ so AI agents can analyze output and iterate
  • Knowledge pack — App capabilities and how-to documentation in .knowledge/
  • MCP environment variables — Terminal sessions include JAM_SQL_MCP_ENDPOINT and JAM_SQL_MCP_TOKEN for direct MCP access
  • Auto-generated MCP configs — Config files for popular AI tools (.mcp.json, .cursor/mcp.json, opencode.json, .vscode/mcp.json) are automatically created with endpoint and token

Zero-Config AI Tool Setup

When you open an AI Workspace terminal, MCP configuration files are automatically generated in the workspace directory. AI agents like Claude Code, Cursor, and OpenCode will automatically discover and connect to the MCP server without manual configuration. These files are added to .gitignore to prevent accidental token commits.

How to Use AI Workspace

  1. Open Jam SQL Studio and go to Settings → AI Workspace
  2. Enable AI Workspace and select or create a workspace folder
  3. Open the integrated terminal (View → Terminal or click Terminal in the sidebar)
  4. Run your AI coding agent (e.g., claude for Claude Code)
  5. The agent can read/edit .sql files, and your query tabs update in real-time
The AI Workspace settings panel showing workspace folder configuration and sync options.
The AI Workspace settings panel showing workspace folder configuration and sync options.

Pro Tip: Use @ Mentions

With schema export enabled, you can use @Customers or @Orders in your prompts to reference specific table definitions from the .schema/ folder.

MCP Server (Outside the App)

Jam SQL Studio runs a local MCP server (Model Context Protocol) that external AI tools can use to list connections, execute queries, control the UI, and read live app state — all under configurable safety policies.

MCP Server Capabilities

The MCP server exposes tools and resources for connections, queries, UI control, and app context. For a live, accurate list, read sql-studio://knowledge/app_capabilities.

Connection & Query Tools

  • connections_list — List saved connections (IDs, names, engines, servers — no secrets)
  • connections_connect — Connect the app to a saved connection (settings-gated; disabled by default)
  • query_execute — Execute SQL queries (permission-gated: Read-only allows SELECT; Confirm prompts for write approval)

UI Control Tools

  • ui_open_tab — Open query tabs (allowed even on Block); table explorer tabs require higher permissions
  • ui_focus_tab — Switch to a specific tab by ID
  • ui_set_editor_text — Write SQL content to an editor (allowed even on Block)
  • ui_close_tab — Close a tab
  • ui_lock_tab / ui_unlock_tab — Lock tabs to prevent conflicts during AI edits
  • ui_check_abort — Check if the user has requested an abort
  • ui_screenshot — Capture a screenshot of the current app window (settings-toggleable)

Table Viewer Tools

  • ui_list_tabs — List all open tabs with IDs, types, titles, and connection info
  • table_refresh — Refresh data in a table explorer tab
  • table_select_row — Select a row by index in a table explorer
  • table_show_row_details — Show/hide row details panel (bottom or side layout)
  • table_set_filter — Apply column filters to a table viewer
  • table_set_sort — Sort table data by column
  • table_set_pagination — Navigate pages of data
  • table_get_snapshot — Get current table state and preview rows
  • table_show_chart — Show/hide chart visualization
  • table_set_chart_config — Configure chart type, axes, and aggregation

Query Editor Tools

  • query_select_row — Select a row in query results (supports multi-result sets)
  • query_show_row_details — Show/hide row details panel
  • query_switch_tab — Switch result tabs (results, messages, plan, chart)
  • query_set_result_display — Set display mode (grid or plaintext)
  • query_execute_with_plan — Execute query with execution plan (estimated or actual)
  • query_get_execution_plan — Get execution plan summary and raw content
  • query_get_messages — Read messages from the messages tab
  • query_get_results — Read query results with optional row limit
  • query_show_chart — Show/hide chart visualization for results
  • query_set_chart_config — Configure chart for query results

Context Resources (Read-Only)

  • workspace_snapshot — Active workspace state
  • connections_snapshot — Saved connections with current status
  • tabs_snapshot — Open tabs with IDs, types, titles, active state
  • editor_snapshot — Active editor buffer with SQL content
  • results_snapshot — Latest query results metadata and preview rows
  • selection_snapshot — Currently selected explorer item

Knowledge Resources

  • app_manifest — App version, platform, enabled features
  • app_capabilities — Supported workflows and current limitations
  • app_user_guide — How-to documentation for using the app

Supported AI Tools

Any AI tool that supports MCP or HTTP can connect to Jam SQL Studio:

  • Claude Code (recommended) — Native HTTP support via .mcp.json (project) or ~/.claude.json (user), or use claude mcp add
  • Claude Desktop — Requires mcp-remote proxy and Node.js 20+ (see setup guide above)
  • Codex CLI — Configure in ~/.codex/config.toml or use codex mcp add
  • OpenCode — Environment variable configuration
  • GitHub Copilot — Via MCP extension or custom integration
  • Custom agents — Built with LangChain, AutoGen, or any HTTP client

Setting Up MCP Server

  1. Open Jam SQL Studio and go to Settings → AI Integrations
  2. Enable MCP Server
  3. Copy the Endpoint URL (e.g., http://127.0.0.1:14507/mcp)
  4. Copy the Bearer Token (click "Show" then "Copy")
  5. Configure your AI tool with the endpoint and token (see examples below)
The AI Integrations settings panel showing MCP server configuration, endpoint URL, and token management.
The AI Integrations settings panel showing MCP server configuration, endpoint URL, and token management.

Configuration Examples

Claude Code (JSON format, .mcp.json or ~/.claude.json):

{
  "mcpServers": {
    "jam-sql": {
      "type": "http",
      "url": "http://127.0.0.1:14507/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN_HERE"
      }
    }
  }
}

Note: Claude Desktop requires a different format using mcp-remote proxy. See the Claude Desktop quick start section above.

Codex CLI (~/.codex/config.toml):

[mcp_servers.jam-sql]
url = "http://127.0.0.1:14507/mcp"
bearer_token_env_var = "JAM_SQL_MCP_TOKEN"

Then set export JAM_SQL_MCP_TOKEN="YOUR_TOKEN_HERE" in your shell profile.

Security Model

The MCP server binds to 127.0.0.1 only (localhost). All requests require a valid Bearer token. Query execution is disabled by default; when enabled, Read-only mode enforces strict safe queries (SELECT, EXPLAIN, SHOW, PRAGMA only) and Confirm mode prompts you to approve each write query. Passwords are never exposed. Full audit logging of every tool call.

Permission Levels

Configure the AI policy in Settings to control what the MCP server can do:

  • Block (default) — No query execution; allows safe query-tab editing (open tab + set SQL text) and schema introspection
  • Read-only — Allow strict read-only queries only (SELECT, EXPLAIN, SHOW, PRAGMA — recommended)
  • Confirm — Allow write queries only after in-app approval (each write prompts you)

Write Approval Flow (Confirm Mode)

When permission level is set to Confirm, AI agents can execute write queries (INSERT, UPDATE, DELETE, etc.) but only after you approve each one in an in-app dialog:

How It Works

  1. AI agent submits a write query via query_execute
  2. Jam SQL Studio shows an approval dialog with:
    • Query type badge (INSERT, UPDATE, DELETE, etc.)
    • Full SQL preview (syntax highlighted)
    • Connection and database context
    • 60-second countdown timer
  3. You choose: Approve to execute, or Deny to block
  4. If no response within 60 seconds, the query is automatically denied
  5. Result (success/denied) is returned to the AI agent

Write Approval Guardrails

  • Timeout protection: Queries auto-deny after 60 seconds if you don't respond
  • Full audit logging: Every write attempt (approved or denied) is logged with timestamp, query, and outcome
  • Per-connection override: Set permission level per connection (e.g., read-only on production, confirm on dev)
  • No batch writes: Multi-statement queries are always rejected, even in Confirm mode

Agent Capabilities

Some MCP tools are controlled by additional toggles in Settings → AI Integrations:

  • Allow AI to connect using saved connections — Off by default (uses saved credentials)
  • Allow AI screenshots — On by default (disable if you handle sensitive data)

jam-sql CLI

Jam SQL Studio ships with a Go-based CLI tool (jam-sql) that wraps the MCP server for quick terminal access:

# Check installation and MCP status
jam-sql doctor

# List saved connections
jam-sql connections

# Execute a query
jam-sql query -c production "SELECT * FROM users LIMIT 5"

# List available MCP tools and resources
jam-sql tools
jam-sql resources

# Call any MCP tool
jam-sql call ui_open_tab '{"type": "query"}'

# Read an MCP resource
jam-sql read sql-studio://context/tabs

Which Approach Should You Use?

All three approaches complement each other:

  • Use AI Chat Sidebar for quick, conversational assistance while writing queries or building notebooks. It's the fastest way to get AI help without leaving your editor.
  • Use AI Workspace when you want to iterate on queries with AI agents using the integrated terminal + file sync workflow.
  • Use MCP Server when you're working in an external AI tool (like Claude Desktop) and need to access your database connections and execute queries from outside the app.
  • Use all three for maximum flexibility — the sidebar for quick help, AI Workspace for file-backed collaboration, MCP for external tool integration.

Ready to Work with AI?

Download Jam SQL Studio and experience AI-native database tooling.