Skip to content

Simplify generated AGENTS.md to use live docs - #15384

Open
acoyfellow wants to merge 2 commits into
cloudflare:mainfrom
acoyfellow:jordan/devx-2642-minimal-agents-shim
Open

Simplify generated AGENTS.md to use live docs#15384
acoyfellow wants to merge 2 commits into
cloudflare:mainfrom
acoyfellow:jordan/devx-2642-minimal-agents-shim

Conversation

@acoyfellow

@acoyfellow acoyfellow commented Aug 27, 2026

Copy link
Copy Markdown

Tracks DEVX-2642 internally.

Summary

Create Cloudflare currently generates an AGENTS.md with a fixed list of commands, products, limits, error guidance, and best-practice links. That content can become stale as Cloudflare products and documentation change.

This change replaces the fixed inventory with a small retrieval instruction:

# Cloudflare Workers

Always retrieve current Cloudflare documentation before writing or changing Cloudflare code. Do not rely on training data for APIs, configuration, limits, or best practices.

Start at https://developers.cloudflare.com/llms.txt. Choose the relevant product's `llms.txt`, then retrieve only the specific Markdown pages needed for the task.

The root documentation index remains stable while product-specific guidance can change in the documentation without requiring a Create Cloudflare release. Asking agents to retrieve only the pages needed for the task also keeps generated context small.

This deliberately differs from #14775, which expands the generated file with Local Explorer endpoints. The intent here is to keep product instructions in the live documentation and keep the generated file as the durable entry point to that documentation.


  • Tests
    • Tests included/updated
    • Automated tests not possible - manual testing has been completed as follows:
    • Additional testing not necessary because:
  • Public documentation
    • Cloudflare docs PR(s):
    • Documentation not necessary because: this changes generated agent guidance and does not change user-facing product behavior

Validation:

  • pnpm run test:ci in packages/create-cloudflare: 261 tests passed
  • pnpm run check:type in packages/create-cloudflare
  • pnpm run build in packages/create-cloudflare
  • oxlint --deny-warnings --type-aware for the changed TypeScript files
  • oxfmt --check for the changed files

Devin Review

@changeset-bot

changeset-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 9e36881

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
create-cloudflare Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-project-automation github-project-automation Bot moved this to Untriaged in workers-sdk Aug 27, 2026
@workers-devprod
workers-devprod requested review from a team and dario-piotrowicz and removed request for a team August 27, 2026 10:42
@workers-devprod

workers-devprod commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Codeowners approval required for this PR:

  • ✅ @cloudflare/wrangler
Show detailed file reviewers

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@pkg-pr-new

pkg-pr-new Bot commented Aug 27, 2026

Copy link
Copy Markdown
@cloudflare/autoconfig

npm i https://pkg.pr.new/@cloudflare/autoconfig@15384

@cloudflare/build-output-utils

npm i https://pkg.pr.new/@cloudflare/build-output-utils@15384

@cloudflare/codemods

npm i https://pkg.pr.new/@cloudflare/codemods@15384

@cloudflare/config

npm i https://pkg.pr.new/@cloudflare/config@15384

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@15384

@cloudflare/deploy-helpers

npm i https://pkg.pr.new/@cloudflare/deploy-helpers@15384

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@15384

miniflare

npm i https://pkg.pr.new/miniflare@15384

@cloudflare/pages-functions

npm i https://pkg.pr.new/@cloudflare/pages-functions@15384

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@15384

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@15384

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@15384

@cloudflare/vitest-plugin

npm i https://pkg.pr.new/@cloudflare/vitest-plugin@15384

@cloudflare/workers-auth

npm i https://pkg.pr.new/@cloudflare/workers-auth@15384

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@15384

@cloudflare/workers-utils

npm i https://pkg.pr.new/@cloudflare/workers-utils@15384

wrangler

npm i https://pkg.pr.new/wrangler@15384

commit: 9e36881

@dario-piotrowicz dario-piotrowicz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with one small suggestion 🙂

Comment thread packages/create-cloudflare/src/__tests__/agents-md.test.ts Outdated

@workers-devprod workers-devprod left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codeowners reviews satisfied

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

3 participants