ui-extensions-sdk AGENTS.md

Repository instructions for Contentful's user-interface extensions software kit, which lets developers build apps that extend Contentful. They explain the project identity, ownership, important files, and rules for preserving its public programming interface.

In plain words
What is it for?
Use them when navigating the repository, changing the SDK, working with its published packages, or preparing tests and pull requests.
Why use it?
They help an agent make compatible changes in a shared software library used by many other applications.

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/ui-extensions-sdk/agents-md
Clone the repo
git clone --depth 1 https://github.com/contentful/ui-extensions-sdk

Made for: Codex, OpenCode.

Per session 2,027 This file is loaded in full into every session.
When invoked 2,027 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.02027 $0.02027
Opus 5 $0.01014 $0.01014
Sonnet 5 $0.00405 $0.00405
Haiku 4.5 $0.00203 $0.00203

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

Security

Grade A, and why

ui-extensions-sdk 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 · 96 lines

How it starts

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

Agent Guide — ui-extensions-sdk

Identity

This is the ui-extensions-sdk repository (github.com/contentful/ui-extensions-sdk). It builds and publishes the App SDK to npm under two package names: @contentful/app-sdk (preferred — use this in all new code, examples, and documentation) and contentful-ui-extensions-sdk (legacy alias retained for installed-base compatibility). Repo name and package names diverged for historical reasons; do not rename the repo.

Ownership

@contentful/team-extensibility and @contentful/team-marketplace (co-owned per .github/CODEOWNERS).

Where to look

You want to… Read this
Understand the runtime + build pipeline ARCHITECTURE.md
Develop locally / run tests / open a PR CONTRIBUTING.md
See the consumer-facing reference Contentful Docs — App SDK Reference

Sharp edges (do not violate)

  1. Public types are a contract. Changing or removing any export from lib/types/index.ts is a breaking change. Hundreds of customer apps and many internal Contentful repos consume these types. A breaking change requires a feat!: commit + BREAKING CHANGE: footer (the major bump is otherwise silently dropped without the footer).

  2. Bundle size is policed by CI. npm run size reports gzipped bytes of dist/cf-extension-api.js after every build. Adding a runtime dependency or a heavy utility is almost always the wrong move — contentful-management is currently the only runtime dep. Re-implementing a small helper inline beats pulling in a package.

  3. PostMessage is the only transport. All host communication routes through lib/channel.ts. Do not add direct DOM, fetch, or global-window access for host operations. If you need a new capability from the host, add a method on the channel and contract its protocol with the web app team.

Read the full file on GitHub · 96 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 · 96 lines · 2,027 tokens per session scan A 0869060ed82c

Subscribe to this mod's changes

ui-extensions-sdk AGENTS.md is an instructions file published in the GitHub repository contentful/ui-extensions-sdk (131 stars, last pushed 3d ago), licensed MIT. It adds 2,027 tokens to every session, about $0.0101 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.

Related

Other instructions, from other repositories

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

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 · 6,785 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 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,345 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, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

next.js 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,296 tokens