@opengolfapi/mcp-server 2.3.1 → 2.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/dist/index.js +1 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -55,11 +55,20 @@ Donor tiers raise the daily limit further (10k / 50k / 250k / 1M).
|
|
|
55
55
|
|
|
56
56
|
## Tools
|
|
57
57
|
|
|
58
|
+
**Read (free, no key):**
|
|
58
59
|
- `search_courses(query, state?, lat?, lng?, radius_mi?)` — find courses by name, state, or location
|
|
59
60
|
- `get_course(id)` — full course record with scorecard (par + handicap index per hole)
|
|
60
61
|
- `get_tees(id)` — all tee sets with ratings, slopes, and yardages
|
|
61
62
|
- `get_climate(id)` — monthly climate normals for the course location
|
|
62
63
|
- `get_nearby(id)` — nearby POIs (hotels, restaurants, airports)
|
|
64
|
+
- `about()` — what OpenGolfAPI is and how to contribute
|
|
65
|
+
|
|
66
|
+
**Contribute (free key — set `OPENGOLFAPI_KEY`):**
|
|
67
|
+
- `log_shot(...)` — send a launch-monitor shot to the open OpenShot standard
|
|
68
|
+
- `submit_moment(...)` — send an event (breadcrumb, pin, condition, tee, green, swing…)
|
|
69
|
+
- `get_my_shots(player?, session?)` — read your own contributed shots back
|
|
70
|
+
|
|
71
|
+
**REST API references:** [`/openapi.json`](https://api.opengolfapi.org/openapi.json) (full OpenAPI 3.1 spec) · [`/llms.txt`](https://api.opengolfapi.org/llms.txt) (AI usage guide) · [`/api/v1/openshot/fields`](https://api.opengolfapi.org/api/v1/openshot/fields) (OpenShot field catalog).
|
|
63
72
|
|
|
64
73
|
## Telemetry
|
|
65
74
|
|
package/dist/index.js
CHANGED
|
@@ -106,8 +106,7 @@ const server = new McpServer({
|
|
|
106
106
|
'get_my_shots reads your data back. Which tool when: log_shot = a MEASURED shot (launch-monitor ' +
|
|
107
107
|
'numbers — ball speed, spin, carry); submit_moment = a PLACE or EVENT (GPS breadcrumb, pin/green ' +
|
|
108
108
|
'sighting, course condition, detected swing); get_my_shots = read your own shots back. A two-way ' +
|
|
109
|
-
'commons — every shot you contribute makes the shared data better
|
|
110
|
-
'analytics are the separate paid OpenGolfGeo layer.)',
|
|
109
|
+
'commons — every shot you contribute makes the shared data better for everyone.',
|
|
111
110
|
});
|
|
112
111
|
// ── Tool: search_courses ──
|
|
113
112
|
server.tool('search_courses', 'Search golf courses by name, state, or location. Returns full course info. ODbL licensed data from OpenGolfAPI.', {
|