ajan-sql 0.1.0 → 0.1.2

package/README.md

@@ -1,14 +1,42 @@
-# ajan-sql
-
-AI-safe MCP server for schema-aware, read-only SQL access.
+<p align="center">
+  <img src="./assets/cover.svg" alt="ajan-sql cover" width="860" />
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/ajan-sql">
+    <img src="https://img.shields.io/npm/v/ajan-sql" alt="npm version" />
+  </a>
+  <a href="https://www.npmjs.com/package/ajan-sql">
+    <img src="https://img.shields.io/npm/dm/ajan-sql" alt="npm downloads" />
+  </a>
+  <a href="https://github.com/borakilicoglu/ajan-sql/releases">
+    <img src="https://img.shields.io/github/v/release/borakilicoglu/ajan-sql" alt="github release" />
+  </a>
+  <a href="https://borakilicoglu.github.io/ajan-sql/">
+    <img src="https://img.shields.io/badge/docs-vitepress-5d98ea" alt="docs" />
+  </a>
+  <a href="./LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-lightgrey" alt="license" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/borakilicoglu/ajan-sql">GitHub Repository</a>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/ajan-sql">npm Package</a>
+</p>
+
+<p align="center">
+  AI-safe MCP server for schema-aware, read-only SQL access.
+</p>
 
 ## Overview
 
 `ajan-sql` is an npm package for running an MCP server over stdio with a PostgreSQL backend.
 
-The project is designed as:
-
-> psql + schema awareness + AI-safe guard layer
+`ajan-sql` provides schema-aware, read-only PostgreSQL access for MCP and AI workflows.
 
 ## Goals
 
@@ -52,12 +80,37 @@ These rules should never be bypassed.
 - `explain_query`
 - `sample_rows`
 
+## Tool Matrix
+
+| Tool | Purpose | Inputs | Guarded |
+| --- | --- | --- | --- |
+| `list_tables` | List visible database tables | None | N/A |
+| `describe_table` | Describe columns and types for one table | `name`, optional `schema` | N/A |
+| `list_relationships` | List foreign key relationships | None | N/A |
+| `run_readonly_query` | Execute a readonly `SELECT` query | `sql` | Yes |
+| `explain_query` | Return JSON execution plan for a readonly query | `sql` | Yes |
+| `sample_rows` | Return a limited sample from a table | `name`, optional `schema`, optional `limit` | Yes |
+
 ## Available MCP Resources
 
 - `schema://snapshot`
 - `schema://table/{name}`
 
-## Local Usage
+## Install
+
+Install the CLI globally from npm:
+
+```bash
+npm install -g ajan-sql
+```
+
+Run it with a PostgreSQL connection string:
+
+```bash
+DATABASE_URL=postgres://USER:PASSWORD@HOST:PORT/DB ajan-sql
+```
+
+## Local Development
 
 Start the server with a PostgreSQL connection string:
 
@@ -74,7 +127,22 @@ DATABASE_URL=postgres://USER:PASSWORD@HOST:PORT/DB npm start
 
 ## Client Configuration
 
-For MCP clients that launch local stdio servers, point the command to the built CLI and provide `DATABASE_URL`:
+For MCP clients that launch globally installed stdio servers:
+
+```json
+{
+  "mcpServers": {
+    "ajan-sql": {
+      "command": "ajan-sql",
+      "env": {
+        "DATABASE_URL": "postgres://USER:PASSWORD@HOST:PORT/DB"
+      }
+    }
+  }
+}
+```
+
+For repository-local development builds, point the command to the built CLI and provide `DATABASE_URL`:
 
 ```json
 {
@@ -94,6 +162,13 @@ For MCP clients that launch local stdio servers, point the command to the built
 
 The repository supports local PostgreSQL integration testing during development, but any Docker compose files or seeded local test databases can remain untracked and machine-local.
 
+## Project Docs
+
+- [Changelog](./CHANGELOG.md)
+- [Roadmap](./ROADMAP.md)
+- [Contributing](./CONTRIBUTING.md)
+- [Security Policy](./SECURITY.md)
+
 ## Development Principles
 
 - Keep functions small and composable
@@ -114,7 +189,7 @@ The CLI will:
 
 ## Status
 
-Early development. Schema inspection, readonly query execution, query explain, and sample row tools are implemented. The CLI is publish-ready for npm packaging, and current package version is `0.1.0`.
+Early development. Schema inspection, readonly query execution, query explain, and sample row tools are implemented. The CLI is published on npm, and current package version is `0.1.1`.
 
 ## License
 

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "ajan-sql",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "AI-safe MCP server for schema-aware, read-only SQL access.",
   "bin": {
-    "ajan-sql": "./dist/index.js"
+    "ajan-sql": "dist/index.js"
   },
   "files": [
     "dist",
@@ -34,6 +34,14 @@
   ],
   "author": "Bora Kilicoglu",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/borakilicoglu/ajan-sql"
+  },
+  "homepage": "https://github.com/borakilicoglu/ajan-sql#readme",
+  "bugs": {
+    "url": "https://github.com/borakilicoglu/ajan-sql/issues"
+  },
   "type": "commonjs",
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.18.0",