gcx: Instructions file for Codex

AGENTS.md

gcx AGENTS.md is an instructions file for Codex, OpenCode from grafana/gcx. It costs 3,585 tokens per session, scanned A, original, Apache-2.0.

A starting guide for contributors and coding agents working on gcx, a Go command-line tool for managing Grafana resources. It maps the main architecture, development documents, conventions, and two levels of Grafana support: Kubernetes-style resources and Grafana Cloud products.

In plain words
What is it for?
Use it to get oriented in the gcx codebase, choose which documentation to read next, understand its resource tiers, and locate guidance for development or contributions.
Why use it?
It helps newcomers find the right design, testing, contribution, and architecture documents before changing the code. This reduces time spent searching and lowers the risk of violating repository conventions.

Instructions file for CodexOpenCode ✓ vendor

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: reads .claude/ paths.

This is grafana/gcx's own configuration. It tells Codex and OpenCode how to work on gcx itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything gcx configures →

About the project

gcx is a command-line tool that lets people and AI coding agents manage and inspect Grafana Cloud, Enterprise, and open-source instances. It provides access to dashboards, alerts, SLOs, metrics, logs, and traces, with workflows for alert investigation, dashboard management, GitOps, and observability setup. Its catalogue entries provide agent instructions and extensions for using gcx.

grafana/gcx · 805 stars · on GitHub · grafana.com

Reuse

Borrowing it

Nothing to install: this file belongs to grafana/gcx. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/grafana/gcx/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/grafana/gcx

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for gcx AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/grafana/gcx/agents-md/github.svg)](https://agentmods.dev/instructions/grafana/gcx/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/grafana/gcx/agents-md"><img src="https://agentmods.dev/badge/instructions/grafana/gcx/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for gcx AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/grafana/gcx/agents-md"><img src="https://agentmods.dev/badge/instructions/grafana/gcx/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,585 This file is loaded in full into every session.
When invoked 3,585 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.03585 $0.03585
Opus 5.5 $0.01434 $0.01434
Sonnet 5.5 $0.00717 $0.00717
Haiku 4.5 $0.00359 $0.00359

Measured 7d ago against content hash 9e2d41f6f5e1, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

gcx AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 7d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 174 lines

How it starts

The opening of the file, as written. The whole thing — 174 lines — stays where its author put it; the contents beside it link to each section on GitHub.

gcx — Agent & Developer Entry Point

Lightweight map for autonomous coding agents. Read this first, then navigate to specific docs on demand.

Quick Start

gcx is a unified CLI for managing Grafana resources. It operates in two tiers: (1) a K8s resource tier that uses Grafana 12+'s Kubernetes-compatible API via k8s.io/client-go for dashboards, folders, and other K8s-native resources, and (2) a Cloud provider tier with pluggable providers for Grafana Cloud products (SLO, Synthetic Monitoring, IRM, Fleet Management, etc.) that use product-specific REST APIs. Built in Go, it uses Cobra for CLI structure.

Documentation Map

File Purpose
VISION.md Goals, product surface, roadmap themes, release timeline
CONSTITUTION.md Invariants — things that cannot change without explicit human approval
ARCHITECTURE.md System boundaries, extension points, and pipeline diagrams
DESIGN.md CLI UX design: command grammar, output model, exit codes
CONTRIBUTING.md Dev setup, testing environment, contribution workflow
docs/architecture/ Deep-dive architecture docs (patterns, resource model, CLI layer, data flows, …)
docs/design/ Prescriptive UX implementation rules (output, errors, agent mode, naming, …)
docs/rfcs/ Engineering proposals, design tradeoffs, and open questions
docs/reference/ Handwritten provider guides and contributor references

Architecture at a Glance

Two tiers: K8s resource tier (dashboards, folders via /apis) and Cloud provider tier (SLO, SM, IRM, etc. via product REST APIs). See ARCHITECTURE.md for pipeline diagrams and extension pipelines.

Key Conventions

Authoritative source: CONSTITUTION.md (invariants) and DESIGN.md (UX rules). This is the quick-reference summary.

Read the full file on GitHub · 174 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 7d ago Changed · +4 tokens per session 9e2d41f6f5e1
  2. 8d ago Changed · -24 lines · -265 tokens per session 4d70fd3a23ad
  3. 14d ago Changed · -2 lines · -88 tokens per session c6016bd71031
  4. 15d ago Changed · +1 lines · +19 tokens per session 4156a3d43f64
  5. 16d ago Changed · +4 lines · +66 tokens per session d2e4faba199a
  6. 20d ago Changed · +1 lines · +36 tokens per session 5b1796a8e30e
  7. 21d ago Changed · +1 lines · +74 tokens per session ab6df4a35e4c
  8. 22d ago Changed · +1 lines · +150 tokens per session 74cd41a669c4
  9. 23d ago Changed · +2 lines · +101 tokens per session 8a2099293755
  10. 26d ago First seen · 190 lines · 3,488 tokens per session scan A 609519eafb69

Subscribe to this mod's changes

gcx AGENTS.md is an instructions file published in the GitHub repository grafana/gcx (805 stars, last pushed yesterday), licensed Apache-2.0. It adds 3,585 tokens to every session, about $0.0143 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens