What is terraform-docs AGENTS.md?

Repository instructions for working on a Terraform documentation search service. The service uses keyword and meaning-based search across AWS and Google provider documentation.

Following the project's type-checking and test commands, choosing between its command-line and library entry points, and working with its MCP server.

They define the repository's current behavior, required checks, coding style, and supported ways to run the project before edits are considered complete.

How brightredchilli/terraform-docs configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to brightredchilli/terraform-docs. 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/brightredchilli/terraform-docs/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/brightredchilli/terraform-docs

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/brightredchilli/terraform-docs/agents-md/github.svg)](https://agentmods.dev/instructions/brightredchilli/terraform-docs/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/brightredchilli/terraform-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/brightredchilli/terraform-docs/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/brightredchilli/terraform-docs/agents-md"><img src="https://agentmods.dev/badge/instructions/brightredchilli/terraform-docs/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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

When invoked 772 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.00772	$0.00772
Opus 5.5	$0.00309	$0.00309
Sonnet 5.5	$0.00154	$0.00154
Haiku 4.5	$0.00077	$0.00077

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

Security

Grade A, and why

terraform-docs 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 · 74 lines

How it starts

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

Working in this repository

Hybrid (BM25 + vector) search over the Terraform AWS and Google provider documentation, exposed as an MCP server and a Python library. The installed artifact is meant to be self-contained and offline: the wheel ships the search index and documentation alongside the code.

Before calling any edit done

Run the type checker — this repo has a pyrightconfig.json (typeCheckingMode: standard, reportArgumentType: error). Fix what it reports rather than silencing it.

make typecheck      # uv run basedpyright src tests
make check          # typecheck + tests

Style

Prefer """ triple-quoted strings over adjacent-literal concatenation for multiline text ("line one\n" "line two\n" → """line one\nline two"""). This matters most for expected-value fixtures in tests — concatenation is easy to get subtly wrong (a missing space between fragments, mismatched embedded quotes) and harder to eyeball against the real content it is meant to match.

Two entry points

cli.py is what gets installed and exposed to users (terraform-docs-mcp on $PATH): search/get/stats for the command line, and serve to run the MCP server (stdio or Streamable HTTP). This is the only thing an installed user ever runs.

build_index.py is development-only, never installed. It builds _data/ (the packaged search index) and src/summaries/ (per-document summaries, checked into git as source, not generated at install time). Bare invocation builds both, skipping whichever hasn't changed:

uv run src/terraform_docs_mcp/build_index.py            # everything
uv run src/terraform_docs_mcp/build_index.py index       # just the index
uv run src/terraform_docs_mcp/build_index.py summaries   # just the summaries

Its imports are absolute (terraform_docs_mcp.x), not relative, specifically so it can run by path as shown above, not just via -m — a relative import breaks the moment a file executes as __main__. This is the one module in the package where that matters; everywhere else, relative imports are the norm.

Read the full file on GitHub · 74 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 · 74 lines · 772 tokens per session scan A 233433bb8d7c

Subscribe to this mod's changes

terraform-docs AGENTS.md is an instructions file published in the GitHub repository brightredchilli/terraform-docs (0 stars, last pushed 2mo ago), licensed MPL-2.0. It adds 772 tokens to every session, about $0.0031 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-31.

terraform-docs AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
terraform-docs AGENTS.mdbrightredchilli/terraform-docs	Instructions file	0	2mo ago	MPL-2.0	A	772	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	yesterday	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

terraform-docs: Instructions file for Codex