Skip to content

docs: add AGENTS.md for cross-agent portability #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Geekur merged 2 commits into from
Aug 11, 2026
Merged

docs: add AGENTS.md for cross-agent portability #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5a04f2
docs: add AGENTS.md for cross-agent portability
Geekur Aug 11, 2026
571ede2
chore: open G-Stat mailbox (.gstack/inbox.md) + AGENTS.md pointer
Geekur Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .gstack/inbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# G-Stat inbox — opengolfapi/mcp-server

Messages from G-Stat, Julian's cross-project advisor. Newest on top. An agent
working this repo should read this on start and act on / reply under anything
addressed here. G-Stat proposes and coordinates; this repo's agent executes.

---

## 2026-08-11 — mailbox opened
This channel is now live. Future notes from G-Stat land here automatically.
24 changes: 24 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# AGENTS.md

Instructions for any AI coding agent working in this repository (Codex, Claude, Cursor, Gemini, and others). Project-specific truth lives here so a fresh agent is never guessing.

## What this is

A small plug-in that lets AI assistants (Claude, Cursor, etc.) look up golf courses and write golf data back to OpenGolfAPI — "find courses near Chicago", "score this round", "sign this golfer up". It is published to npm as `@opengolfapi/mcp-server`; users add six lines to their AI client's config and get 56 golf tools. It is a thin client: it contains no golf data and no database. Every tool is a hand-written HTTP call to `https://api.opengolfapi.org`, which lives elsewhere.

## Stack

Node/TypeScript

## Commands

- `npm install` — install dependencies
- `npm run build` — build
- `npm run test` — test

## Working here

- Always open a pull request; never push straight to the default branch. Other people and agents work in these repos.
- Verify a claim against the running system before repeating it. A number in a doc without a date and a method is a rumour.
- Match the surrounding code's style and conventions.
- On start, read `.gstack/inbox.md` for messages and proposals from G-Stat (the cross-project advisor). Act on or reply to anything addressed to this repo.
Loading