agentleFS
Sign inStart free
Google CloudKnown publisherGoogleCloudPlatform/gke-mcp/AGENTS.md

gke-mcp

AGENTS.md169 starsChanged 3 months agoApache-2.0View on GitHub

This repository contains the GKE MCP server and Gemini CLI extension. The main server is written in Go. Web UI assets live under ui/ and are built into checked-in single-file HTML bundles under ui/dist/apps/. Run the smallest relevant check for the files you changed. For broad changes, prefer make presubmit when feasible. The files under ui/dist/apps/ are generated but checked in because Go embeds them. Do not edit them by hand. Change source files under ui/apps/, ui/shared/, or UI build…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,542 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repositoryOne other file it gives its agents.

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

20 rules. About 0 are common, 4 are distinctive, and 16 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 16

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run Go tests: go test -v ./...

    line 22
  2. Very specific:

    Run Go vet: go vet ./...

    line 23
  3. Very specific:

    Run UI tests: npm --prefix ui run test

    line 26
  4. Very specific:

    Run UI lint: npm --prefix ui run lint

    line 27
  5. Very specific:

    Run local presubmit: ./dev/tasks/presubmit.sh or make presubmit

    line 30
  6. Very specific:

    Run the smallest relevant check for the files you changed.

    line 32
  7. Very specific:

    If verify-ui.sh reports changes after an intentional UI update, include the updated ui/dist/apps/*/index.html files in the same change.

    line 51
  8. Very specific:

    Keep Go code formatted with gofmt.

    line 56
  9. Very specific:

    If dependencies change, run go mod tidy or ./dev/tasks/gomod.sh.

    line 57
  10. Distinctive:

    Add or update focused tests near changed behavior.

    line 58
  11. Very specific:

    Prefer existing package patterns in pkg/tools, pkg/config, and pkg/agents before adding new abstractions.

    line 59
  12. Very specific:

    Keep source changes in ui/apps/ or ui/shared/ when possible.

    line 65
  13. Very specific:

    Run npm --prefix ui run lint after TypeScript or React changes.

    line 66
  14. Very specific:

    Run npm --prefix ui run test for UI logic changes.

    line 67
  15. Distinctive:

    Keep changes scoped to the request.

    line 73
  16. Distinctive:

    Do not commit unrelated formatting or generated output.

    line 74
  17. Distinctive:

    Use Conventional Commits for commit messages.

    line 75
  18. Very specific:

    Use .github/PULL_REQUEST_TEMPLATE.md for PR body structure and level of detail.

    line 77
  19. Very specific:

    When updating Markdown files, run npx prettier --write <files> on the changed Markdown files before committing.

    line 79
  20. Very specific:

    Run ./dev/tasks/presubmit.sh locally before creating a PR, and only create the PR once presubmit passes.

    line 81

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

Project Overview

This repository contains the GKE MCP server and Gemini CLI extension. The main server is written in Go. Web UI assets live under ui/ and are built into checked-in single-file HTML bundles under ui/dist/apps/.

Repository Layout

  • cmd/, pkg/: Go source for the MCP server, tools, config, and agents.
  • ui/: Vite/React TypeScript apps and shared UI code.
  • ui/apps/*/index.html: source app HTML entrypoints.
  • ui/dist/apps/*/index.html: generated, checked-in UI bundles embedded by Go.
  • dev/tasks/: local maintenance tasks that may update files.
  • dev/ci/presubmits/: CI-equivalent verification scripts.

Development Commands

  • Build everything: make build
  • Build Go only: go build -v ./...
  • Run Go tests: go test -v ./...
  • Run Go vet: go vet ./...
  • Install UI dependencies: npm --prefix ui install
  • Build UI bundles: npm --prefix ui run build
  • Run UI tests: npm --prefix ui run test
  • Run UI lint: npm --prefix ui run lint
  • Format all supported files: ./dev/tasks/format.sh
  • Format Markdown files after editing: npx prettier --write <files>
  • Run local presubmit: ./dev/tasks/presubmit.sh or make presubmit

Run the smallest relevant check for the files you changed. For broad changes, prefer make presubmit when feasible.

Generated Files

The files under ui/dist/apps/ are generated but checked in because Go embeds them. Do not edit them by hand. Change source files under ui/apps/, ui/shared/, or UI build configuration, then regenerate with:

npm --prefix ui run build

To verify generated UI bundles are current, run:

./dev/ci/presubmits/verify-ui.sh

If verify-ui.sh reports changes after an intentional UI update, include the updated ui/dist/apps/*/index.html files in the same change.

Go Guidelines

  • Keep Go code formatted with gofmt.
  • If dependencies change, run go mod tidy or ./dev/tasks/gomod.sh.
  • Add or update focused tests near changed behavior.
  • Prefer existing package patterns in pkg/tools, pkg/config, and pkg/agents before adding new abstractions.

UI Guidelines

  • The UI uses Vite, React, TypeScript, MUI, and Vitest.
  • Keep source changes in ui/apps/ or ui/shared/ when possible.
  • Run npm --prefix ui run lint after TypeScript or React changes.
  • Run npm --prefix ui run test for UI logic changes.
  • Regenerate ui/dist after UI source or build configuration changes.

Pull Request Hygiene

  • Perform a self-review of the changes before sending or updating PRs.
  • Keep changes scoped to the request.
  • Do not commit unrelated formatting or generated output.
  • Use Conventional Commits for commit messages.
  • Push PR branches to a fork, not to the upstream repository.
  • Use .github/PULL_REQUEST_TEMPLATE.md for PR body structure and level of detail.
  • When updating Markdown files, run npx prettier --write <files> on the changed Markdown files before committing.
  • Run ./dev/tasks/presubmit.sh locally before creating a PR, and only create the PR once presubmit passes.
  • The presubmit script can take several minutes; when tooling supports it, run it as a background or otherwise non-blocking task while continuing other PR preparation.
  • Mention any checks that could not be run and why.
  • For generated bundle changes, explain which source or build configuration change caused the regenerated output.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free