@shyzus/mcp-geocrafter 1.0.5 → 1.2.3

package/README.md

@@ -2,13 +2,13 @@
 
 GeoCrafter is a clean, modular MCP server for geocoding and reverse geocoding - Powered by Nominatim API (OpenStreetMap).
 
-[![Deploy Status](https://github.com/Shyzkanza/mcp-location/actions/workflows/deploy.yml/badge.svg)](https://github.com/Shyzkanza/mcp-location/actions/workflows/deploy.yml)
-[![npm version](https://img.shields.io/badge/npm-v1.0.5-blue)](https://www.npmjs.com/package/@shyzus/mcp-geocrafter)
+[![CI](https://github.com/Shyzkanza/mcp-location/actions/workflows/ci.yml/badge.svg)](https://github.com/Shyzkanza/mcp-location/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@shyzus/mcp-geocrafter)](https://www.npmjs.com/package/@shyzus/mcp-geocrafter)
 [![npm downloads](https://img.shields.io/npm/dm/@shyzus/mcp-geocrafter?cacheSeconds=3600)](https://www.npmjs.com/package/@shyzus/mcp-geocrafter)
 [![Website Status](https://img.shields.io/website?url=https%3A%2F%2Fgeocrafter.rankorr.red%2Fhealth&label=API)](https://geocrafter.rankorr.red/health)
-![Node](https://img.shields.io/badge/node-18%2B-green)
+![Node](https://img.shields.io/badge/node-20%2B-green)
 ![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue)
-![MCP](https://img.shields.io/badge/MCP-2025--06--18-orange)
+![MCP](https://img.shields.io/badge/MCP-2025--11--25-orange)
 ![ChatGPT](https://img.shields.io/badge/ChatGPT-Apps%20SDK-purple)
 
 ---
@@ -161,9 +161,24 @@ npx @modelcontextprotocol/inspector node dist/index.js
 
 ---
 
-## 📱 Deployment and Development
+## 🧪 Tests
+
+```bash
+# Run tests
+npm test
 
-> **🔒 CI/CD secrets configuration:** To automatically deploy to a VPS with GitHub Actions and Portainer, see [SECRETS.md](SECRETS.md) for GitHub secrets configuration.
+# Watch mode
+npm run test:watch
+```
+
+63 tests across 3 suites:
+- `errors.test.ts` — Error classes, formatting, network detection (17 tests)
+- `config.test.ts` — Environment variables, validation, singleton (20 tests)
+- `displayGeoJsonMap.test.ts` — GeoJSON parsing, viewport, colors, output (26 tests)
+
+---
+
+## 📱 Deployment and Development
 
 > **💡 To use the application in ChatGPT**, see the [🚀 Quick Start](#-quick-start) section above for complete instructions.
 
@@ -209,71 +224,28 @@ Follow the configuration instructions in the [🚀 Quick Start](#-quick-start) s
 
 > **Note**: If you just want to use the application, see the [🚀 Quick Start](#-quick-start) section which uses the production server already available.
 
-This project includes a GitHub Actions workflow that automatically deploys to a VPS with Docker and Portainer.
-
-#### **VPS Deployment with GitHub Actions**
-
-1. **Configure GitHub secrets** according to [SECRETS.md](SECRETS.md)
-2. **Push to the `main` branch**
-3. GitHub Actions will automatically:
-   - ✅ Test TypeScript code
-   - ✅ Deploy to your VPS via Portainer
-   - ✅ Publish to npm (if version not already published)
-   - ✅ Check health status
+#### **CI/CD Pipelines**
 
-#### **Version Management & Git Tags**
+Two GitHub Actions workflows:
 
-**⚠️ IMPORTANT : Avant chaque publication npm, créer un tag Git !**
+- **`ci.yml`** — Runs on push/PR to `main`: type check, tests, build
+- **`release.yml`** — Runs on tag push (`*.*.*`): tests → GHCR image → Docker Swarm deploy → health check → npm publish
 
-**Format des tags** : `{MAJOR}.{MINOR}.{PATCH}` (sans préfixe "v")
-- Exemples : `1.0.0`, `1.0.1`, `1.1.0`, `2.0.0`
+#### **Release Process**
 
-**Processus de release** :
-
-1. **Incrémenter la version** dans `package.json` :
-   ```bash
-   npm version patch   # 1.0.0 → 1.0.1
-   npm version minor   # 1.0.0 → 1.1.0
-   npm version major   # 1.0.0 → 2.0.0
-   ```
-
-2. **Créer le tag Git** correspondant :
-   ```bash
-   VERSION=$(node -p "require('./package.json').version")
-   git tag -a "$VERSION" -m "Release $VERSION - {description}"
-   ```
-
-3. **Commit et push** (y compris les tags) :
-   ```bash
-   git add package.json
-   git commit -m "chore: bump version to $VERSION"
-   git push origin main
-   git push origin --tags
-   ```
-
-4. **Le workflow GitHub Actions** publiera automatiquement sur npm si la version n'existe pas déjà.
-
-**Branches** :
-- **`main`** : Production (protégée, déploiement automatique)
-- **`develop`** : Développement (branche de travail principale)
-
-Voir [CONTEXT.md](CONTEXT.md) pour plus de détails sur le workflow de développement.
-
-**Benefits**:
-- Automatic deployment on each push
-- Free SSL with Traefik + Let's Encrypt
-- Integrated health monitoring
-- Centralized logs
-
-#### **Other cloud platforms**
+```bash
+# 1. Bump version
+npm version patch   # 1.0.5 → 1.0.6
 
-You can also deploy on:
-- **Railway** - Automatic deployment from GitHub
-- **Render** - Managed service with free SSL
-- **Fly.io** - Edge computing with global deployment
-- **Google Cloud Run** - Serverless with automatic scaling
+# 2. Push with tags
+git push origin main --tags
+```
 
-See the [Apps SDK deployment guide](https://developers.openai.com/apps-sdk/deploy) for more details.
+The tag push triggers `release.yml` which automatically:
+- Builds & pushes the Docker image to GHCR
+- Deploys to VPS via SSH + `docker stack deploy`
+- Runs health check
+- Publishes to npm (if version not already published)
 
 #### **Configure your server in ChatGPT**
 
@@ -376,31 +348,39 @@ Opens a web interface to test all tools.
 ```
 mcp-location/
 ├── src/
-│   ├── config.ts              # Configuration centralisée
-│   ├── types.ts               # Types TypeScript partagés
+│   ├── config.ts                # Configuration centralisée
+│   ├── types.ts                 # Types TypeScript partagés
+│   ├── __tests__/
+│   │   └── config.test.ts       # Tests config
 │   ├── client/
-│   │   └── nominatimClient.ts # Client API Nominatim
+│   │   └── nominatimClient.ts   # Client API Nominatim
 │   ├── tools/
-│   │   ├── searchAddress.ts   # Tool: adresse → GPS
-│   │   ├── reverseGeocode.ts  # Tool: GPS → adresse
-│   │   └── displayGeoJsonMap.ts # Tool: GeoJSON → widget UI
+│   │   ├── searchAddress.ts     # Tool: adresse → GPS
+│   │   ├── reverseGeocode.ts    # Tool: GPS → adresse
+│   │   ├── displayGeoJsonMap.ts # Tool: GeoJSON → widget UI
+│   │   └── __tests__/
+│   │       └── displayGeoJsonMap.test.ts
 │   ├── resources/
-│   │   └── mapViewerTemplate.ts # Template HTML (text/html+skybridge) pour ChatGPT
+│   │   └── mapViewerTemplate.ts # Template HTML pour ChatGPT
 │   ├── servers/
-│   │   ├── stdio.ts           # Serveur stdio (IDEs)
-│   │   └── http.ts             # Serveur Streamable HTTP (ChatGPT)
+│   │   ├── stdio.ts             # Serveur stdio (IDEs)
+│   │   └── http.ts              # Serveur Streamable HTTP (ChatGPT)
 │   ├── utils/
-│   │   └── errors.ts           # Gestion erreurs centralisée
-│   ├── index.ts                # Entry point stdio
-│   ├── http-server.ts          # Entry point HTTP
-│   └── http-client.ts          # Client npm
-├── dist/                       # Compiled code (generated)
-├── Dockerfile                  # Multi-stage Docker image
-├── docker-compose.yml          # Stack with Traefik labels
-├── .github/workflows/deploy.yml # CI/CD pipeline
-├── package.json                # Server dependencies
-├── tsconfig.json               # TypeScript config
-└── README.md                   # This file
+│   │   ├── errors.ts            # Gestion erreurs centralisée
+│   │   └── __tests__/
+│   │       └── errors.test.ts
+│   ├── index.ts                 # Entry point stdio
+│   ├── http-server.ts           # Entry point HTTP
+│   └── http-client.ts           # Client npm
+├── .github/workflows/
+│   ├── ci.yml                   # CI: tests on push/PR
+│   └── release.yml              # Release: GHCR + deploy + npm
+├── Dockerfile                   # Multi-stage Docker (node:20-alpine)
+├── docker-compose.yml           # Docker Swarm stack
+├── vitest.config.ts             # Vitest configuration
+├── package.json
+├── tsconfig.json
+└── README.md
 ```
 
 ---
@@ -514,7 +494,7 @@ See [CONTEXT.md](CONTEXT.md) for detailed architecture documentation.
 
 ```bash
 # Check that Node.js is installed
-node --version  # Must be 18+
+node --version  # Must be 20+
 
 # Check that dependencies are installed
 npm install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shyzus/mcp-geocrafter",
-  "version": "1.0.5",
+  "version": "1.2.3",
   "description": "GeoCrafter - MCP server for geocoding and reverse geocoding - Powered by Nominatim API",
   "type": "module",
   "main": "dist/index.js",
@@ -11,11 +11,22 @@
     "dist/http-client.js",
     "README.md"
   ],
-  "keywords": ["mcp", "geocoding", "nominatim", "location", "address", "gps", "chatgpt"],
+  "keywords": [
+    "mcp",
+    "geocoding",
+    "nominatim",
+    "location",
+    "address",
+    "gps",
+    "chatgpt"
+  ],
   "author": "Rankorr",
   "license": "MIT",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
+  },
+  "volta": {
+    "node": "20.19.5"
   },
   "repository": {
     "type": "git",
@@ -37,16 +48,18 @@
     "tunnel": "ngrok http ${PORT:-3000}",
     "inspect": "npx @modelcontextprotocol/inspector@latest http://localhost:${PORT:-3000}/mcp",
     "health": "curl -s http://localhost:${PORT:-3000}/health | jq .",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "prepare": "npm run build"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.23.0"
+    "@modelcontextprotocol/sdk": "^1.27.1"
   },
   "devDependencies": {
     "@types/node": "^20.10.0",
     "npm-run-all": "^4.1.5",
     "tsx": "^4.7.0",
-    "typescript": "^5.3.0"
+    "typescript": "^5.3.0",
+    "vitest": "^4.0.18"
   }
 }
-