create_competition
Create a Competition (any OpenMatch format). Requires key.
How to use it
Project documentation lists create_competition for the MCP Server MCP server. Add the server to your MCP client (Claude Desktop, Cursor, Windsurf and others), then check which tools your installed version makes available. Tool availability can depend on configuration and credentials. A server handshake does not verify this tool’s behavior. See the full listing for setup details.
Install MCP Server
npx -y @opengolfapi/mcp-serverOther tools in MCP Server (39)
What OpenGolfAPI is and how to use this MCP server.
Finish sign-in: exchange the 6-digit code for their OpenGolf ID + access token (use as X-OpenGolf-Token to act as them). Pass ref=<inviter playerid> when another player's invite brought them — it credits the referral.
Mint a developer API key bound to an OpenGolf ID (sign in first via requestsignincode → completesignin). Returns the key ONCE. First-party rail: no OpenGolf ID, no key.
Create a shareable invite (QR/link); everyone who redeems it joins the SAME event/session. maxuses caps size (foursome=4). Requires key.
Discover ACTIVE public beacons (find-my-group / matchmaking). Requires key.
A player's OpenAwards — derived trophies + course passport. Requires key.
Monthly climate normals + best months to play for a course. Free.
A Competition + live gross standings (free).
LIVE weather at a course (temp/wind/precip, forecast-model, 15-min cache). FREE. Feeds playslike.
Check the status/verdict of a correction you proposed (approved rejected needsinfo applied). Requires a key.
Full detail for one course by id: scorecard (par + handicap per hole), tees, location, contact, nearby. Free.
Read back your own contributed moments (breadcrumbs, swings, putts, conditions…) by player, session, or type. Requires a key.
Read back your own contributed shots by player or session. Requires a key.
Nearby hotels, restaurants, and other courses for a course. Free.
FREE (public, no key). Any golfer's shareable record — display name, OpenGolf Member #, courses played, rounds, trophies, referrals. Show a player's golf resume in your app.
A player's public OpenGolf ID card — name, avatar, links, prefs. Free.
How many golfers a user has referred (+ the list) — the viral-loop metric for your app. Needs a key.
All tee sets for a course with ratings, slopes, and yardages. Free.
Live weather forecast for a course location (Weather.gov). Free.
The safe playbook for building on OpenGolfAPI and contributing data the right way. Call this once before contributing.
Redeem an invite token — the player joins the group/event. Requires key.
Confirm your OpenGolf ID on an EXISTING key. Sign in first; pass that accesstoken + the key.
List Competitions (free). Filter org/course/status.
List the keys owned by your OpenGolf ID (prefixes only). Needs accesstoken from completesignin.
Every OpenMatch scoring format. GROSS scoring is free & keyless.
Contribute a golf shot to the open OpenShot standard (any launch monitor). Requires a key. Units: speed mph, angles deg, spin rpm, distance yds.
Effective distance — THE canonical "plays like" number (wind/elevation/temp/altitude), factors itemized. FREE, no key. Pair with getconditions for live wind.
Propose a fix to a course FACT field (phone, website, address, architect, yearbuilt, coursename, city, postalcode, coursetype). Our AI reviews it (approve/reject/needsinfo). Requires a key. Geometry is not correctable here.
Record a player's consent grant (auditable, revocable). Requires key.
Record that one user referred another (a REFERREDBY edge) — build YOUR app's invite loop on the shared graph, namespaced to your app. Needs a key.
Register an https URL for your domain events (HMAC-signed deliveries, owner-scoped). Requires your key (Authorization: Bearer ogapi…).
Start "Sign in with OpenGolf" for a person: emails them a 6-digit code. No API key needed. They read you the code, then call completesignin.
Respond to a correction that came back as needsinfo — add a source or explanation and re-open it for review. Requires a key.
Score a round in any format — GROSS, FREE, no key. players:[{playerid,holes:{"1":4}}] or entries:[{playerid,hole,value}]; holes:[{hole,par,strokeindex?}].
Search US golf courses by name, US state, or location (lat/lng + radius). Returns matching courses with location, type, par. Free, ODbL data.
Broadcast a consented, EXPIRING presence/availability beacon (presentavailableopen). Requires key.
Derive a user's OpenGolf ID deterministically from their email (sub = ogid + sha256(lower(trim(email)))[:16]) — one line, no redirect. For a VERIFIED session token use requestsignincode → completesignin.
Contribute an Open Connect event from any sensor/wearable/phone. The whole sensor spectrum rides through here — type-specific data goes in payload. Requires a key.
Edit a player's self-asserted profile fields (derived facts can't be set). Requires key (claimed players need their grant).