contentful.php AGENTS.md

A repository guide for coding agents working on the Contentful PHP library. It points to the files that explain the code structure, development process, decisions, and review rules.

In plain words
What is it for?
Use it to find architecture and testing instructions, understand integration points, and avoid breaking namespace, client, link-resolution, or compatibility rules.
Why use it?
It reduces guesswork before making changes and highlights rules that could otherwise cause broken APIs or unsafe behavior.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/contentful/contentful.php/agents-md
Clone the repo
git clone --depth 1 https://github.com/contentful/contentful.php

Made for: Codex, OpenCode.

Per session 1,176 This file is loaded in full into every session.
When invoked 1,176 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.01176 $0.01176
Opus 5 $0.00588 $0.00588
Sonnet 5 $0.00235 $0.00235
Haiku 4.5 $0.00118 $0.00118

Measured 2d ago against content hash 9b20ee1e0642, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

contentful.php 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 2d 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 · 68 lines

How it starts

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

Agent Guide

Read this file first. It tells you where to find context in this repo.

Quick Reference

What you need Where to look
How this repo is structured ARCHITECTURE.md
How to build/test/run CONTRIBUTING.md
Why decisions were made docs/ADRs/
What this repo does README.md
PR review rules .bito/guidelines/
Active specs/work docs/specs/

Sharp Edges & Invariants

  • Namespace is Contentful\Delivery\* — all public types live under this namespace. Do not add classes to Contentful\Core\* or any other namespace; cross-SDK concerns belong in contentful/core.
  • One Client = one space + one environment. The space ID and environment ID are constructor arguments and immutable. There is no "multi-space client" — callers must instantiate multiple Client objects.
  • MAX_DEPTH = 20 — link resolution is recursive. Exceeding depth 20 throws. Do not raise this limit without understanding the memory implications on large entry graphs.
  • Backward compatibility is enforced by CI (roave/backward-compatibility-check). Any removal or signature change to a public API method is a breaking change requiring a major version bump. Even dropping a PHP version is a breaking change (major bump required).
  • ResourcePool is the identity map — do not instantiate domain resources directly outside of mappers. Always go through ResourceBuilder::build() so the pool is correctly populated and duplicates are deduplicated.
  • php-vcr cassettes are fragile — the Contentful space used to record existing integration test cassettes no longer exists. Do not delete cassettes, but do not record new cassettes against the old space. New integration tests should mock at the HTTP layer directly or use a live test space. See ADR-0005.
  • PSR-6 cache keys are generated by the resource pool — do not construct or hard-code cache keys. Always call ResourcePool::generateKey().
  • Locale wildcard '*' is used internally when a resource is fetched without an explicit locale (meaning "all locales"). Never strip or override the locale to null when serializing to cache.
  • phpstan level 5 must pass. There is a known warning about LocalizedResource::$sys undefined property on PHP 8.1 — it is intentionally left unresolved (fixing it breaks backward compat with PHP ≤ 8.1). Do not suppress it globally; see ADR-0004.
  • php-cs-fixer auto-fixes style — always run tools/php-cs-fixer/vendor/bin/php-cs-fixer fix -v before committing. CI will fail on unfixed style. The warning about running on a newer PHP version than the minimum supported is cosmetic and expected.

Read the full file on GitHub · 68 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. 2d ago First seen · 68 lines · 1,176 tokens per session scan A 9b20ee1e0642

Subscribe to this mod's changes

contentful.php AGENTS.md is an instructions file published in the GitHub repository contentful/contentful.php (119 stars, last pushed 3d ago), licensed MIT. It adds 1,176 tokens to every session, about $0.0059 per session on Opus 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.