contentful-sdk-core AGENTS.md

A repository guide for the Contentful SDK core codebase, showing where to find architecture, build instructions, decisions, specifications, and review rules. It also records coding rules and internal behavior that must not be changed accidentally.

In plain words
What is it for?
Use it when modifying, testing, reviewing, or learning the Contentful SDK core codebase. It points developers to the relevant documents and highlights implementation details that require care.
Why use it?
It reduces the time spent guessing how the repository works and helps prevent changes that break module loading, HTTP client copying, request handling, or retry 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-sdk-core/agents-md
Clone the repo
git clone --depth 1 https://github.com/contentful/contentful-sdk-core

Made for: Codex, OpenCode.

Per session 718 This file is loaded in full into every session.
When invoked 718 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.00718 $0.00718
Opus 5 $0.00359 $0.00359
Sonnet 5 $0.00144 $0.00144
Haiku 4.5 $0.00072 $0.00072

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

Security

Grade A, and why

contentful-sdk-core 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 3d 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 · 52 lines

How it starts

The opening of the file, as written. The whole thing — 52 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

  • Never import without .js extension — all TypeScript source imports must use .js extensions (e.g., import foo from './foo.js'). This is required for ESM resolution.
  • Never modify httpAgent/httpsAgent during copy — these objects contain private fields that break on deep clone. The copyHttpClientParams function handles this by re-assigning references after copy.
  • Interceptor order matters — interceptors are attached in a specific sequence (onBeforeRequestasyncTokenrateLimitThrottlerateLimitRetryonError). Changing the order can cause auth failures or incorrect retry behavior.
  • axios is not a listed dependency — it's provided by downstream SDKs via the createHttpClient(axios, params) factory pattern. Never add it to dependencies.
  • Rate limit retry deletes httpAgent/httpsAgent from retry config — this is an intentional workaround for an axios serialization bug. Do not "fix" this by preserving them.
  • Auth headers are obscured in errorserror-handler.ts intentionally truncates tokens to last 5 chars. Never expose full tokens in error output.
  • Critical path modulescreate-http-client.ts, rate-limit.ts, rate-limit-throttle.ts, and pThrottle.ts execute on every single API call made by downstream SDKs. Changes here have outsized blast radius — test thoroughly and consider backward compatibility.

Read the full file on GitHub · 52 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. 3d ago First seen · 52 lines · 718 tokens per session scan A e626e4f8fbd1

Subscribe to this mod's changes

contentful-sdk-core AGENTS.md is an instructions file published in the GitHub repository contentful/contentful-sdk-core (24 stars, last pushed 16d ago), licensed MIT. It adds 718 tokens to every session, about $0.0036 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.