[Agents] Restructure docs#31098
Conversation
thomasgauvin
requested review from
a team,
GregBrimble,
MattieTK,
WalshyDev,
elithrar,
irvinebroque,
kodster28,
korinne,
mikenomitch,
rita3ko,
threepointone and
whoiskatrin
as code owners
github-actions
Bot
added
product:workers
Review⏸️ Automatic reviews for this PR are paused. This PR has already received 2 automatic reviews. To run another review, a codeowner can comment
⏸️ Automatic reviews for this PR are paused. This PR has already received 2 automatic reviews. To run another review, a codeowner can comment
💡 1 suggestion found in commit Suggestions (1)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
github-actions
Bot
assigned
kodster28,
elithrar,
irvinebroque,
rita3ko,
threepointone,
whoiskatrin,
GregBrimble and
korinne
|
This PR requires additional review attention because it affects the following areas: RedirectsThis PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
CI run failed: build logs |
Broken LinksFound 49 broken link(s) across 29 file(s).
|
- Rename concept page title to Conversation state and memory (order 4) - Rename MCP top-level title to Model Context Protocol (MCP) - Update RAG title and diagram label to Retrieval Augmented Generation (RAG) - Add redirect for /agents/concepts/memory/
irvinebroque
left a comment
irvinebroque
left a comment
There was a problem hiding this comment.
- Diagram is killer 🙌
- A lot of the examples don't use Think, but also don't use another harness. If I'm coming in here and I read the diagram and "get it" that the Agents SDK is the runtime for the harness, and then I read an example, I have questions like, wait - what harness is being used here?
🚀 🚀 🚀 non-blocking, we can keep making better and better (though I do think really showing many harnesses will help orient people, and will help people understand what Think is by having things to reference against, etc.)
| </div> | ||
| <div class="section-row"> | ||
| <a href="/agents/harnesses/think/">Project Think</a> | ||
| <a href="/agents/runtime/agents-api/">Build-your-own agent</a> |
There was a problem hiding this comment.
Seems like having docs for other harnesses will help people truly get it that Project Think is a harness?
Like if I see that there is:
- Project Think
- Pi
- Codex
- Flue
All together then no matter what my frame of reference is for what I am familiar with or not (not everyone will know all of these) then I "get it" even if I am still somewhat shaky on what a harness is, etc.
There was a problem hiding this comment.
I agree, need to assess the viability of hosting all these on top of agents sdk runtime, we're looking into it
There was a problem hiding this comment.
| @@ -0,0 +1,434 @@ | |||
| --- | |||
There was a problem hiding this comment.
love that this diagram is interactive, clever
| Agents on Cloudflare are composed from four parts: | ||
|
|
||
| - **Communication channels** define how users and systems reach your agent, such as [chat](/agents/communication-channels/chat/), [voice](/agents/communication-channels/voice/), [email](/agents/communication-channels/email/), [Slack](/agents/communication-channels/slack/), [webhooks](/agents/communication-channels/webhooks/), and other event sources. | ||
| - **The agent harness** defines the loop: how the agent calls models, selects tools, handles tool results, streams responses, and decides whether to continue. Use [Project Think](/agents/harnesses/think/) for an opinionated harness, or build your own loop directly on the [Agents SDK runtime](/agents/runtime/agents-api/). |
There was a problem hiding this comment.
Even if minimal, is there a path to show pi and flue as other harnesses that is possible to use?
Both so that people "get it" on what Think is and so that people understand that building agents on Cloudflare isn't "use Think or build the whole thing yourself" - I feel like i have options if presented to me, and therefore more comfortable betting on the Cloudflare-native way in Think
There was a problem hiding this comment.
Yes, we will be iterating, this is just a first PR to restructure and we will have separate PRs for entirely new pages/big changes
| <AgentsPlatformDiagram /> | ||
|
|
||
| The mental model is simple: define a TypeScript class, give each real-world thing a stable name, and route requests or WebSocket connections to that named instance. The instance wakes when something happens, reads its durable state, does work, and hibernates when idle. | ||
| Agents on Cloudflare are composed from four parts: |
There was a problem hiding this comment.
This part is so strong and clear that might even lead with it
| <AgentsPlatformDiagram /> | ||
|
|
||
| The mental model is simple: define a TypeScript class, give each real-world thing a stable name, and route requests or WebSocket connections to that named instance. The instance wakes when something happens, reads its durable state, does work, and hibernates when idle. | ||
| Agents on Cloudflare are composed from four parts: |
There was a problem hiding this comment.
I do think we are maybe missing inference from this? i.e. — that you can use any model, that there is AI Gateway that supports hosted Workers AI models and hosted models, etc.
| The starter includes streaming AI chat, server-side and client-side tools, human-in-the-loop approval, and task scheduling — a foundation you can build on or tear apart. You can also swap in [OpenAI, Anthropic, Google Gemini, or any other provider](/agents/runtime/operations/using-ai-models/). | ||
|
|
||
| <TypeScriptExample> | ||
| ### Example agents |
There was a problem hiding this comment.
YES - love putting this front and center here with clear use cases
|
|
||
| Check the [GitHub page](https://github.com/cloudflare/mcp-server-cloudflare) to learn how to use Cloudflare's remote MCP servers with different MCP clients. | ||
|
|
||
| ## Cloudflare Community MCP server |
There was a problem hiding this comment.
I'm not quite sure I follow why this is here?
We should probably update these docs to be clearer that the Code Mode MCP server is the MCP server and de-emphasize the rest?
There was a problem hiding this comment.
I agree with you. Right now, I'm consolidating the Cloudflare Community MCP server which was previously a TOP level item (!!) (https://developers.cloudflare.com/agents/community-mcp-server/) into where it should be alongside our other MCP servers (https://developers.cloudflare.com/agents/model-context-protocol/mcp-servers-for-cloudflare/)
But yes, we need to lead with codemode, I will fix in a separate PR after this one merges because it's already big
|
This is going to be a big PR. I will try to keep this PR limited to restructuring only, and avoid content changes to keep reviewability doable |
Co-authored-by: Brendan Irvine-Broque <birvine-broque@cloudflare.com>
- Constrain binding pills so long tool names ellipsize instead of overflowing the card - Tighten grid gap and columns for more room - Shorten diagram RAG label
- Show single feature label per channel/tool pill (drop secondary value) - Shorten Channels card title so it no longer wraps - Match button roundness to cards (8px rounded rectangles)
11 participants
No description provided.