copilotkit 4.8.4 → 4.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -5
- package/cli-build-info.json +7 -7
- package/index.js +647 -124
- package/onboarding/index.json +140 -1
- package/onboarding/prompts/authenticate/start.md +47 -10
- package/onboarding/prompts/credentials/finalize-plan.md +64 -14
- package/onboarding/prompts/credentials/plan.md +54 -16
- package/onboarding/prompts/fallback/best-effort.md +36 -0
- package/onboarding/prompts/framework/ag2.md +48 -0
- package/onboarding/prompts/framework/agno.md +48 -0
- package/onboarding/prompts/framework/built-in.md +43 -0
- package/onboarding/prompts/framework/claude-sdk-python.md +49 -0
- package/onboarding/prompts/framework/claude-sdk-typescript.md +53 -0
- package/onboarding/prompts/framework/crewai-flows.md +56 -0
- package/onboarding/prompts/framework/deep-agents.md +45 -0
- package/onboarding/prompts/framework/google-adk.md +8 -3
- package/onboarding/prompts/framework/langgraph-fastapi.md +42 -0
- package/onboarding/prompts/framework/langgraph-python.md +8 -3
- package/onboarding/prompts/framework/langgraph-typescript.md +8 -3
- package/onboarding/prompts/framework/llamaindex.md +51 -0
- package/onboarding/prompts/framework/mastra.md +8 -3
- package/onboarding/prompts/framework/ms-agent-dotnet.md +8 -3
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +62 -0
- package/onboarding/prompts/framework/ms-agent-python.md +8 -3
- package/onboarding/prompts/framework/pydantic-ai.md +48 -0
- package/onboarding/prompts/framework/strands-python.md +42 -0
- package/onboarding/prompts/framework/strands-typescript.md +42 -0
- package/onboarding/prompts/frontend/angular.md +9 -3
- package/onboarding/prompts/frontend/nextjs.md +8 -3
- package/onboarding/prompts/frontend/plan.md +22 -10
- package/onboarding/prompts/frontend/react-native.md +9 -3
- package/onboarding/prompts/frontend/react-spa.md +20 -5
- package/onboarding/prompts/frontend/vue.md +9 -3
- package/onboarding/prompts/implementation/build-and-validate.md +12 -2
- package/onboarding/prompts/proof/complete.md +51 -16
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +51 -24
- package/onboarding/prompts/subagent/create-plan.md +14 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +10 -0
- package/onboarding/prompts/subagent/inspect-repository.md +6 -1
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +46 -21
- package/onboarding/prompts/unsupported/no-validated-path.md +23 -9
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
package/onboarding/index.json
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
"prompts": [
|
|
4
4
|
{
|
|
5
5
|
"edges": [
|
|
6
|
+
"proof/oss-baseline",
|
|
6
7
|
"credentials/plan",
|
|
7
8
|
"unsupported/no-validated-path"
|
|
8
9
|
],
|
|
@@ -19,17 +20,91 @@
|
|
|
19
20
|
},
|
|
20
21
|
{
|
|
21
22
|
"edges": [
|
|
23
|
+
"framework/ag2",
|
|
24
|
+
"framework/agno",
|
|
25
|
+
"framework/built-in",
|
|
26
|
+
"framework/claude-sdk-python",
|
|
27
|
+
"framework/claude-sdk-typescript",
|
|
28
|
+
"framework/crewai-flows",
|
|
29
|
+
"framework/deep-agents",
|
|
22
30
|
"framework/langgraph-python",
|
|
31
|
+
"framework/langgraph-fastapi",
|
|
23
32
|
"framework/langgraph-typescript",
|
|
33
|
+
"framework/llamaindex",
|
|
24
34
|
"framework/google-adk",
|
|
25
35
|
"framework/ms-agent-python",
|
|
26
36
|
"framework/ms-agent-dotnet",
|
|
27
37
|
"framework/mastra",
|
|
38
|
+
"framework/ms-agent-harness-dotnet",
|
|
39
|
+
"framework/pydantic-ai",
|
|
40
|
+
"framework/strands-python",
|
|
41
|
+
"framework/strands-typescript",
|
|
28
42
|
"unsupported/no-validated-path"
|
|
29
43
|
],
|
|
30
44
|
"milestone": "credentials",
|
|
31
45
|
"name": "credentials/plan"
|
|
32
46
|
},
|
|
47
|
+
{
|
|
48
|
+
"edges": [],
|
|
49
|
+
"milestone": "fallback",
|
|
50
|
+
"name": "fallback/best-effort"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"edges": [
|
|
54
|
+
"frontend/plan",
|
|
55
|
+
"unsupported/no-validated-path"
|
|
56
|
+
],
|
|
57
|
+
"milestone": "framework",
|
|
58
|
+
"name": "framework/ag2"
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
"edges": [
|
|
62
|
+
"frontend/plan",
|
|
63
|
+
"unsupported/no-validated-path"
|
|
64
|
+
],
|
|
65
|
+
"milestone": "framework",
|
|
66
|
+
"name": "framework/agno"
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
"edges": [
|
|
70
|
+
"frontend/plan",
|
|
71
|
+
"unsupported/no-validated-path"
|
|
72
|
+
],
|
|
73
|
+
"milestone": "framework",
|
|
74
|
+
"name": "framework/built-in"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"edges": [
|
|
78
|
+
"frontend/plan",
|
|
79
|
+
"unsupported/no-validated-path"
|
|
80
|
+
],
|
|
81
|
+
"milestone": "framework",
|
|
82
|
+
"name": "framework/claude-sdk-python"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"edges": [
|
|
86
|
+
"frontend/plan",
|
|
87
|
+
"unsupported/no-validated-path"
|
|
88
|
+
],
|
|
89
|
+
"milestone": "framework",
|
|
90
|
+
"name": "framework/claude-sdk-typescript"
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"edges": [
|
|
94
|
+
"frontend/plan",
|
|
95
|
+
"unsupported/no-validated-path"
|
|
96
|
+
],
|
|
97
|
+
"milestone": "framework",
|
|
98
|
+
"name": "framework/crewai-flows"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"edges": [
|
|
102
|
+
"frontend/plan",
|
|
103
|
+
"unsupported/no-validated-path"
|
|
104
|
+
],
|
|
105
|
+
"milestone": "framework",
|
|
106
|
+
"name": "framework/deep-agents"
|
|
107
|
+
},
|
|
33
108
|
{
|
|
34
109
|
"edges": [
|
|
35
110
|
"frontend/plan",
|
|
@@ -38,6 +113,14 @@
|
|
|
38
113
|
"milestone": "framework",
|
|
39
114
|
"name": "framework/google-adk"
|
|
40
115
|
},
|
|
116
|
+
{
|
|
117
|
+
"edges": [
|
|
118
|
+
"frontend/plan",
|
|
119
|
+
"unsupported/no-validated-path"
|
|
120
|
+
],
|
|
121
|
+
"milestone": "framework",
|
|
122
|
+
"name": "framework/langgraph-fastapi"
|
|
123
|
+
},
|
|
41
124
|
{
|
|
42
125
|
"edges": [
|
|
43
126
|
"frontend/plan",
|
|
@@ -54,6 +137,14 @@
|
|
|
54
137
|
"milestone": "framework",
|
|
55
138
|
"name": "framework/langgraph-typescript"
|
|
56
139
|
},
|
|
140
|
+
{
|
|
141
|
+
"edges": [
|
|
142
|
+
"frontend/plan",
|
|
143
|
+
"unsupported/no-validated-path"
|
|
144
|
+
],
|
|
145
|
+
"milestone": "framework",
|
|
146
|
+
"name": "framework/llamaindex"
|
|
147
|
+
},
|
|
57
148
|
{
|
|
58
149
|
"edges": [
|
|
59
150
|
"frontend/plan",
|
|
@@ -70,6 +161,14 @@
|
|
|
70
161
|
"milestone": "framework",
|
|
71
162
|
"name": "framework/ms-agent-dotnet"
|
|
72
163
|
},
|
|
164
|
+
{
|
|
165
|
+
"edges": [
|
|
166
|
+
"frontend/plan",
|
|
167
|
+
"unsupported/no-validated-path"
|
|
168
|
+
],
|
|
169
|
+
"milestone": "framework",
|
|
170
|
+
"name": "framework/ms-agent-harness-dotnet"
|
|
171
|
+
},
|
|
73
172
|
{
|
|
74
173
|
"edges": [
|
|
75
174
|
"frontend/plan",
|
|
@@ -78,6 +177,30 @@
|
|
|
78
177
|
"milestone": "framework",
|
|
79
178
|
"name": "framework/ms-agent-python"
|
|
80
179
|
},
|
|
180
|
+
{
|
|
181
|
+
"edges": [
|
|
182
|
+
"frontend/plan",
|
|
183
|
+
"unsupported/no-validated-path"
|
|
184
|
+
],
|
|
185
|
+
"milestone": "framework",
|
|
186
|
+
"name": "framework/pydantic-ai"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"edges": [
|
|
190
|
+
"frontend/plan",
|
|
191
|
+
"unsupported/no-validated-path"
|
|
192
|
+
],
|
|
193
|
+
"milestone": "framework",
|
|
194
|
+
"name": "framework/strands-python"
|
|
195
|
+
},
|
|
196
|
+
{
|
|
197
|
+
"edges": [
|
|
198
|
+
"frontend/plan",
|
|
199
|
+
"unsupported/no-validated-path"
|
|
200
|
+
],
|
|
201
|
+
"milestone": "framework",
|
|
202
|
+
"name": "framework/strands-typescript"
|
|
203
|
+
},
|
|
81
204
|
{
|
|
82
205
|
"edges": [
|
|
83
206
|
"credentials/finalize-plan",
|
|
@@ -116,6 +239,7 @@
|
|
|
116
239
|
},
|
|
117
240
|
{
|
|
118
241
|
"edges": [
|
|
242
|
+
"credentials/finalize-plan",
|
|
119
243
|
"unsupported/no-validated-path"
|
|
120
244
|
],
|
|
121
245
|
"milestone": "frontend",
|
|
@@ -142,6 +266,14 @@
|
|
|
142
266
|
"milestone": "proof",
|
|
143
267
|
"name": "proof/complete"
|
|
144
268
|
},
|
|
269
|
+
{
|
|
270
|
+
"edges": [
|
|
271
|
+
"credentials/plan",
|
|
272
|
+
"unsupported/no-validated-path"
|
|
273
|
+
],
|
|
274
|
+
"milestone": "proof",
|
|
275
|
+
"name": "proof/oss-baseline"
|
|
276
|
+
},
|
|
145
277
|
{
|
|
146
278
|
"edges": [
|
|
147
279
|
"proof/complete",
|
|
@@ -168,10 +300,17 @@
|
|
|
168
300
|
{
|
|
169
301
|
"edges": [],
|
|
170
302
|
"milestone": "subagent",
|
|
171
|
-
"name": "subagent/prove-
|
|
303
|
+
"name": "subagent/prove-oss-baseline"
|
|
172
304
|
},
|
|
173
305
|
{
|
|
174
306
|
"edges": [],
|
|
307
|
+
"milestone": "subagent",
|
|
308
|
+
"name": "subagent/prove-round-trip"
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"edges": [
|
|
312
|
+
"fallback/best-effort"
|
|
313
|
+
],
|
|
175
314
|
"milestone": "unsupported",
|
|
176
315
|
"name": "unsupported/no-validated-path"
|
|
177
316
|
}
|
|
@@ -14,19 +14,38 @@ question from the documentation this graph gives you. Another checkout on this m
|
|
|
14
14
|
not a source. The developer running this has none, so an answer taken from one is an
|
|
15
15
|
answer they cannot get, and it hides the documentation gap that blocks them.
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
current session. It starts sign-in only as needed.
|
|
17
|
+
Before you run a command or spawn a subagent, send this exact message:
|
|
19
18
|
|
|
20
|
-
|
|
19
|
+
Welcome to CopilotKit. I will check sign-in, inspect your project, recommend a setup, and
|
|
20
|
+
show you a plan before I change files. After you approve the plan, I will build the
|
|
21
|
+
integration, prove the full round trip, and leave the app running with its URLs.
|
|
21
22
|
|
|
22
|
-
|
|
23
|
+
Do not ask for separate feedback consent. The feedback commands enforce the developer's
|
|
24
|
+
CLI telemetry setting when a later step tries to send a report.
|
|
25
|
+
|
|
26
|
+
Run `npx --yes copilotkit@4.9.1 login --json` before any project work. This command
|
|
27
|
+
checks the current session. It starts sign-in only as needed. Treat this as a long-lived
|
|
28
|
+
streaming process. Do not wait for the command to exit before you read its standard output.
|
|
29
|
+
|
|
30
|
+
Read each JSON Lines record as the running command writes it:
|
|
31
|
+
|
|
32
|
+
1. If the process emits `authentication_url`, show the `authentication_url` to the
|
|
33
|
+
developer as soon as that line arrives. The process is still running.
|
|
23
34
|
2. Tell the developer to open the URL and finish sign-in.
|
|
24
|
-
3.
|
|
25
|
-
|
|
35
|
+
3. Keep monitoring the same process after you show the URL. Do not start a second login
|
|
36
|
+
command.
|
|
37
|
+
4. Continue onboarding only after that same process emits `type: completed`.
|
|
38
|
+
5. If that process emits `type: failed`, report the error and stop onboarding.
|
|
26
39
|
|
|
27
40
|
Do not use `whoami` for this check. It has no JSON output and some failures exit with code
|
|
28
41
|
zero. Do not put account tokens or credentials in the conversation.
|
|
29
42
|
|
|
43
|
+
Before you ask the developer any setup question, finish every read-only investigation and
|
|
44
|
+
preflight check in this section. Record whether your coding-agent environment has browser
|
|
45
|
+
or device control. Use the control that matches the selected surface later. Do not install
|
|
46
|
+
a browser or device tool during this preflight. Do not ask the developer about this tool
|
|
47
|
+
limit.
|
|
48
|
+
|
|
30
49
|
Spawn one research subagent. Give it the full text of the research brief at the end of this
|
|
31
50
|
prompt and tell it to follow that brief and return only its findings. Add these tasks:
|
|
32
51
|
|
|
@@ -34,10 +53,18 @@ prompt and tell it to follow that brief and return only its findings. Add these
|
|
|
34
53
|
- Check whether `.copilotkit/project.json` has `projectId`, `projectSlug`, and `clerkOrgId`.
|
|
35
54
|
- Check whether `.env` has a non-empty `INTELLIGENCE_API_KEY` entry.
|
|
36
55
|
- Record the `.env` file modification time without returning it.
|
|
56
|
+
- Report whether an agent, frontend, and CopilotKit integration are present.
|
|
57
|
+
- Report whether the runtime constructor uses a `runner` option, an `intelligence`
|
|
58
|
+
option, or neither can be proved from project files.
|
|
37
59
|
|
|
38
60
|
Do not print either file or any secret value. Return only paths, presence checks, and missing
|
|
39
61
|
field names. Wait for the subagent to finish.
|
|
40
62
|
|
|
63
|
+
If the findings show an empty project and do not prove its purpose, ask one guided question
|
|
64
|
+
about the user outcome. This asks what the developer wants to build before you select a
|
|
65
|
+
framework. Give two or three short examples and offer a minimal starter. Record the answer
|
|
66
|
+
and give it to each later subagent.
|
|
67
|
+
|
|
41
68
|
If a repository file exists, each finding must cite it. For an empty project, the subagent
|
|
42
69
|
must cite its directory check and report absent parts.
|
|
43
70
|
|
|
@@ -45,11 +72,16 @@ The findings must cover what the project is for, the agent, frontend, CopilotKit
|
|
|
45
72
|
authentication, credential names, and validation path. Do not ask the developer for facts
|
|
46
73
|
that the repository answers.
|
|
47
74
|
|
|
48
|
-
|
|
49
|
-
|
|
75
|
+
Do not infer a working OSS path from packages, imports, project files, or keys. If an
|
|
76
|
+
agent, frontend, and CopilotKit integration are present, prove the live starting state
|
|
77
|
+
before any project file changes. Run
|
|
78
|
+
`npx --yes copilotkit@4.9.1 onboard read proof/oss-baseline`.
|
|
79
|
+
|
|
80
|
+
For every other inspected state, run
|
|
81
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/plan`.
|
|
50
82
|
|
|
51
83
|
If authentication or inspection stops onboarding, run
|
|
52
|
-
`npx copilotkit@4.
|
|
84
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
53
85
|
|
|
54
86
|
## Research subagent brief
|
|
55
87
|
|
|
@@ -67,6 +99,10 @@ Inspect the repository without changing it. Find evidence for:
|
|
|
67
99
|
- current CopilotKit packages and configuration
|
|
68
100
|
- authentication boundaries
|
|
69
101
|
- names of required credential variables, without reading their values
|
|
102
|
+
- package manager and lockfile
|
|
103
|
+
- required toolchains and their installed versions
|
|
104
|
+
- declared ports and whether each port is available
|
|
105
|
+
- CopilotKit package versions and package compatibility risks
|
|
70
106
|
|
|
71
107
|
A project states what it is for in its `README.md`, in its package description, or in
|
|
72
108
|
the prompt of an agent it already has. Quote that statement rather than rewriting it. An
|
|
@@ -75,7 +111,8 @@ evidence. State the purpose as unproved when the project never says.
|
|
|
75
111
|
|
|
76
112
|
Gather what you need in as few commands as possible. Combine independent reads into one
|
|
77
113
|
command rather than running them one at a time. Split a command only when its result decides
|
|
78
|
-
what you run next.
|
|
114
|
+
what you run next. Keep this preflight read-only. Do not install packages, stop processes,
|
|
115
|
+
or change a port. Check only the toolchains and ports that repository files require.
|
|
79
116
|
|
|
80
117
|
Return the file paths and a short finding for each item. State each absent or unproved item.
|
|
81
118
|
Do not read, print, or return secret values. Do not read a file outside the project
|
|
@@ -5,6 +5,31 @@ repository findings. Ask the developer only for choices that the repository does
|
|
|
5
5
|
show. Do not change application code in this phase. Do not read, show, store, or request
|
|
6
6
|
a secret value.
|
|
7
7
|
|
|
8
|
+
Use a gentle wizard. Ask one short question at a time. Do not combine separate choices in
|
|
9
|
+
one question. Put the recommendation first, give its evidence in one sentence, and keep
|
|
10
|
+
the alternatives short. When project selection is unknown, ask only which Intelligence
|
|
11
|
+
project to use. Keep final plan approval as its own later question.
|
|
12
|
+
|
|
13
|
+
## Record the audit cell
|
|
14
|
+
|
|
15
|
+
Use the repository findings and selected choices to record the path before project work
|
|
16
|
+
starts. Choose one starting state: empty, agent-only, frontend-only, both, both-oss.
|
|
17
|
+
|
|
18
|
+
- `empty`: no agent and no frontend.
|
|
19
|
+
- `agent-only`: an agent and no frontend.
|
|
20
|
+
- `frontend-only`: a frontend and no agent.
|
|
21
|
+
- `both`: an agent and frontend that do not have a proved CopilotKit round trip.
|
|
22
|
+
- `both-oss`: an agent and frontend with the proved OSS CopilotKit baseline.
|
|
23
|
+
|
|
24
|
+
Run this command with the exact selected slugs:
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
npx --yes copilotkit@4.9.1 onboard classify --starting-state <starting-state> --agent-framework <agent-framework> --frontend <frontend>
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Do not continue if a value is refused. Fix the value from the choices that the earlier
|
|
31
|
+
prompts gave, then run the command again.
|
|
32
|
+
|
|
8
33
|
## Select the Intelligence project
|
|
9
34
|
|
|
10
35
|
Use the target app or runtime directory from the repository findings. If a nested app owns
|
|
@@ -20,31 +45,44 @@ succeeds. Record that state in the plan.
|
|
|
20
45
|
If the developer needs a project or another project, do the selection yourself from the
|
|
21
46
|
target directory. Do not send the developer to another terminal.
|
|
22
47
|
|
|
23
|
-
|
|
48
|
+
Read the choices first:
|
|
24
49
|
|
|
25
50
|
```text
|
|
26
|
-
npx copilotkit@4.
|
|
51
|
+
npx --yes copilotkit@4.9.1 project list --json
|
|
27
52
|
```
|
|
28
53
|
|
|
29
54
|
With `--json` the payload is the only thing on standard output, so it is safe to parse.
|
|
30
|
-
Show the
|
|
31
|
-
|
|
32
|
-
|
|
55
|
+
Show the current selection and the five most recent projects. Sort recency by `createdAt`.
|
|
56
|
+
Offer search, create-new, and list-all options. Do not show every project unless the
|
|
57
|
+
developer asks.
|
|
58
|
+
|
|
59
|
+
If the developer searches, run:
|
|
60
|
+
|
|
61
|
+
```text
|
|
62
|
+
npx --yes copilotkit@4.9.1 project list --search <query> --json
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
If the developer asks for all projects, show the result of the first list command. Ask
|
|
66
|
+
which project to use, or ask for a new project name. Do not combine this question with a
|
|
67
|
+
frontend, framework, model, credential, or plan-approval question.
|
|
33
68
|
|
|
34
69
|
Then record their answer, from the target directory:
|
|
35
70
|
|
|
36
71
|
```text
|
|
37
|
-
npx copilotkit@4.
|
|
72
|
+
npx --yes copilotkit@4.9.1 project select --project <slug-or-id> --json
|
|
38
73
|
```
|
|
39
74
|
|
|
40
75
|
Use `--create <name> --json` instead when they want a new project. The two flags cannot be
|
|
41
76
|
combined. A slug that does not exist fails and lists the real ones, so a typo cannot record
|
|
42
77
|
a selection that points at nothing.
|
|
43
78
|
|
|
44
|
-
Read the JSON result. It reports `api_key_provisioned
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
79
|
+
Read the JSON result. It reports `selected_project_slug`, `api_key_provisioned`,
|
|
80
|
+
`project_file_written`, and `environment_file_written` at the top level. The result does
|
|
81
|
+
not contain a secret. Report `selected_project_slug` as the project slug that the server
|
|
82
|
+
selected or created. Require `api_key_provisioned`, `project_file_written`, and
|
|
83
|
+
`environment_file_written` to be true. If one is false, report the error and stop
|
|
84
|
+
onboarding. Key provisioning is non-fatal, so the command can persist a selection and
|
|
85
|
+
still exit zero with no key. A scaffold with no key looks finished and is not.
|
|
48
86
|
|
|
49
87
|
Never print the payload or any secret value.
|
|
50
88
|
|
|
@@ -103,10 +141,10 @@ values.
|
|
|
103
141
|
Show only the selected framework, frontend, model, planned file changes, validation commands, and proof steps.
|
|
104
142
|
|
|
105
143
|
If the developer approves the plan, run
|
|
106
|
-
`npx copilotkit@4.
|
|
144
|
+
`npx --yes copilotkit@4.9.1 onboard read implementation/build-and-validate`.
|
|
107
145
|
|
|
108
146
|
If no exact supported path or documentation URL exists, run
|
|
109
|
-
`npx copilotkit@4.
|
|
147
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
110
148
|
|
|
111
149
|
## Planning subagent brief
|
|
112
150
|
|
|
@@ -120,6 +158,11 @@ Use the selected framework, frontend, model, repository findings, and documentat
|
|
|
120
158
|
from the main coding agent. Fetch every selected URL in one step rather than one after
|
|
121
159
|
another. Do not use remembered CopilotKit instructions.
|
|
122
160
|
|
|
161
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
162
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
163
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
164
|
+
documentation gap only after a second method also fails.
|
|
165
|
+
|
|
123
166
|
Name the application the project asks for, and plan that application. Each documentation
|
|
124
167
|
page teaches through one worked example, and that example carries a domain of its own.
|
|
125
168
|
The domain belongs to the page. The project's purpose from the repository findings
|
|
@@ -135,11 +178,18 @@ Preserve each agent or frontend that already exists.
|
|
|
135
178
|
|
|
136
179
|
Plan the runtime to consume the Intelligence credential. The runtime takes an
|
|
137
180
|
`intelligence` option holding a client built from the project key. A runtime given a
|
|
138
|
-
`runner` option instead is the
|
|
139
|
-
|
|
181
|
+
`runner` option instead is the OSS runtime. It never reads the Intelligence key, and the
|
|
182
|
+
Inspector reads the project as locked. The default in-memory OSS runner is ephemeral.
|
|
183
|
+
SQLite, custom, or framework persistence can be durable. The two options cannot be
|
|
140
184
|
combined. Take the constructor from the connect-your-runtime page. Where a framework
|
|
141
185
|
quickstart shows a `runner` option instead, the connect-your-runtime page wins.
|
|
142
186
|
|
|
187
|
+
When the starting state is `both-oss`, use its recorded live baseline evidence. Preserve
|
|
188
|
+
the working agent, frontend, CopilotKit integration, and OSS behavior. Plan only the
|
|
189
|
+
project selection, Intelligence runtime configuration, and authenticated proof needed for
|
|
190
|
+
the conversion. Preserve the existing persistence and user-visible request. Do not
|
|
191
|
+
rebuild a path that already works.
|
|
192
|
+
|
|
143
193
|
Where the SDK requires an application-level value that the repository cannot supply, such
|
|
144
194
|
as an end-user identity for threads, use one clearly marked local placeholder and name what
|
|
145
195
|
production requires instead. Do not stop onboarding to ask the developer for it.
|
|
@@ -4,16 +4,35 @@ Use the repository findings to select the agent framework. Ask the developer onl
|
|
|
4
4
|
choices that the repository does not show. Do not change application code in this phase.
|
|
5
5
|
Do not read, show, store, or request a secret value.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Use a gentle wizard. Ask one short question at a time. Do not combine separate choices in
|
|
8
|
+
one question. Put the recommendation first, give its evidence in one sentence, and keep
|
|
9
|
+
the alternatives short. When the framework is unknown, ask only whether to use the
|
|
10
|
+
recommended framework. If the developer declines it, ask one follow-up question that lists
|
|
11
|
+
the valid framework choices. Do not ask about the frontend, model, or project in this step.
|
|
8
12
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
13
|
+
These are the agent frameworks and their default vendors:
|
|
14
|
+
|
|
15
|
+
| Framework | Default vendor |
|
|
16
|
+
| ---------------------------------- | --------------- |
|
|
17
|
+
| AG2 | OpenAI |
|
|
18
|
+
| ADK | Google |
|
|
19
|
+
| Agno | OpenAI |
|
|
20
|
+
| Built-in CopilotKit agent | OpenAI |
|
|
21
|
+
| Claude Agent SDK (Python) | Anthropic |
|
|
22
|
+
| Claude Agent SDK (TypeScript) | Anthropic |
|
|
23
|
+
| CrewAI Flows | Project-defined |
|
|
24
|
+
| Deep Agents | OpenAI |
|
|
25
|
+
| LangGraph FastAPI | OpenAI |
|
|
26
|
+
| LangGraph Python | OpenAI |
|
|
27
|
+
| LangGraph TypeScript | OpenAI |
|
|
28
|
+
| LlamaIndex | OpenAI |
|
|
29
|
+
| Mastra | OpenAI |
|
|
30
|
+
| Microsoft Agent Framework (.NET) | GitHub Models |
|
|
31
|
+
| Microsoft Agent Framework (Python) | OpenAI |
|
|
32
|
+
| MS Agent Harness (.NET) | GitHub Models |
|
|
33
|
+
| Pydantic AI | OpenAI |
|
|
34
|
+
| Strands Agents (Python) | OpenAI |
|
|
35
|
+
| Strands Agents (TypeScript) | OpenAI |
|
|
17
36
|
|
|
18
37
|
If the project already has an agent in a listed framework, preserve that framework and
|
|
19
38
|
its model setup. Ask only about choices that remain unknown.
|
|
@@ -21,18 +40,37 @@ its model setup. Ask only about choices that remain unknown.
|
|
|
21
40
|
If the project needs an agent, show the options and one recommendation based on repository
|
|
22
41
|
evidence. Match the language the repository already uses. Ask the developer to choose.
|
|
23
42
|
|
|
43
|
+
If the project is empty, state that no repository-based recommendation exists. Give these
|
|
44
|
+
documented defaults: LangGraph TypeScript, LangGraph Python, ADK, Microsoft Agent Framework
|
|
45
|
+
Python, Microsoft Agent Framework .NET, and Mastra. Explain which default matches the
|
|
46
|
+
developer's stated purpose. Show the other listed frameworks as options. Do not describe a
|
|
47
|
+
documented default as a repository-based recommendation.
|
|
48
|
+
|
|
24
49
|
Do not offer a framework that is not listed above. Do not port an existing agent to
|
|
25
50
|
another framework. Do not show the internal route.
|
|
26
51
|
|
|
27
52
|
Use exactly one matching internal route:
|
|
28
53
|
|
|
29
|
-
1.
|
|
30
|
-
2.
|
|
31
|
-
3.
|
|
32
|
-
4.
|
|
33
|
-
5.
|
|
34
|
-
6.
|
|
54
|
+
1. AG2: `npx --yes copilotkit@4.9.1 onboard read framework/ag2`
|
|
55
|
+
2. Agno: `npx --yes copilotkit@4.9.1 onboard read framework/agno`
|
|
56
|
+
3. Built-in CopilotKit agent: `npx --yes copilotkit@4.9.1 onboard read framework/built-in`
|
|
57
|
+
4. Claude Agent SDK Python: `npx --yes copilotkit@4.9.1 onboard read framework/claude-sdk-python`
|
|
58
|
+
5. Claude Agent SDK TypeScript: `npx --yes copilotkit@4.9.1 onboard read framework/claude-sdk-typescript`
|
|
59
|
+
6. CrewAI Flows: `npx --yes copilotkit@4.9.1 onboard read framework/crewai-flows`
|
|
60
|
+
7. Deep Agents: `npx --yes copilotkit@4.9.1 onboard read framework/deep-agents`
|
|
61
|
+
8. LangGraph Python: `npx --yes copilotkit@4.9.1 onboard read framework/langgraph-python`
|
|
62
|
+
9. LangGraph FastAPI: `npx --yes copilotkit@4.9.1 onboard read framework/langgraph-fastapi`
|
|
63
|
+
10. LangGraph TypeScript: `npx --yes copilotkit@4.9.1 onboard read framework/langgraph-typescript`
|
|
64
|
+
11. LlamaIndex: `npx --yes copilotkit@4.9.1 onboard read framework/llamaindex`
|
|
65
|
+
12. ADK: `npx --yes copilotkit@4.9.1 onboard read framework/google-adk`
|
|
66
|
+
13. Microsoft Agent Framework Python: `npx --yes copilotkit@4.9.1 onboard read framework/ms-agent-python`
|
|
67
|
+
14. Microsoft Agent Framework .NET: `npx --yes copilotkit@4.9.1 onboard read framework/ms-agent-dotnet`
|
|
68
|
+
15. Mastra: `npx --yes copilotkit@4.9.1 onboard read framework/mastra`
|
|
69
|
+
16. MS Agent Harness .NET: `npx --yes copilotkit@4.9.1 onboard read framework/ms-agent-harness-dotnet`
|
|
70
|
+
17. Pydantic AI: `npx --yes copilotkit@4.9.1 onboard read framework/pydantic-ai`
|
|
71
|
+
18. Strands Agents Python: `npx --yes copilotkit@4.9.1 onboard read framework/strands-python`
|
|
72
|
+
19. Strands Agents TypeScript: `npx --yes copilotkit@4.9.1 onboard read framework/strands-typescript`
|
|
35
73
|
|
|
36
74
|
If the project has an agent in another framework, or no listed framework fits, keep the
|
|
37
75
|
developer's current agent and run
|
|
38
|
-
`npx copilotkit@4.
|
|
76
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Build from the best available official documentation
|
|
2
|
+
|
|
3
|
+
Tell the implementation subagent which plan steps lack direct documentation. Give it the
|
|
4
|
+
approved plan, repository findings, and all official documentation that you found.
|
|
5
|
+
|
|
6
|
+
Tell the subagent to preserve the existing project. It must not invent a CopilotKit API.
|
|
7
|
+
It can combine compatible APIs from different official pages when one page omits the
|
|
8
|
+
selected framework and frontend combination.
|
|
9
|
+
|
|
10
|
+
Run the approved implementation and validation steps. Repair a failure in new work at most
|
|
11
|
+
three times. Stop if the fix requires changes to the developer's existing agent or
|
|
12
|
+
frontend.
|
|
13
|
+
|
|
14
|
+
After validation passes, prove the runtime, agent round trip, and real frontend path. Use
|
|
15
|
+
the same proof rules from the approved plan. Keep the development servers running after
|
|
16
|
+
proof.
|
|
17
|
+
|
|
18
|
+
Do not block core proof on CopilotKit Skills or MCP configuration. Try these tools after
|
|
19
|
+
the application passes proof. Report each tool result separately.
|
|
20
|
+
|
|
21
|
+
Report the documentation gap and each assumption with the proof evidence. Do not claim
|
|
22
|
+
that the selected documentation proved an inferred step.
|
|
23
|
+
|
|
24
|
+
When the proof is complete, run `npx --yes copilotkit@4.9.1 onboard complete`, carrying the
|
|
25
|
+
surface-check result the proof subagent returned. Pass exactly one flag, matching this
|
|
26
|
+
journey's surface:
|
|
27
|
+
|
|
28
|
+
```text
|
|
29
|
+
npx --yes copilotkit@4.9.1 onboard complete --visual-check <outcome>
|
|
30
|
+
npx --yes copilotkit@4.9.1 onboard complete --device-check <outcome>
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
`--visual-check` is for a web frontend and takes `performed`, `skipped-no-browser-tool`, or
|
|
34
|
+
`failed`. `--device-check` is for React Native and takes `performed`, `skipped-no-device`,
|
|
35
|
+
or `failed`. Anything but `performed` ends this run as blocked, and the command's output
|
|
36
|
+
names the evidence that is missing. Report it that way.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Configure AG2
|
|
2
|
+
|
|
3
|
+
Preserve an existing AG2 model setup. Start with OpenAI for a new agent. Offer another
|
|
4
|
+
vendor only after an exact CopilotKit Markdown page names it. The page must name its
|
|
5
|
+
credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/ag2/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/ag2/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/ag2/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/ag2/readables.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `ag2`. Use only the Python examples from these pages.
|
|
22
|
+
Preserve the existing `AGUIStream` endpoint and its route. The quickstart uses a sample
|
|
23
|
+
repository with `uv sync`. It does not name a dependency list for an existing project.
|
|
24
|
+
Do not replace the project's dependency manifest with a guessed list, and do not change
|
|
25
|
+
an existing endpoint to the quickstart's `/weather` sample route.
|
|
26
|
+
|
|
27
|
+
The fixed-schema page has no AG2 backend schema-loading, render-operations, or runtime
|
|
28
|
+
setup snippet. Do not invent a fixed-schema A2UI backend setup. If the requested work
|
|
29
|
+
needs that missing setup, run the unsupported route below.
|
|
30
|
+
|
|
31
|
+
The Readables page includes the AG2 backend context path. Use its `ContextVariables` and
|
|
32
|
+
`AGUIStream` examples when the project needs frontend context. Do not substitute another
|
|
33
|
+
framework's context setup.
|
|
34
|
+
|
|
35
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
36
|
+
URLs, and the fixed-schema documentation gap. Do not use remembered CopilotKit
|
|
37
|
+
instructions.
|
|
38
|
+
|
|
39
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
40
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
41
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
42
|
+
unavailable only after a second method also fails.
|
|
43
|
+
|
|
44
|
+
If the pages support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
46
|
+
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|