What is gql-query-builder AGENTS.md?

A set of instructions for contributing to gql-query-builder, a TypeScript library that creates GraphQL requests from JavaScript objects. GraphQL is a way for applications to request specific data from an API.

Use it when changing the library, building it, checking types and formatting, running tests, or validating the published package.

It tells coding agents which commands, files, package manager, and public API rules the project expects.

How atulmy/gql-query-builder configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to atulmy/gql-query-builder. 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/atulmy/gql-query-builder/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/atulmy/gql-query-builder

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/atulmy/gql-query-builder/agents-md/github.svg)](https://agentmods.dev/instructions/atulmy/gql-query-builder/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/atulmy/gql-query-builder/agents-md"><img src="https://agentmods.dev/badge/instructions/atulmy/gql-query-builder/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/atulmy/gql-query-builder/agents-md"><img src="https://agentmods.dev/badge/instructions/atulmy/gql-query-builder/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 812 This file is loaded in full into every session.

When invoked 812 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.

Model	Per session	Once invoked
Fable 5.1	$0.00812	$0.00812
Opus 5.5	$0.00325	$0.00325
Sonnet 5.5	$0.00162	$0.00162
Haiku 4.5	$0.00081	$0.00081

Measured 2mo ago against content hash 5fcc80a8bc59, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

gql-query-builder 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 2mo 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 · 49 lines

How it starts

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

gql-query-builder — Agent Guide

Zero-runtime-dependency TypeScript library that generates GraphQL query/mutation/subscription strings (plus a variables object) from plain JavaScript objects. Published to npm as gql-query-builder.

Commands

Package manager is pnpm (see packageManager in package.json). Node >= 22.

Task	Command
Install	`pnpm install`
Build (ESM + CJS + d.ts to `dist/`)	`pnpm build`
Typecheck (no emit)	`pnpm typecheck`
Lint + format check (Biome)	`pnpm lint`
Auto-fix lint/format	`pnpm format`
Test (Vitest)	`pnpm test`
Single test file	`pnpm exec vitest run src/__tests__/query.test.ts`
Coverage	`pnpm coverage`
Validate published package shape	`pnpm check-package` (publint + arethetypeswrong)

Layout

src/index.ts — public entry: query(), mutation(), subscription(), adapters, plus all public types (named exports only).
src/types.ts — option/result types (QueryBuilderOptions, Fields, NestedField, VariableOptions, Operation, OperationResult) and the isNestedField guard. Deprecated I* aliases live here too.
src/utils.ts — shared pure helpers (field maps, variable resolution, GraphQL type inference).
src/adapters/types.ts — adapter contracts (QueryAdapter, MutationAdapter, SubscriptionAdapter) and their constructor types.
src/adapters/default-{query,mutation,subscription}-adapter.ts — default string-generation classes (use native #private fields).
src/adapters/app-sync-{query,mutation}-adapter.ts — AWS AppSync variants, bundled in the adapters export.
src/__tests__/ — Vitest suites (globals enabled, no imports of describe/it needed).
docs/api.md — compact API reference with canonical examples.

Public API contract

query/mutation/subscription(options, adapter?, config?) returns { query: string, variables: object }. options is { operation, fields?, variables? } or an array of those. See docs/api.md for the full options/variables shapes and examples.

Read the full file on GitHub · 49 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.

2mo ago First seen · 49 lines · 812 tokens per session scan A 5fcc80a8bc59

Subscribe to this mod's changes

gql-query-builder AGENTS.md is an instructions file published in the GitHub repository atulmy/gql-query-builder (409 stars, last pushed 3mo ago), licensed MIT. It adds 812 tokens to every session, about $0.0032 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.

generator graphql nodejs query-builder query-generator

gql-query-builder AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
gql-query-builder AGENTS.mdatulmy/gql-query-builder	Instructions file	409	3mo ago	MIT	A	812	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

gql-query-builder: Instructions file for Codex