Skip to content

Commit 9165f73

Browse files
vb-openaivb-openai
committed
Add Cloudflare Wrangler and Agents SDK skills
1 parent 026fac5 commit 9165f73

File tree

17 files changed

+2545
-0
lines changed

17 files changed

+2545
-0
lines changed

‎plugins/cloudflare/skills/agents-sdk/LICENSE.txt‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf of
171+
any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don\'t include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎plugins/cloudflare/skills/agents-sdk/SKILL.md‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
---
2+
name: agents-sdk
3+
description: Build AI agents on Cloudflare Workers using the Agents SDK. Load when creating stateful agents, durable workflows, real-time WebSocket apps, scheduled tasks, MCP servers, or chat applications. Covers Agent class, state management, callable RPC, Workflows integration, and React hooks. Biases towards retrieval from Cloudflare docs over pre-trained knowledge.
4+
---
5+
6+
# Cloudflare Agents SDK
7+
8+
Your knowledge of the Agents SDK may be outdated. **Prefer retrieval over pre-training** for any Agents SDK task.
9+
10+
## Retrieval Sources
11+
12+
Fetch current docs from `https://github.com/cloudflare/agents/tree/main/docs` before implementing.
13+
14+
| Topic | Doc | Use for |
15+
|-------|-----|---------|
16+
| Getting started | `docs/getting-started.md` | First agent, project setup |
17+
| State | `docs/state.md` | `setState`, `validateStateChange`, persistence |
18+
| Routing | `docs/routing.md` | URL patterns, `routeAgentRequest`, `basePath` |
19+
| Callable methods | `docs/callable-methods.md` | `@callable`, RPC, streaming, timeouts |
20+
| Scheduling | `docs/scheduling.md` | `schedule()`, `scheduleEvery()`, cron |
21+
| Workflows | `docs/workflows.md` | `AgentWorkflow`, durable multi-step tasks |
22+
| HTTP/WebSockets | `docs/http-websockets.md` | Lifecycle hooks, hibernation |
23+
| Email | `docs/email.md` | Email routing, secure reply resolver |
24+
| MCP client | `docs/mcp-client.md` | Connecting to MCP servers |
25+
| MCP server | `docs/mcp-servers.md` | Building MCP servers with `McpAgent` |
26+
| Client SDK | `docs/client-sdk.md` | `useAgent`, `useAgentChat`, React hooks |
27+
| Human-in-the-loop | `docs/human-in-the-loop.md` | Approval flows, pausing workflows |
28+
| Resumable streaming | `docs/resumable-streaming.md` | Stream recovery on disconnect |
29+
30+
Cloudflare docs: https://developers.cloudflare.com/agents/
31+
32+
## Capabilities
33+
34+
The Agents SDK provides:
35+
36+
- **Persistent state** - SQLite-backed, auto-synced to clients
37+
- **Callable RPC** - `@callable()` methods invoked over WebSocket
38+
- **Scheduling** - One-time, recurring (`scheduleEvery`), and cron tasks
39+
- **Workflows** - Durable multi-step background processing via `AgentWorkflow`
40+
- **MCP integration** - Connect to MCP servers or build your own with `McpAgent`
41+
- **Email handling** - Receive and reply to emails with secure routing
42+
- **Streaming chat** - `AIChatAgent` with resumable streams
43+
- **React hooks** - `useAgent`, `useAgentChat` for client apps
44+
45+
## FIRST: Verify Installation
46+
47+
```bash
48+
npm ls agents # Should show agents package
49+
```
50+
51+
If not installed:
52+
```bash
53+
npm install agents
54+
```
55+
56+
## Wrangler Configuration
57+
58+
```jsonc
59+
{
60+
"durable_objects": {
61+
"bindings": [{ "name": "MyAgent", "class_name": "MyAgent" }]
62+
},
63+
"migrations": [{ "tag": "v1", "new_sqlite_classes": ["MyAgent"] }]
64+
}
65+
```
66+
67+
## Agent Class
68+
69+
```typescript
70+
import { Agent, routeAgentRequest, callable } from "agents";
71+
72+
type State = { count: number };
73+
74+
export class Counter extends Agent<Env, State> {
75+
initialState = { count: 0 };
76+
77+
// Validation hook - runs before state persists (sync, throwing rejects the update)
78+
validateStateChange(nextState: State, source: Connection | "server") {
79+
if (nextState.count < 0) throw new Error("Count cannot be negative");
80+
}
81+
82+
// Notification hook - runs after state persists (async, non-blocking)
83+
onStateUpdate(state: State, source: Connection | "server") {
84+
console.log("State updated:", state);
85+
}
86+
87+
@callable()
88+
increment() {
89+
this.setState({ count: this.state.count + 1 });
90+
return this.state.count;
91+
}
92+
}
93+
94+
export default {
95+
fetch: (req, env) => routeAgentRequest(req, env) ?? new Response("Not found", { status: 404 })
96+
};
97+
```
98+
99+
## Routing
100+
101+
Requests route to `/agents/{agent-name}/{instance-name}`:
102+
103+
| Class | URL |
104+
|-------|-----|
105+
| `Counter` | `/agents/counter/user-123` |
106+
| `ChatRoom` | `/agents/chat-room/lobby` |
107+
108+
Client: `useAgent({ agent: "Counter", name: "user-123" })`
109+
110+
## Core APIs
111+
112+
| Task | API |
113+
|------|-----|
114+
| Read state | `this.state.count` |
115+
| Write state | `this.setState({ count: 1 })` |
116+
| SQL query | `` this.sql`SELECT * FROM users WHERE id = ${id}` `` |
117+
| Schedule (delay) | `await this.schedule(60, "task", payload)` |
118+
| Schedule (cron) | `await this.schedule("0 * * * *", "task", payload)` |
119+
| Schedule (interval) | `await this.scheduleEvery(30, "poll")` |
120+
| RPC method | `@callable() myMethod() { ... }` |
121+
| Streaming RPC | `@callable({ streaming: true }) stream(res) { ... }` |
122+
| Start workflow | `await this.runWorkflow("ProcessingWorkflow", params)` |
123+
124+
## React Client
125+
126+
```tsx
127+
import { useAgent } from "agents/react";
128+
129+
function App() {
130+
const [state, setLocalState] = useState({ count: 0 });
131+
132+
const agent = useAgent({
133+
agent: "Counter",
134+
name: "my-instance",
135+
onStateUpdate: (newState) => setLocalState(newState),
136+
onIdentity: (name, agentType) => console.log(`Connected to ${name}`)
137+
});
138+
139+
return (
140+
<button onClick={() => agent.setState({ count: state.count + 1 })}>
141+
Count: {state.count}
142+
</button>
143+
);
144+
}
145+
```
146+
147+
## References
148+
149+
- **[references/workflows.md](references/workflows.md)** - Durable Workflows integration
150+
- **[references/callable.md](references/callable.md)** - RPC methods, streaming, timeouts
151+
- **[references/state-scheduling.md](references/state-scheduling.md)** - State persistence, scheduling
152+
- **[references/streaming-chat.md](references/streaming-chat.md)** - AIChatAgent, resumable streams
153+
- **[references/mcp.md](references/mcp.md)** - MCP server integration
154+
- **[references/email.md](references/email.md)** - Email routing and handling
155+
- **[references/codemode.md](references/codemode.md)** - Code Mode (experimental)

‎plugins/cloudflare/skills/agents-sdk/agents/openai.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
interface:
2+
display_name: "Cloudflare Agents SDK"
3+
short_description: "Build stateful agents on Cloudflare Workers"
4+
icon_small: "./assets/cloudflare-small.svg"
5+
icon_large: "./assets/cloudflare.png"
6+
default_prompt: "Use the Cloudflare Agents SDK to design or implement this agent on Workers with the right state, routing, and workflow patterns."

‎plugins/cloudflare/skills/agents-sdk/assets/cloudflare-small.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎plugins/cloudflare/skills/agents-sdk/assets/cloudflare.png‎

1.16 KB
Loading

0 commit comments

Comments
 (0)