@shyzus/mcp-geocrafter 1.2.3 → 1.3.0

package/README.md

@@ -1,6 +1,6 @@
 # 🗺️ GeoCrafter - Geocoding Server for ChatGPT
 
-GeoCrafter is a clean, modular MCP server for geocoding and reverse geocoding - Powered by Nominatim API (OpenStreetMap).
+GeoCrafter is a clean, modular MCP server for geocoding and reverse geocoding - Powered by Photon API (OpenStreetMap + Elasticsearch) with fuzzy matching support.
 
 [![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)
@@ -17,12 +17,12 @@ GeoCrafter is a clean, modular MCP server for geocoding and reverse geocoding -
 
 **This project is independent and unofficial.**
 
-- ❌ **Not affiliated** with OpenStreetMap or Nominatim
+- ❌ **Not affiliated** with OpenStreetMap, Photon or Komoot
 - ❌ **Not sponsored** by these organizations
-- ✅ Uses **public data** from the [Nominatim API](https://nominatim.openstreetmap.org/)
+- ✅ Uses **public data** from the [Photon API](https://photon.komoot.io/) (OpenStreetMap)
 - ✅ Educational and practical purpose project
 
-Geocoding data comes from the Nominatim API, which uses OpenStreetMap data.
+Geocoding data comes from the Photon API (by Komoot), which uses OpenStreetMap data with Elasticsearch-powered fuzzy matching.
 
 ---
 
@@ -64,13 +64,13 @@ ChatGPT will use the MCP server to get the information.
 
 ```
 ┌─────────────┐         ┌──────────────┐         ┌──────────────┐
-│   ChatGPT   │ ◄─────► │  MCP Server  │ ◄─────► │  Nominatim   │
-│             │  HTTP   │  (Node.js)   │  HTTP   │  API         │
+│   ChatGPT   │ ◄─────► │  MCP Server  │ ◄─────► │   Photon     │
+│             │  HTTP   │  (Node.js)   │  HTTP   │   API        │
 └─────────────┘         └──────────────┘         └──────────────┘
 ```
 
 1. **ChatGPT** calls your MCP server via the [Model Context Protocol](https://modelcontextprotocol.io/)
-2. **The MCP server** fetches data from the Nominatim API
+2. **The MCP server** fetches data from the Photon API (OpenStreetMap + Elasticsearch)
 3. **The results** are returned to ChatGPT
 
 ### MCP Protocol
@@ -353,7 +353,7 @@ mcp-location/
 │   ├── __tests__/
 │   │   └── config.test.ts       # Tests config
 │   ├── client/
-│   │   └── nominatimClient.ts   # Client API Nominatim
+│   │   └── photonClient.ts      # Client API Photon (fuzzy matching)
 │   ├── tools/
 │   │   ├── searchAddress.ts     # Tool: adresse → GPS
 │   │   ├── reverseGeocode.ts    # Tool: GPS → adresse
@@ -435,16 +435,16 @@ Create a `.env` file:
 ```bash
 PORT=3000                          # HTTP server port
 NODE_ENV=production                # Environment
-NOMINATIM_BASE_URL=https://nominatim.openstreetmap.org  # Optional
-NOMINATIM_USER_AGENT=MyApp/1.0    # Optional (recommended by Nominatim)
+PHOTON_BASE_URL=https://photon.komoot.io  # Optional (default: Komoot's public instance)
+USER_AGENT=MyApp/1.0              # Optional
 CORS_ORIGIN=*                      # CORS origin (default: * in dev, https://chatgpt.com in prod)
 ```
 
-### Customize the Nominatim API
+### Customize the Photon API
 
-The Nominatim API is public but you can:
-1. Use a custom instance (set `NOMINATIM_BASE_URL`)
-2. Set a custom User-Agent (recommended, set `NOMINATIM_USER_AGENT`)
+The Photon API is public but you can:
+1. Use a self-hosted Photon instance (set `PHOTON_BASE_URL`)
+2. Set a custom User-Agent (set `USER_AGENT`)
 
 ---
 
@@ -456,7 +456,7 @@ This project serves as a **template/base** for future MCP servers with a clean,
 
 - **`config.ts`**: Environment variables, constants, validation
 - **`types.ts`**: Shared TypeScript interfaces
-- **`client/`**: External API abstraction (Nominatim)
+- **`client/`**: External API abstraction (Photon)
 - **`tools/`**: Business logic (validation, transformation, formatting)
 - **`servers/`**: MCP implementation (stdio/Streamable HTTP), reuses tools
 - **`utils/errors.ts`**: Custom error classes, formatting
@@ -479,7 +479,7 @@ See [CONTEXT.md](CONTEXT.md) for detailed architecture documentation.
 - [Apps SDK - MCP Server](https://developers.openai.com/apps-sdk/build/mcp-server) - Server config
 - [Model Context Protocol](https://modelcontextprotocol.io/) - MCP spec
 - [MCP SDK TypeScript](https://github.com/modelcontextprotocol/typescript-sdk) - Node.js SDK
-- [Nominatim API](https://nominatim.org/release-docs/develop/api/Overview/) - Geocoding API docs
+- [Photon API](https://photon.komoot.io/) - Geocoding API (OpenStreetMap + Elasticsearch)
 
 ### Community
 
@@ -535,7 +535,7 @@ This project is a **complete template** for creating your own ChatGPT apps with
 ### To create your own app:
 
 1. **Duplicate this project**
-2. **Replace the Nominatim API** with your API
+2. **Replace the Photon API** with your API
 3. **Modify the tools** in `src/tools/`
 4. **Customize the configuration** in `src/config.ts`
 5. **Deploy**!
@@ -562,13 +562,13 @@ MIT - Use freely for your personal or commercial projects.
 
 ## 🙏 Credits & Attributions
 
-- **Geocoding Data** - [Nominatim API](https://nominatim.openstreetmap.org/) - OpenStreetMap data
+- **Geocoding Data** - [Photon API](https://photon.komoot.io/) by [Komoot](https://www.komoot.com/) - OpenStreetMap data
 - **MCP Protocol** - [Anthropic](https://www.anthropic.com/)
 - **Apps SDK** - [OpenAI](https://openai.com/)
 
 ### Data & Licenses
 
-Geocoding data comes from the Nominatim API which uses OpenStreetMap data. This data is provided under the Open Database License (ODbL).
+Geocoding data comes from the Photon API (by Komoot) which uses OpenStreetMap data. This data is provided under the Open Database License (ODbL).
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shyzus/mcp-geocrafter",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "GeoCrafter - MCP server for geocoding and reverse geocoding - Powered by Nominatim API",
   "type": "module",
   "main": "dist/index.js",