Metadata-Version: 2.4
Name: jmd-mcp-sql
Version: 0.11.0
Summary: JMD-based MCP server for SQLite — natural language database interface
Author-email: Andreas Ostermeyer <andreas@ostermeyer.de>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/ostermeyer/jmd-spec
Project-URL: Repository, https://github.com/ostermeyer/jmd-mcp-sql
Keywords: jmd,mcp,sqlite,llm,natural-language,database
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mcp>=1.0
Requires-Dist: jmd-format>=0.4
Dynamic: license-file

# jmd-mcp-sql

MCP server that exposes a SQLite database through four JMD tools — a natural language database interface for LLM-driven workflows.

## What is JMD?

[JMD](https://github.com/ostermeyer/jmd-spec) (JSON Markdown) is a lightweight
document format that combines Markdown headings with `key: value` pairs. It is
designed as a structured data format that LLMs can read and write naturally —
without JSON brackets or SQL syntax. A heading line sets the document type and
target table; the body carries the data:

```text
# Order
id: 42
status: shipped
total: 149.99
```

A prefix on the heading selects the operation: `#` for data, `#?` for queries,
`#!` for schema, `#-` for deletes. See the
[JMD specification](https://github.com/ostermeyer/jmd-spec) for the full format
definition.

## Tools

| Tool | `#` Data | `#?` Query | `#!` Schema | `#-` Delete |
| --- | --- | --- | --- | --- |
| `open` | Open database / show status | — | — | — |
| `read` | SELECT by fields | SELECT with filters + aggregation | PRAGMA (describe table) | — |
| `write` | INSERT OR REPLACE | — | CREATE / ALTER TABLE | — |
| `delete` | — | — | DROP TABLE | DELETE WHERE |

All inputs and outputs are JMD documents. The LLM speaks JMD — no SQL required.

## Installation

Install from PyPI:

```bash
pip install jmd-mcp-sql
```

Or with [uv](https://docs.astral.sh/uv/) (no manual install needed — `uvx` fetches it on demand):

```bash
uvx jmd-mcp-sql
```

Alternatively, install directly from GitHub:

```bash
pip install git+https://github.com/ostermeyer/jmd-mcp-sql.git
```

## Configuration

The server runs as a **stdio-based MCP server**. Without arguments it starts with
the bundled Northwind demo database. Pass a path to use your own SQLite file:

```bash
jmd-mcp-sql /path/to/your.db
```

The demo database ships as `northwind.sql` (plain text, version-controlled). On the
first run without an explicit path, the server creates `northwind.db` from that dump
automatically.

### Claude Code

Add the server via CLI:

```bash
claude mcp add --transport stdio sql -- uvx jmd-mcp-sql
```

With a custom database:

```bash
claude mcp add --transport stdio sql -- uvx jmd-mcp-sql /path/to/your.db
```

This writes a `.mcp.json` in the project root (shareable via version control).
You can also create it manually:

```json
{
  "mcpServers": {
    "sql": {
      "command": "uvx",
      "args": ["jmd-mcp-sql"]
    }
  }
}
```

### Claude Desktop / Cowork

Claude Cowork runs inside Claude Desktop. MCP servers configured in the Desktop
config are automatically available in Cowork sessions.

Edit `claude_desktop_config.json`:

- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`

```json
{
  "mcpServers": {
    "sql": {
      "command": "uvx",
      "args": ["jmd-mcp-sql"]
    }
  }
}
```

With a custom database:

```json
{
  "mcpServers": {
    "sql": {
      "command": "uvx",
      "args": ["jmd-mcp-sql", "/path/to/your.db"]
    }
  }
}
```

Restart Claude Desktop after saving the file. The server will appear as a tool
in both Chat and Cowork mode.

### VS Code

Create `.vscode/mcp.json` in the project root:

```json
{
  "servers": {
    "sql": {
      "type": "stdio",
      "command": "uvx",
      "args": ["jmd-mcp-sql"]
    }
  }
}
```

Alternatively, add it to your VS Code `settings.json` (user or workspace):

```json
{
  "mcp": {
    "servers": {
      "sql": {
        "type": "stdio",
        "command": "uvx",
        "args": ["jmd-mcp-sql"]
      }
    }
  }
}
```

## JMD Document Syntax

Every document starts with a heading line that sets the document type and table name,
followed by `key: value` pairs (one per line):

```text
# Product          → data document   (exact lookup / insert-or-replace)
#? Product         → query document  (filter / list / aggregate)
#! Product         → schema document (describe / create / drop table)
#- Product         → delete document (delete matching records)

key: value         → string, integer, or float — inferred automatically
key: true/false    → boolean
```

## Opening a Database

Open a different SQLite database at any time:

```text
open("# Database\npath: /path/to/mydb.db")
```

If the file does not exist, a new empty database is created. The previous
database is closed automatically. The response uses frontmatter for metadata
and lists tables in the body:

```text
path: /path/to/mydb.db
table-count: 3

# Database
## tables[]
- Customers
- Orders
- Products
```

Check which database is currently active:

```text
open("# Database")
```

## Path Restriction

The server reads optional settings from `~/.config/jmd/sql.jmd`:

```text
# Config
root: /Users/me/data
```

| Field | Default | Description |
| --- | --- | --- |
| `root` | *(none)* | Restricts `open` to databases under this directory tree |

Without a config file, no restrictions apply and the server accepts any path.

## Discovering the Database

To see which tables exist, read each table's schema:

```text
read("#! Customers")
```

This returns a `#!` document with column names, JMD types, and modifiers
(`readonly` = primary key, `optional` = nullable).

## Typical Workflows

**List all rows** (small tables only):

```text
read("#? Orders")
```

**Filter rows — equality:**

```text
read("#? Orders\nstatus: shipped")
```

**Filter rows — comparison:**

```text
read("#? Orders\nFreight: > 50")
```

**Filter rows — alternation (OR):**

```text
read("#? Orders\nShipCountry: Germany|France|UK")
```

**Filter rows — contains (case-insensitive substring):**

```text
read("#? Customers\nCompanyName: ~Corp")
```

**Filter rows — regex pattern:**

```text
read("#? Products\nProductName: ^Chai.*")
```

**Filter rows — negation** (composes with any operator):

```text
read("#? Orders\nShipCountry: !Germany")
read("#? Products\nProductName: !^LEGACY.*")
```

**Look up one record:**

```text
read("# Customers\nid: 42")
```

**Insert or replace a record:**

```text
write("# Orders\nid: 1\nstatus: pending\ntotal: 99.90")
```

**Create a table:**

```text
write("#! Products\nid: integer readonly\nname: string\nprice: float optional")
```

**Delete a record:**

```text
delete("#- Orders\nid: 1")
```

**Drop a table:**

```text
delete("#! OldTable")
```

## Pagination

Always use pagination when querying tables that may contain many rows.

Use frontmatter fields before the `#?` heading to control pagination:

```text
read("page-size: 50\npage: 1\n\n#? Orders")
```

The response carries pagination metadata as **frontmatter** — before the root heading:

```text
total: 830
page: 1
pages: 17
page-size: 50

# Orders
## data[]
- OrderID: 10248
  ...
```

**Count only** (no rows returned):

```text
read("count: true\n\n#? Orders")
```

Returns:

```text
count: 830

# Orders
```

Use `total` and `pages` to determine whether to fetch more pages.
For tables with fewer than ~20 rows pagination is optional.

## Field Projection

Use `select:` frontmatter to return only specific columns. This keeps
responses small and context windows focused.

```text
read("select: OrderID, EmployeeID\npage-size: 50\n\n#? Orders")
```

Works with both `#` (data) and `#?` (query) documents. When combined with
aggregation, `select:` filters the result columns after the GROUP BY.

## Joins

Use `join:` frontmatter to query across multiple tables in one call.
The value is `<TableName> on <JoinColumn>` (INNER JOIN, equi-join on a
column that exists in both tables).

```text
read("join: Order Details on OrderID\nsum: UnitPrice * Quantity * (1 - Discount) as revenue\ngroup: EmployeeID\nsort: revenue desc\n\n#? Orders")
```

**Multiple joins** — comma-separated in a single `join:` value:

```text
join: Order Details on OrderID, Employees on EmployeeID
```

**Expression syntax** — use `<expression> as <alias>` in aggregate functions
to compute derived values across joined columns:

```text
sum: UnitPrice * Quantity * (1 - Discount) as revenue
```

The alias becomes the result column name. Without `as`, the default alias
`<func>_<field>` applies (e.g. `sum_Freight`).

Allowed in expressions: column names, numeric literals, arithmetic operators
(`+`, `-`, `*`, `/`), and standard SQL functions (`SUM`, `AVG`, `ROUND`, …).
Subqueries and SQL keywords are not permitted.

**Projection rules for join queries:**

- Unambiguous columns (appear in exactly one table) resolve automatically.
- Join key columns always resolve to the main table.
- Columns present in multiple tables (other than join keys) require explicit
  qualification — specify them via `select:` or filter on the unambiguous side.

## Aggregation

Aggregation is expressed as **frontmatter** before the `#?` heading.
QBE filter fields narrow rows *before* aggregation (SQL WHERE).
The `having:` key filters *after* aggregation (SQL HAVING).

| Key | SQL | Result column name |
| --- | --- | --- |
| `group: f1, f2` | GROUP BY | grouping keys pass through unchanged |
| `sum: field` | SUM(field) | `sum_field` |
| `avg: field` | AVG(field) | `avg_field` |
| `min: field` | MIN(field) | `min_field` |
| `max: field` | MAX(field) | `max_field` |
| `count` | COUNT(*) | `count` |

Multiple fields per function: `sum: Freight, Total` → `sum_Freight` and `sum_Total`.

| Frontmatter | Meaning |
| --- | --- |
| `sort: sum_revenue desc, EmployeeID asc` | ORDER BY (multiple columns, mixed) |
| `having: count > 5` | HAVING COUNT(*) > 5 |
| `having: sum_Freight > 1000, count > 2` | HAVING … AND … (comma = AND) |

`having:` supports: `>`, `>=`, `<`, `<=`, `=`.
`sort:` references any result column — grouping keys or aggregate aliases.
`page-size:` and `page:` apply to the aggregated result set.

**Example — top 3 employees by revenue:**

```text
read("group: EmployeeID\nsum: revenue\nsort: sum_revenue desc\npage-size: 3\n\n#? OrderDetails")
```

## Error Handling

All tools return a `# Error` document on failure:

```text
# Error
status: 400
code: not_found
message: No records found in Orders
```

Check the `code` field to decide how to proceed.

## Specification

The JMD format is documented at [jmd-spec](https://github.com/ostermeyer/jmd-spec).

## License

Copyright © 2026 Andreas Ostermeyer.

Licensed under the Apache License, Version 2.0 — see [LICENSE](LICENSE).
The JMD ecosystem is open: the specification is CC BY 4.0, the Python and
JavaScript reference implementations are Apache 2.0, and this server matches.
No copyleft, no dual licensing, no CLA. Use it, fork it, extend it, ship it —
attribution preserved per Apache 2.0 § 4.

### License history

This project has changed license twice during its early development:

- **0.4 – 0.7.1** (MIT, yanked from PyPI as the default install target)
- **0.8.0 – 0.9.x** (AGPL-3.0, reflecting a brief period in which a commercial
  deployment path was under consideration)
- **0.10.0 and later** (Apache 2.0, aligned with the rest of the JMD ecosystem)

Users who installed any of the prior versions retain the rights those licenses
granted for those specific artifacts. License changes are not retroactive.
See [CHANGELOG.md](CHANGELOG.md) for the rationale.
