Skip to content

[Agents] Add a Guides section with a debugging guide - #35058

Open
mattzcarey wants to merge 1 commit into
productionfrom
docs/agents-debugging-guide
Open

mattzcarey wants to merge 1 commit into
productionfrom
docs/agents-debugging-guide

Conversation

@mattzcarey

Copy link
Copy Markdown
Member

Adds a Guides section to the Agents docs, starting with a guide to debugging agents on a Durable Object with the Lifecycle.

The guide follows the order things go wrong in:

  • running locally, addressing the right object, and resetting local storage
  • logs with wrangler tail and Workers Logs, diagnostics channel events, and tracing
  • an inspect RPC method that shows storage and the Lifecycle job queue, and opening the local SQLite file directly
  • common failures: startup that throws, RPC before startup, alarms that never fire or retry forever, jobs that run twice, the memory-limit breaker, and WebSocket routing
  • debugging a Pi harness run with pending(), onReport, and session.watch()

/agents/guides/ redirected to the MCP guides. That redirect is removed so the new index can serve the path. The other /agents/guides/* redirects stay.

Code samples typecheck against agents@0.33.0 and Pi 1.5. Internal links resolve and the pages compile as MDX. Replaces #34727.

@mattzcarey
mattzcarey requested review from a team, irvinebroque and rita3ko as code owners November 9, 2026 19:20
@github-actions github-actions Bot added the product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. label Nov 9, 2026
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

AI Review

✅ Reviewed 264b976 · 0 findings · incremental

Commands
  • /review Run a review now.
  • /full-review Review the entire PR diff.
  • /disable-auto-review Stop automatic reviews.
  • /rebase Rebase against production.

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Review coverage

✅ All 2 ownership areas are covered.

✅ 2 areas already covered
Area Approved by
Other
1 file changed
/public/__redirects
irvinebroque
agents
2 files changed
irvinebroque
CODEOWNERS mappings for displayed areas (2)
Pattern Owners
/public/__redirects @cloudflare/product-owners, @cloudflare/content-engineering
/src/content/docs/agents/ @irvinebroque, @rita3ko, @cloudflare/ai-agents, @cloudflare/dev-plat-leads, @cloudflare/product-owners

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://docs-agents-debugging-guide.previews.developers.cloudflare.com (commit 264b976)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://b6e2a721.previews.developers.cloudflare.com 264b976 2026-11-09T19:34:15.817Z Visit the dashboard ↗

@irvinebroque irvinebroque 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.

where does all of this come from?

@neelakolkar-cf

Copy link
Copy Markdown
Collaborator

@mattzcarey All approved and ready, please merge whenever all changes are done, thanks! 🙌

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

Labels

product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants