@opengolfapi/mcp-server 2.2.1 → 2.2.3

package/README.md

@@ -61,6 +61,38 @@ Donor tiers raise the daily limit further (10k / 50k / 250k / 1M).
 - `get_climate(id)` — monthly climate normals for the course location
 - `get_nearby(id)` — nearby POIs (hotels, restaurants, airports)
 
+## Telemetry
+
+This server reports unhandled errors to the OpenGolfAPI Sentry project by default so the maintainers can catch bugs that hit real users. **No request bodies, no API keys, no PII** — only stack traces of exceptions thrown inside the server process. Quotas and sampling live in the Sentry project config; the DSN is an ingest endpoint, not a secret.
+
+To opt out completely:
+
+```
+OPENGOLFAPI_DISABLE_TELEMETRY=1 npx @opengolfapi/mcp-server
+```
+
+To send to your own Sentry project instead (overrides the default DSN):
+
+```
+SENTRY_DSN=https://your-dsn@sentry.io/... npx @opengolfapi/mcp-server
+```
+
+Example MCP config:
+
+```json
+{
+  "mcpServers": {
+    "opengolfapi": {
+      "command": "npx",
+      "args": ["@opengolfapi/mcp-server"],
+      "env": {
+        "OPENGOLFAPI_KEY": "ogapi_yourkeyhere"
+      }
+    }
+  }
+}
+```
+
 ## License
 
 MIT

package/dist/index.js

@@ -11,11 +11,30 @@
  *
  * Install: npx @opengolfapi/mcp-server
  */
+// Sentry must initialize BEFORE any other imports that could throw, so any
+// load-time error in transitive deps still gets captured.
+//
+// Default DSN ships baked-in so we get bug telemetry from every install — a
+// Sentry DSN is designed to be public (it's an ingest endpoint, not a secret).
+// Users can override with SENTRY_DSN, or opt out completely with
+// OPENGOLFAPI_DISABLE_TELEMETRY=1.
+import * as Sentry from '@sentry/node';
+const DEFAULT_SENTRY_DSN = 'https://2cb261cd86bbfe9e105309d3c2edbced@o4511071885000704.ingest.us.sentry.io/4511345201315840';
+const SENTRY_DSN_ACTIVE = process.env.OPENGOLFAPI_DISABLE_TELEMETRY
+    ? ''
+    : (process.env.SENTRY_DSN || DEFAULT_SENTRY_DSN);
+if (SENTRY_DSN_ACTIVE) {
+    Sentry.init({
+        dsn: SENTRY_DSN_ACTIVE,
+        tracesSampleRate: 0.1,
+        release: `opengolfapi-mcp-server@${process.env.npm_package_version || 'unknown'}`,
+    });
+}
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 import { z } from 'zod';
 // Package version — used in User-Agent so the API can identify MCP traffic.
-const PKG_VERSION = '2.2.0';
+const PKG_VERSION = '2.2.3';
 const API_BASE = process.env.OPENGOLFAPI_BASE ?? 'https://api.opengolfapi.org';
 // Optional API key for higher rate limits. Anonymous (no key) still works
 // at 1k req/day per IP. With a free key from courses.opengolfapi.org/api-keys,
@@ -76,61 +95,68 @@ server.tool('search_courses', 'Search golf courses by name, state, or location.
     state: z.string().optional().describe('2-letter US state code'),
     limit: z.number().optional().default(10).describe('Max results'),
 }, async ({ lat, lng, radius_mi, query: q, state, limit }) => {
-    const max = limit ?? 10;
-    const r = radius_mi ?? 25;
-    // Build a server-side query. The public search supports `q`, `state`,
-    // and `limit`. Geo (lat/lng/radius_mi) is filtered client-side after
-    // fetch — see https://github.com/opengolfapi/api/issues for tracking
-    // native geo search support.
-    const params = new URLSearchParams();
-    if (q)
-        params.set('q', q);
-    if (state)
-        params.set('state', state.toUpperCase());
-    let pool = [];
-    let geoFilterApplied = false;
-    if (lat !== undefined && lng !== undefined) {
-        // Geo filtering: pull a wider net so the local bbox filter has data
-        // to chew on. If a state is given, prefer the state listing
-        // (returns up to 100 per page) since it's higher recall than search.
-        params.set('limit', '100');
-        if (state && !q) {
-            const data = await apiGet(`/v1/courses/state/${state.toUpperCase()}`);
-            pool = data.courses ?? [];
+    try {
+        const max = limit ?? 10;
+        const r = radius_mi ?? 25;
+        // Build a server-side query. The public search supports `q`, `state`,
+        // and `limit`. Geo (lat/lng/radius_mi) is filtered client-side after
+        // fetch — see https://github.com/opengolfapi/api/issues for tracking
+        // native geo search support.
+        const params = new URLSearchParams();
+        if (q)
+            params.set('q', q);
+        if (state)
+            params.set('state', state.toUpperCase());
+        let pool = [];
+        let geoFilterApplied = false;
+        if (lat !== undefined && lng !== undefined) {
+            // Geo filtering: pull a wider net so the local bbox filter has data
+            // to chew on. If a state is given, prefer the state listing
+            // (returns up to 100 per page) since it's higher recall than search.
+            params.set('limit', '100');
+            if (state && !q) {
+                const data = await apiGet(`/v1/courses/state/${state.toUpperCase()}`);
+                pool = data.courses ?? [];
+            }
+            else {
+                const data = await apiGet(`/v1/courses/search?${params.toString()}`);
+                pool = data.courses ?? [];
+            }
+            const latDelta = r / 69.0;
+            const lngDelta = r / (69.0 * Math.cos(lat * Math.PI / 180));
+            pool = pool.filter(c => {
+                if (c.latitude == null || c.longitude == null)
+                    return false;
+                return c.latitude >= lat - latDelta
+                    && c.latitude <= lat + latDelta
+                    && c.longitude >= lng - lngDelta
+                    && c.longitude <= lng + lngDelta;
+            });
+            geoFilterApplied = true;
         }
         else {
+            params.set('limit', String(max));
             const data = await apiGet(`/v1/courses/search?${params.toString()}`);
             pool = data.courses ?? [];
         }
-        const latDelta = r / 69.0;
-        const lngDelta = r / (69.0 * Math.cos(lat * Math.PI / 180));
-        pool = pool.filter(c => {
-            if (c.latitude == null || c.longitude == null)
-                return false;
-            return c.latitude >= lat - latDelta
-                && c.latitude <= lat + latDelta
-                && c.longitude >= lng - lngDelta
-                && c.longitude <= lng + lngDelta;
-        });
-        geoFilterApplied = true;
+        const courses = pool.slice(0, max).map(summarizeCourse);
+        return {
+            content: [{
+                    type: 'text',
+                    text: JSON.stringify({
+                        courses,
+                        total: courses.length,
+                        ...(geoFilterApplied ? { geo_filter: { lat, lng, radius_mi: r } } : {}),
+                        source: SOURCE,
+                    }, null, 2),
+                }],
+        };
     }
-    else {
-        params.set('limit', String(max));
-        const data = await apiGet(`/v1/courses/search?${params.toString()}`);
-        pool = data.courses ?? [];
+    catch (err) {
+        Sentry.captureException(err, { tags: { tool: 'search_courses' } });
+        const msg = err instanceof Error ? err.message : String(err);
+        return { content: [{ type: 'text', text: `Error: ${msg}` }] };
     }
-    const courses = pool.slice(0, max).map(summarizeCourse);
-    return {
-        content: [{
-                type: 'text',
-                text: JSON.stringify({
-                    courses,
-                    total: courses.length,
-                    ...(geoFilterApplied ? { geo_filter: { lat, lng, radius_mi: r } } : {}),
-                    source: SOURCE,
-                }, null, 2),
-            }],
-    };
 });
 // ── Tool: get_course ──
 server.tool('get_course', 'Get detailed golf course info including full scorecard with par and handicap index per hole. ODbL licensed.', {
@@ -144,7 +170,8 @@ server.tool('get_course', 'Get detailed golf course info including full scorecar
             apiGet(`/v1/courses/${course_id}/holes`),
         ]);
     }
-    catch {
+    catch (err) {
+        Sentry.captureException(err, { tags: { tool: 'get_course' } });
         return { content: [{ type: 'text', text: 'Course not found' }] };
     }
     const scorecard = (holes ?? [])
@@ -187,6 +214,7 @@ server.tool('get_tees', 'Get all tee sets for a course including ratings, slopes
         };
     }
     catch (err) {
+        Sentry.captureException(err, { tags: { tool: 'get_tees' } });
         const msg = err instanceof Error ? err.message : String(err);
         return { content: [{ type: 'text', text: `Error: ${msg}` }] };
     }
@@ -205,6 +233,7 @@ server.tool('get_climate', 'Get monthly climate normals for a course (temperatur
         };
     }
     catch (err) {
+        Sentry.captureException(err, { tags: { tool: 'get_climate' } });
         const msg = err instanceof Error ? err.message : String(err);
         return { content: [{ type: 'text', text: `Error: ${msg}` }] };
     }
@@ -228,6 +257,7 @@ server.tool('get_nearby', 'Get nearby points of interest for a course (hotels, r
         };
     }
     catch (err) {
+        Sentry.captureException(err, { tags: { tool: 'get_nearby' } });
         const msg = err instanceof Error ? err.message : String(err);
         return { content: [{ type: 'text', text: `Error: ${msg}` }] };
     }
@@ -265,4 +295,7 @@ async function main() {
     const transport = new StdioServerTransport();
     await server.connect(transport);
 }
-main().catch(console.error);
+main().catch((err) => {
+    Sentry.captureException(err);
+    console.error(err);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengolfapi/mcp-server",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "Open MCP server for AI agents to query the OpenGolfAPI dataset (14,708 US golf courses, ODbL)",
   "type": "module",
   "bin": {
@@ -13,7 +13,8 @@
   ],
   "scripts": {
     "build": "tsc",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm test",
+    "test": "npm run build && vitest run"
   },
   "repository": {
     "type": "git",
@@ -33,10 +34,12 @@
   "homepage": "https://opengolfapi.org",
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.0.0",
+    "@sentry/node": "^10.51.0",
     "zod": "^3.22.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vitest": "^4.1.5"
   }
 }