@shibbirweb/mcp-db-read-only 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -6,6 +6,14 @@ Each release is published to npm and Docker Hub from the same tag. Where a versi
 
 ## [Unreleased]
 
+## [1.1.0]
+
+Not yet published to npm, Docker Hub or the MCP Registry.
+
+### Added
+
+- The log viewer's footer links to the GitHub repository, to star it, and to its issues page, to request a feature or report a problem. The links open in a new tab and send no referrer; the page still loads nothing from outside the viewer.
+
 ## [1.0.0]
 
 First stable release. Not yet published to npm, Docker Hub or the MCP Registry.

package/README.dockerhub.md

@@ -10,7 +10,9 @@
 
 [![CI](https://github.com/shibbirweb/mcp-db-read-only/actions/workflows/ci.yml/badge.svg)](https://github.com/shibbirweb/mcp-db-read-only/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/%40shibbirweb%2Fmcp-db-read-only?label=npm&color=cb3837)](https://www.npmjs.com/package/@shibbirweb/mcp-db-read-only)
+[![npm downloads](https://img.shields.io/npm/dm/%40shibbirweb%2Fmcp-db-read-only?style=flat&label=npm%20downloads)](https://www.npmjs.com/package/@shibbirweb/mcp-db-read-only)
 [![Docker Hub](https://img.shields.io/docker/v/shibbirweb/mcp-db-read-only?label=docker%20hub&sort=semver)](https://hub.docker.com/r/shibbirweb/mcp-db-read-only)
+[![Docker pulls](https://img.shields.io/docker/pulls/shibbirweb/mcp-db-read-only?style=flat)](https://hub.docker.com/r/shibbirweb/mcp-db-read-only)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/shibbirweb/mcp-db-read-only/blob/master/LICENSE)
 
 Let your AI assistant **look at your databases without being able to change them.**
@@ -22,13 +24,18 @@ Point it at MySQL, PostgreSQL, SQLite, SQL Server, ClickHouse, MongoDB, Redis or
 - **No restart to switch.** Change database, server or engine by asking.
 - **Optional logging**, with a live page in your browser that shows every query as it happens.
 
+```text
+You  --ask in plain words-->  Your AI assistant  --tool call-->  mcp-db-read-only  --read-only query-->  Your databases
+                                                                  mcp-db-read-only  <--rows, documents, keys--
+```
+
 Works with Claude Desktop, Claude Code, and any other [MCP](https://modelcontextprotocol.io) client.
 
 **Source and full documentation: [github.com/shibbirweb/mcp-db-read-only](https://github.com/shibbirweb/mcp-db-read-only)**
 
 ## Supported tags
 
-`1.0.0`, `1.0`, `1`, `latest`, built for `linux/amd64` and `linux/arm64`.
+`1.1.0`, `1.1`, `1`, `latest`, built for `linux/amd64` and `linux/arm64`.
 
 ---
 
@@ -264,6 +271,17 @@ Inside Docker, use `host.docker.internal` instead of `localhost` to reach a data
 
 Turn on logging to keep a record of every query the assistant runs, and see them live in your browser.
 
+```text
+The assistant writes a query
+             |
+             v
+1. Checked by this server: only a read?
+     no  -->  Refused, with the reason
+     yes -->  2. Sent to the database in read-only mode
+                   a read                         -->  The answer
+                   a write that slipped through   -->  Refused by the database
+```
+
 **1. Save logs to a folder** by adding this to the server's `env`:
 
 ```json
@@ -290,6 +308,11 @@ Passwords are never written to the logs. More in the [Logging guide](https://git
 
 Yes, in two independent ways, so a mistake in one is caught by the other:
 
+```text
+mcp-db-read-only  --one file per call-->  Log folder (DB_LOG_DIR)  -->  viewer command  --live-->  Your browser
+(in your AI client)                                                     (in a terminal)
+```
+
 1. **Before anything is sent**, every query is checked. Only reads are allowed: `SELECT` and friends for SQL, read commands for Redis, searches for Elasticsearch, and no `$out` or `$merge` for MongoDB.
 2. **The database is told to refuse writes too**, wherever it supports that: read-only sessions on MySQL, read-only transactions on PostgreSQL, a read-only file on SQLite, and so on.
 

package/README.md

@@ -2,7 +2,9 @@
 
 [![CI](https://github.com/shibbirweb/mcp-db-read-only/actions/workflows/ci.yml/badge.svg)](https://github.com/shibbirweb/mcp-db-read-only/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/%40shibbirweb%2Fmcp-db-read-only?label=npm&color=cb3837)](https://www.npmjs.com/package/@shibbirweb/mcp-db-read-only)
+[![npm downloads](https://img.shields.io/npm/dm/%40shibbirweb%2Fmcp-db-read-only?style=flat&label=npm%20downloads)](https://www.npmjs.com/package/@shibbirweb/mcp-db-read-only)
 [![Docker Hub](https://img.shields.io/docker/v/shibbirweb/mcp-db-read-only?label=docker%20hub&sort=semver)](https://hub.docker.com/r/shibbirweb/mcp-db-read-only)
+[![Docker pulls](https://img.shields.io/docker/pulls/shibbirweb/mcp-db-read-only?style=flat)](https://hub.docker.com/r/shibbirweb/mcp-db-read-only)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
 Let your AI assistant **look at your databases without being able to change them.**
@@ -14,6 +16,14 @@ Point it at MySQL, PostgreSQL, SQLite, SQL Server, ClickHouse, MongoDB, Redis or
 - **No restart to switch.** Change database, server or engine by asking.
 - **Optional logging**, with a live page in your browser that shows every query as it happens.
 
+```mermaid
+flowchart LR
+    Y["You"] -->|"ask in plain words"| AI["Your AI assistant"]
+    AI -->|"tool call"| S["mcp-db-read-only"]
+    S -->|"read-only query"| DB[("Your databases")]
+    DB -->|"rows, documents, keys"| S
+```
+
 Works with Claude Desktop, Claude Code, and any other [MCP](https://modelcontextprotocol.io) client.
 
 ---
@@ -250,6 +260,13 @@ Inside Docker, use `host.docker.internal` instead of `localhost` to reach a data
 
 Turn on logging to keep a record of every query the assistant runs, and see them live in your browser.
 
+```mermaid
+flowchart LR
+    S["mcp-db-read-only<br/>(in your AI client)"] -->|"one file per call"| F[("Log folder<br/>DB_LOG_DIR")]
+    F --> V["viewer command<br/>(in a terminal)"]
+    V -->|"live"| B["Your browser"]
+```
+
 **1. Save logs to a folder** by adding this to the server's `env`:
 
 ```json
@@ -276,6 +293,15 @@ Passwords are never written to the logs. More in the [Logging guide](https://git
 
 Yes, in two independent ways, so a mistake in one is caught by the other:
 
+```mermaid
+flowchart LR
+    Q["The assistant<br/>writes a query"] --> C{"1. Checked by<br/>this server:<br/>only a read?"}
+    C -->|"no"| R1["Refused,<br/>with the reason"]
+    C -->|"yes"| D["2. Sent to the database<br/>in read-only mode"]
+    D -->|"a read"| A["The answer"]
+    D -->|"a write that<br/>slipped through"| R2["Refused by<br/>the database"]
+```
+
 1. **Before anything is sent**, every query is checked. Only reads are allowed: `SELECT` and friends for SQL, read commands for Redis, searches for Elasticsearch, and no `$out` or `$merge` for MongoDB.
 2. **The database is told to refuse writes too**, wherever it supports that: read-only sessions on MySQL, read-only transactions on PostgreSQL, a read-only file on SQLite, and so on.
 

package/dist/logging/viewer/ViewerAssets.js

@@ -55,6 +55,16 @@ const HTML = `<!doctype html>
   <div id="entries"></div>
   <nav class="pager" id="pager-bottom"></nav>
 </main>
+<footer>
+  <a class="star" href="https://github.com/shibbirweb/mcp-db-read-only" target="_blank" rel="noopener noreferrer">
+    <svg viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"><path d="M8 .25a.75.75 0 0 1 .673.418l1.882 3.815 4.21.612a.75.75 0 0 1 .416 1.279l-3.046 2.97.719 4.192a.75.75 0 0 1-1.088.791L8 12.347l-3.766 1.98a.75.75 0 0 1-1.088-.79l.72-4.194L.818 6.374a.75.75 0 0 1 .416-1.28l4.21-.611L7.327.668A.75.75 0 0 1 8 .25Z"/></svg>
+    Star mcp-db-read-only on GitHub
+  </a>
+  <a class="issue" href="https://github.com/shibbirweb/mcp-db-read-only/issues" target="_blank" rel="noopener noreferrer">
+    <svg viewBox="0 0 16 16" width="14" height="14" aria-hidden="true"><path d="M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"/><path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Z"/></svg>
+    Request a feature or report an issue
+  </a>
+</footer>
 </body>
 </html>
 `;
@@ -203,6 +213,22 @@ pre {
 .pager button[disabled] { opacity: .4; cursor: default; }
 .pager button.current { background: var(--accent); border-color: var(--accent); color: #fff; }
 .pager select { padding: 3px 8px; }
+footer { display: flex; flex-wrap: wrap; justify-content: center; gap: 10px; padding: 0 20px 28px; }
+footer a {
+  display: inline-flex;
+  align-items: center;
+  gap: 6px;
+  padding: 5px 12px;
+  border: 1px solid var(--border);
+  border-radius: 999px;
+  background: var(--panel);
+  color: var(--muted);
+  font-size: 13px;
+  text-decoration: none;
+}
+footer a svg { fill: currentColor; }
+.star:hover { color: var(--warn); border-color: var(--warn); }
+.issue:hover { color: var(--accent); border-color: var(--accent); }
 .banner {
   display: block;
   width: 100%;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shibbirweb/mcp-db-read-only",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A read-only MCP server for MySQL, MariaDB, PostgreSQL, SQLite, SQL Server, ClickHouse, MongoDB, Redis and Elasticsearch, with connections switchable at runtime.",
   "license": "MIT",
   "author": "Md. Shibbir Ahmed <shibbirweb@gmail.com>",