copilotkit 4.8.3 → 4.9.0
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 +183 -2
- package/cli-build-info.json +7 -7
- package/index.js +5645 -3567
- package/onboarding/index.json +33 -33
- package/onboarding/prompts/authenticate/start.md +63 -10
- package/onboarding/prompts/credentials/finalize-plan.md +168 -15
- package/onboarding/prompts/credentials/plan.md +55 -49
- package/onboarding/prompts/fallback/best-effort.md +29 -0
- package/onboarding/prompts/framework/ag2.md +33 -7
- package/onboarding/prompts/framework/agno.md +32 -7
- package/onboarding/prompts/framework/built-in.md +30 -8
- package/onboarding/prompts/framework/claude-sdk-python.md +35 -7
- package/onboarding/prompts/framework/claude-sdk-typescript.md +39 -7
- package/onboarding/prompts/framework/crewai-flows.md +41 -7
- package/onboarding/prompts/framework/deep-agents.md +30 -6
- package/onboarding/prompts/framework/google-adk.md +32 -8
- package/onboarding/prompts/framework/langgraph-fastapi.md +24 -5
- package/onboarding/prompts/framework/langgraph-python.md +15 -5
- package/onboarding/prompts/framework/langgraph-typescript.md +15 -5
- package/onboarding/prompts/framework/llamaindex.md +35 -7
- package/onboarding/prompts/framework/mastra.md +48 -6
- package/onboarding/prompts/framework/ms-agent-dotnet.md +57 -7
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +48 -8
- package/onboarding/prompts/framework/ms-agent-python.md +32 -7
- package/onboarding/prompts/framework/pydantic-ai.md +34 -9
- package/onboarding/prompts/framework/strands-python.md +28 -9
- package/onboarding/prompts/framework/strands-typescript.md +28 -9
- package/onboarding/prompts/frontend/angular.md +20 -5
- package/onboarding/prompts/frontend/nextjs.md +13 -3
- package/onboarding/prompts/frontend/plan.md +20 -19
- 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 +82 -7
- package/onboarding/prompts/proof/complete.md +63 -2
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +150 -8
- package/onboarding/prompts/subagent/create-plan.md +69 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +48 -3
- package/onboarding/prompts/subagent/inspect-repository.md +13 -3
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +118 -11
- package/onboarding/prompts/unsupported/no-validated-path.md +27 -9
- package/package.json +1 -1
- package/release/release-tool.js +32 -4
- package/onboarding/prompts/frontend/slack.md +0 -20
- package/onboarding/prompts/frontend/teams.md +0 -20
package/onboarding/index.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"prompts": [
|
|
4
4
|
{
|
|
5
5
|
"edges": [
|
|
6
|
-
"
|
|
6
|
+
"proof/oss-baseline",
|
|
7
7
|
"credentials/plan",
|
|
8
8
|
"unsupported/no-validated-path"
|
|
9
9
|
],
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
},
|
|
13
13
|
{
|
|
14
14
|
"edges": [
|
|
15
|
-
"subagent/create-plan",
|
|
16
15
|
"implementation/build-and-validate",
|
|
17
16
|
"unsupported/no-validated-path"
|
|
18
17
|
],
|
|
@@ -21,30 +20,35 @@
|
|
|
21
20
|
},
|
|
22
21
|
{
|
|
23
22
|
"edges": [
|
|
23
|
+
"framework/ag2",
|
|
24
|
+
"framework/agno",
|
|
24
25
|
"framework/built-in",
|
|
26
|
+
"framework/claude-sdk-python",
|
|
27
|
+
"framework/claude-sdk-typescript",
|
|
28
|
+
"framework/crewai-flows",
|
|
25
29
|
"framework/deep-agents",
|
|
26
30
|
"framework/langgraph-python",
|
|
27
31
|
"framework/langgraph-fastapi",
|
|
28
32
|
"framework/langgraph-typescript",
|
|
33
|
+
"framework/llamaindex",
|
|
29
34
|
"framework/google-adk",
|
|
30
|
-
"framework/strands-python",
|
|
31
|
-
"framework/strands-typescript",
|
|
32
|
-
"framework/mastra",
|
|
33
|
-
"framework/claude-sdk-python",
|
|
34
|
-
"framework/claude-sdk-typescript",
|
|
35
|
-
"framework/pydantic-ai",
|
|
36
35
|
"framework/ms-agent-python",
|
|
37
36
|
"framework/ms-agent-dotnet",
|
|
37
|
+
"framework/mastra",
|
|
38
38
|
"framework/ms-agent-harness-dotnet",
|
|
39
|
-
"framework/
|
|
40
|
-
"framework/
|
|
41
|
-
"framework/
|
|
42
|
-
"framework/crewai-flows",
|
|
39
|
+
"framework/pydantic-ai",
|
|
40
|
+
"framework/strands-python",
|
|
41
|
+
"framework/strands-typescript",
|
|
43
42
|
"unsupported/no-validated-path"
|
|
44
43
|
],
|
|
45
44
|
"milestone": "credentials",
|
|
46
45
|
"name": "credentials/plan"
|
|
47
46
|
},
|
|
47
|
+
{
|
|
48
|
+
"edges": [],
|
|
49
|
+
"milestone": "fallback",
|
|
50
|
+
"name": "fallback/best-effort"
|
|
51
|
+
},
|
|
48
52
|
{
|
|
49
53
|
"edges": [
|
|
50
54
|
"frontend/plan",
|
|
@@ -220,8 +224,6 @@
|
|
|
220
224
|
"frontend/angular",
|
|
221
225
|
"frontend/vue",
|
|
222
226
|
"frontend/react-native",
|
|
223
|
-
"frontend/slack",
|
|
224
|
-
"frontend/teams",
|
|
225
227
|
"unsupported/no-validated-path"
|
|
226
228
|
],
|
|
227
229
|
"milestone": "frontend",
|
|
@@ -235,28 +237,13 @@
|
|
|
235
237
|
"milestone": "frontend",
|
|
236
238
|
"name": "frontend/react-native"
|
|
237
239
|
},
|
|
238
|
-
{
|
|
239
|
-
"edges": [
|
|
240
|
-
"unsupported/no-validated-path"
|
|
241
|
-
],
|
|
242
|
-
"milestone": "frontend",
|
|
243
|
-
"name": "frontend/react-spa"
|
|
244
|
-
},
|
|
245
240
|
{
|
|
246
241
|
"edges": [
|
|
247
242
|
"credentials/finalize-plan",
|
|
248
243
|
"unsupported/no-validated-path"
|
|
249
244
|
],
|
|
250
245
|
"milestone": "frontend",
|
|
251
|
-
"name": "frontend/
|
|
252
|
-
},
|
|
253
|
-
{
|
|
254
|
-
"edges": [
|
|
255
|
-
"credentials/finalize-plan",
|
|
256
|
-
"unsupported/no-validated-path"
|
|
257
|
-
],
|
|
258
|
-
"milestone": "frontend",
|
|
259
|
-
"name": "frontend/teams"
|
|
246
|
+
"name": "frontend/react-spa"
|
|
260
247
|
},
|
|
261
248
|
{
|
|
262
249
|
"edges": [
|
|
@@ -268,7 +255,6 @@
|
|
|
268
255
|
},
|
|
269
256
|
{
|
|
270
257
|
"edges": [
|
|
271
|
-
"subagent/implement-and-validate",
|
|
272
258
|
"proof/round-trip",
|
|
273
259
|
"unsupported/no-validated-path"
|
|
274
260
|
],
|
|
@@ -282,7 +268,14 @@
|
|
|
282
268
|
},
|
|
283
269
|
{
|
|
284
270
|
"edges": [
|
|
285
|
-
"
|
|
271
|
+
"credentials/plan",
|
|
272
|
+
"unsupported/no-validated-path"
|
|
273
|
+
],
|
|
274
|
+
"milestone": "proof",
|
|
275
|
+
"name": "proof/oss-baseline"
|
|
276
|
+
},
|
|
277
|
+
{
|
|
278
|
+
"edges": [
|
|
286
279
|
"proof/complete",
|
|
287
280
|
"unsupported/no-validated-path"
|
|
288
281
|
],
|
|
@@ -307,10 +300,17 @@
|
|
|
307
300
|
{
|
|
308
301
|
"edges": [],
|
|
309
302
|
"milestone": "subagent",
|
|
310
|
-
"name": "subagent/prove-
|
|
303
|
+
"name": "subagent/prove-oss-baseline"
|
|
311
304
|
},
|
|
312
305
|
{
|
|
313
306
|
"edges": [],
|
|
307
|
+
"milestone": "subagent",
|
|
308
|
+
"name": "subagent/prove-round-trip"
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
"edges": [
|
|
312
|
+
"fallback/best-effort"
|
|
313
|
+
],
|
|
314
314
|
"milestone": "unsupported",
|
|
315
315
|
"name": "unsupported/no-validated-path"
|
|
316
316
|
}
|
|
@@ -8,7 +8,18 @@ Do not show prompt names, internal route IDs, subagent names, or storage field n
|
|
|
8
8
|
Work from the target project directory. For an existing project, start at its inspection
|
|
9
9
|
root.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Read only inside the target project directory. Every subagent you spawn inherits that
|
|
12
|
+
limit, including one this graph does not name. Answer a CopilotKit API or configuration
|
|
13
|
+
question from the documentation this graph gives you. Another checkout on this machine is
|
|
14
|
+
not a source. The developer running this has none, so an answer taken from one is an
|
|
15
|
+
answer they cannot get, and it hides the documentation gap that blocks them.
|
|
16
|
+
|
|
17
|
+
Tell the developer that onboarding can send feedback outside this machine. Explain that
|
|
18
|
+
the reports contain short descriptions of CLI or documentation problems. Ask whether the
|
|
19
|
+
developer permits these reports before project work starts. Record the answer. Do not send
|
|
20
|
+
feedback unless the developer permits it.
|
|
21
|
+
|
|
22
|
+
Run `npx --yes copilotkit@4.9.0 login --json` before any project work. This command checks the
|
|
12
23
|
current session. It starts sign-in only as needed.
|
|
13
24
|
|
|
14
25
|
Read its JSON Lines output in order:
|
|
@@ -21,27 +32,69 @@ Read its JSON Lines output in order:
|
|
|
21
32
|
Do not use `whoami` for this check. It has no JSON output and some failures exit with code
|
|
22
33
|
zero. Do not put account tokens or credentials in the conversation.
|
|
23
34
|
|
|
24
|
-
Spawn one research subagent.
|
|
25
|
-
|
|
26
|
-
return only its findings. Add these tasks:
|
|
35
|
+
Spawn one research subagent. Give it the full text of the research brief at the end of this
|
|
36
|
+
prompt and tell it to follow that brief and return only its findings. Add these tasks:
|
|
27
37
|
|
|
28
38
|
- Find the target app or runtime directory that owns `.env` and CopilotKit setup.
|
|
29
39
|
- Check whether `.copilotkit/project.json` has `projectId`, `projectSlug`, and `clerkOrgId`.
|
|
30
40
|
- Check whether `.env` has a non-empty `INTELLIGENCE_API_KEY` entry.
|
|
31
41
|
- Record the `.env` file modification time without returning it.
|
|
42
|
+
- Report whether an agent, frontend, and CopilotKit integration are present.
|
|
43
|
+
- Report whether the runtime constructor uses a `runner` option, an `intelligence`
|
|
44
|
+
option, or neither can be proved from project files.
|
|
32
45
|
|
|
33
46
|
Do not print either file or any secret value. Return only paths, presence checks, and missing
|
|
34
47
|
field names. Wait for the subagent to finish.
|
|
35
48
|
|
|
49
|
+
If the findings show an empty project and do not prove its purpose, ask what the developer
|
|
50
|
+
wants to build before you select a framework. Ask this question immediately. Record the
|
|
51
|
+
answer and give it to each later subagent.
|
|
52
|
+
|
|
36
53
|
If a repository file exists, each finding must cite it. For an empty project, the subagent
|
|
37
54
|
must cite its directory check and report absent parts.
|
|
38
55
|
|
|
39
|
-
The findings must cover the agent, frontend, CopilotKit setup,
|
|
40
|
-
credential names, and validation path. Do not ask the developer for facts
|
|
41
|
-
repository answers.
|
|
56
|
+
The findings must cover what the project is for, the agent, frontend, CopilotKit setup,
|
|
57
|
+
authentication, credential names, and validation path. Do not ask the developer for facts
|
|
58
|
+
that the repository answers.
|
|
59
|
+
|
|
60
|
+
Do not infer a working OSS path from packages, imports, project files, or keys. If an
|
|
61
|
+
agent, frontend, and CopilotKit integration are present, prove the live starting state
|
|
62
|
+
before any project file changes. Run
|
|
63
|
+
`npx --yes copilotkit@4.9.0 onboard read proof/oss-baseline`.
|
|
42
64
|
|
|
43
|
-
|
|
44
|
-
`npx copilotkit@4.
|
|
65
|
+
For every other inspected state, run
|
|
66
|
+
`npx --yes copilotkit@4.9.0 onboard read credentials/plan`.
|
|
45
67
|
|
|
46
68
|
If authentication or inspection stops onboarding, run
|
|
47
|
-
`npx copilotkit@4.
|
|
69
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
70
|
+
|
|
71
|
+
## Research subagent brief
|
|
72
|
+
|
|
73
|
+
Everything below the rule is the subagent's prompt. Give it verbatim.
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
# Inspect the repository
|
|
78
|
+
|
|
79
|
+
Inspect the repository without changing it. Find evidence for:
|
|
80
|
+
|
|
81
|
+
- what the project is for, in the project's own words
|
|
82
|
+
- any existing agent framework
|
|
83
|
+
- any existing frontend
|
|
84
|
+
- current CopilotKit packages and configuration
|
|
85
|
+
- authentication boundaries
|
|
86
|
+
- names of required credential variables, without reading their values
|
|
87
|
+
|
|
88
|
+
A project states what it is for in its `README.md`, in its package description, or in
|
|
89
|
+
the prompt of an agent it already has. Quote that statement rather than rewriting it. An
|
|
90
|
+
empty project carries it in the README alone, and that makes the README the whole of the
|
|
91
|
+
evidence. State the purpose as unproved when the project never says.
|
|
92
|
+
|
|
93
|
+
Gather what you need in as few commands as possible. Combine independent reads into one
|
|
94
|
+
command rather than running them one at a time. Split a command only when its result decides
|
|
95
|
+
what you run next.
|
|
96
|
+
|
|
97
|
+
Return the file paths and a short finding for each item. State each absent or unproved item.
|
|
98
|
+
Do not read, print, or return secret values. Do not read a file outside the project
|
|
99
|
+
directory. Do not run or return another onboarding command. Stop after returning the
|
|
100
|
+
findings to the main coding agent.
|
|
@@ -17,15 +17,49 @@ confirm that the prior project selection had no key-provision warning.
|
|
|
17
17
|
Reused project credentials remain unverified until an authenticated Intelligence call
|
|
18
18
|
succeeds. Record that state in the plan.
|
|
19
19
|
|
|
20
|
-
If the developer needs a project or another project,
|
|
21
|
-
|
|
22
|
-
directory. This command lets the developer select or create an Intelligence project.
|
|
20
|
+
If the developer needs a project or another project, do the selection yourself from the
|
|
21
|
+
target directory. Do not send the developer to another terminal.
|
|
23
22
|
|
|
24
|
-
|
|
25
|
-
remove any secret before replying. Resume only after they reply.
|
|
23
|
+
Read the choices first:
|
|
26
24
|
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
```text
|
|
26
|
+
npx --yes copilotkit@4.9.0 project list --json
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
With `--json` the payload is the only thing on standard output, so it is safe to parse.
|
|
30
|
+
Show the current selection and the five most recent projects. Sort recency by `createdAt`.
|
|
31
|
+
Offer search, create-new, and list-all options. Do not show every project unless the
|
|
32
|
+
developer asks.
|
|
33
|
+
|
|
34
|
+
If the developer searches, run:
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
npx --yes copilotkit@4.9.0 project list --search <query> --json
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
If the developer asks for all projects, show the result of the first list command. Ask
|
|
41
|
+
which project to use, or ask for a new project name. Ask this with the frontend and model
|
|
42
|
+
choices when those choices remain unknown.
|
|
43
|
+
|
|
44
|
+
Then record their answer, from the target directory:
|
|
45
|
+
|
|
46
|
+
```text
|
|
47
|
+
npx --yes copilotkit@4.9.0 project select --project <slug-or-id> --json
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Use `--create <name> --json` instead when they want a new project. The two flags cannot be
|
|
51
|
+
combined. A slug that does not exist fails and lists the real ones, so a typo cannot record
|
|
52
|
+
a selection that points at nothing.
|
|
53
|
+
|
|
54
|
+
Read the JSON result. It reports `selected_project_slug`, `api_key_provisioned`,
|
|
55
|
+
`project_file_written`, and `environment_file_written` at the top level. The result does
|
|
56
|
+
not contain a secret. Report `selected_project_slug` as the project slug that the server
|
|
57
|
+
selected or created. Require `api_key_provisioned`, `project_file_written`, and
|
|
58
|
+
`environment_file_written` to be true. If one is false, report the error and stop
|
|
59
|
+
onboarding. Key provisioning is non-fatal, so the command can persist a selection and
|
|
60
|
+
still exit zero with no key. A scaffold with no key looks finished and is not.
|
|
61
|
+
|
|
62
|
+
Never print the payload or any secret value.
|
|
29
63
|
|
|
30
64
|
After a warning-free result, send the research subagent a follow-up check. Require it to
|
|
31
65
|
confirm these facts without showing values:
|
|
@@ -39,19 +73,138 @@ Do not print either file or any secret value. If a check fails, stop onboarding.
|
|
|
39
73
|
selection success message alone does not prove key readiness. The CLI cannot prove key scope
|
|
40
74
|
before an authenticated Intelligence call succeeds.
|
|
41
75
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
76
|
+
## Where a model credential comes from
|
|
77
|
+
|
|
78
|
+
The plan names the model credential variables. Finding their values is not its job.
|
|
79
|
+
|
|
80
|
+
If the project has no value for one, ask the developer where it lives. Never read a file
|
|
81
|
+
outside the project directory to find one. A key found that way belongs to another
|
|
82
|
+
project: it bills that project for these model calls, points attribution at a project
|
|
83
|
+
nobody chose, and leaves no trace, because the scaffold works.
|
|
84
|
+
|
|
85
|
+
Asking where a credential lives is not requesting a secret value. Ask for a path, or ask
|
|
86
|
+
the developer to write the value into the project's env file themselves. A path the
|
|
87
|
+
developer names is theirs to give, including one outside the project. A path this run
|
|
88
|
+
finds is not.
|
|
89
|
+
|
|
90
|
+
If no answer comes, stop. Do not write a placeholder or an empty value. A scaffold
|
|
91
|
+
carrying a dummy key looks finished and fails at the first model call, which is worse
|
|
92
|
+
than stopping here.
|
|
93
|
+
|
|
94
|
+
## Wire the runtime to Intelligence
|
|
95
|
+
|
|
96
|
+
The key in `.env` does nothing on its own. The runtime reads no environment variable for
|
|
97
|
+
it. The credential reaches the platform only when the runtime is constructed with an
|
|
98
|
+
Intelligence client, and a runtime built without one compiles, serves, answers in a
|
|
99
|
+
browser, and never touches the platform.
|
|
100
|
+
|
|
101
|
+
Add this page to the selected documentation URLs for both subagents:
|
|
102
|
+
|
|
103
|
+
- https://docs.copilotkit.ai/premium/connect-your-runtime.md
|
|
104
|
+
|
|
105
|
+
Fetch it together with the pages already selected rather than on its own.
|
|
106
|
+
|
|
107
|
+
Spawn one planning subagent. Give it the full text of the planning brief at the end of this
|
|
108
|
+
prompt, the repository findings, selected framework, frontend, model, credential variable
|
|
109
|
+
names, and selected documentation URLs. Wait for the subagent to finish.
|
|
46
110
|
|
|
47
111
|
Make sure that the plan preserves each part that already exists. The plan must name the
|
|
48
|
-
credential variables,
|
|
49
|
-
contain secret
|
|
112
|
+
credential variables, the Intelligence runtime wiring, the application the project asks
|
|
113
|
+
for, implementation steps, validation steps, and proof steps. It must not contain secret
|
|
114
|
+
values.
|
|
50
115
|
|
|
51
116
|
Show only the selected framework, frontend, model, planned file changes, validation commands, and proof steps.
|
|
52
117
|
|
|
53
118
|
If the developer approves the plan, run
|
|
54
|
-
`npx copilotkit@4.
|
|
119
|
+
`npx --yes copilotkit@4.9.0 onboard read implementation/build-and-validate`.
|
|
55
120
|
|
|
56
121
|
If no exact supported path or documentation URL exists, run
|
|
57
|
-
`npx copilotkit@4.
|
|
122
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
123
|
+
|
|
124
|
+
## Planning subagent brief
|
|
125
|
+
|
|
126
|
+
Everything below the rule is the subagent's prompt. Give it verbatim.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
# Create the onboarding plan
|
|
131
|
+
|
|
132
|
+
Use the selected framework, frontend, model, repository findings, and documentation URLs
|
|
133
|
+
from the main coding agent. Fetch every selected URL in one step rather than one after
|
|
134
|
+
another. Do not use remembered CopilotKit instructions.
|
|
135
|
+
|
|
136
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
137
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
138
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
139
|
+
documentation gap only after a second method also fails.
|
|
140
|
+
|
|
141
|
+
Name the application the project asks for, and plan that application. Each documentation
|
|
142
|
+
page teaches through one worked example, and that example carries a domain of its own.
|
|
143
|
+
The domain belongs to the page. The project's purpose from the repository findings
|
|
144
|
+
decides what gets built. Where the two differ, the project wins. Where the repository
|
|
145
|
+
never states a purpose, say so in the plan and ask the developer before you adopt the
|
|
146
|
+
domain of an example.
|
|
147
|
+
|
|
148
|
+
Read only inside the project directory. Answer an API question from the documentation
|
|
149
|
+
URLs you were given, not from another checkout on this machine.
|
|
150
|
+
|
|
151
|
+
List the required credential variable names. Do not read or return credential values.
|
|
152
|
+
Preserve each agent or frontend that already exists.
|
|
153
|
+
|
|
154
|
+
Plan the runtime to consume the Intelligence credential. The runtime takes an
|
|
155
|
+
`intelligence` option holding a client built from the project key. A runtime given a
|
|
156
|
+
`runner` option instead is the OSS runtime. It never reads the Intelligence key, and the
|
|
157
|
+
Inspector reads the project as locked. The default in-memory OSS runner is ephemeral.
|
|
158
|
+
SQLite, custom, or framework persistence can be durable. The two options cannot be
|
|
159
|
+
combined. Take the constructor from the connect-your-runtime page. Where a framework
|
|
160
|
+
quickstart shows a `runner` option instead, the connect-your-runtime page wins.
|
|
161
|
+
|
|
162
|
+
When the starting state is `both-oss`, use its recorded live baseline evidence. Preserve
|
|
163
|
+
the working agent, frontend, CopilotKit integration, and OSS behavior. Plan only the
|
|
164
|
+
project selection, Intelligence runtime configuration, and authenticated proof needed for
|
|
165
|
+
the conversion. Preserve the existing persistence and user-visible request. Do not
|
|
166
|
+
rebuild a path that already works.
|
|
167
|
+
|
|
168
|
+
Where the SDK requires an application-level value that the repository cannot supply, such
|
|
169
|
+
as an end-user identity for threads, use one clearly marked local placeholder and name what
|
|
170
|
+
production requires instead. Do not stop onboarding to ask the developer for it.
|
|
171
|
+
|
|
172
|
+
Check whether the existing agent performs unattended side effects, such as paging, sending
|
|
173
|
+
notifications, writing to an external system, or creating tickets. If it does, the new
|
|
174
|
+
conversational surface must not trigger them. Wrap only the reasoning steps, or require an
|
|
175
|
+
explicit developer confirmation before the side effect can run. Name each side effect you
|
|
176
|
+
found and state how the plan avoids it.
|
|
177
|
+
|
|
178
|
+
If the value of the journey depends on data the project already holds, name that data,
|
|
179
|
+
name where it lives, and name how it reaches the agent. Rendering a list in the DOM does
|
|
180
|
+
not give the agent access to it. An agent wired without the page's data answers from
|
|
181
|
+
entities it invents, and the answer looks correct. Take the frontend-context step from
|
|
182
|
+
the selected documentation. Where no selected page documents it for this framework or
|
|
183
|
+
frontend, record that as a documentation gap rather than guessing the API.
|
|
184
|
+
|
|
185
|
+
Where that data exists, name the entities the proof compares against: the ids, names, or
|
|
186
|
+
records the project holds and the answer has to reference. Where the outcome references
|
|
187
|
+
no project data, say so in the plan, so that the proof asks for evidence this journey can
|
|
188
|
+
produce.
|
|
189
|
+
|
|
190
|
+
Create one plan for implementation, validation, and proof. Name each file or area that can
|
|
191
|
+
change. Name the commands that can validate the result.
|
|
192
|
+
Name the commands or user path that prove a real generative-UI round trip.
|
|
193
|
+
|
|
194
|
+
Keep a production build out of the validation commands. A type check plus the real round
|
|
195
|
+
trip is the proof, and the round trip runs in development mode. Name the production build
|
|
196
|
+
as a follow-up for the developer instead. Never raise a bundle budget or relax a lint rule
|
|
197
|
+
to make a build pass during onboarding.
|
|
198
|
+
|
|
199
|
+
The type check runs against the project's own configuration. If the project has no
|
|
200
|
+
type-check command, add one that uses the configuration the project already has.
|
|
201
|
+
Do not add compiler strictness the project did not have. Nothing later in the run is
|
|
202
|
+
allowed to weaken type safety, so a stricter gate named here is one the run cannot get
|
|
203
|
+
back out of.
|
|
204
|
+
|
|
205
|
+
Gather what you need in as few commands as possible. Combine independent reads into one
|
|
206
|
+
command rather than running them one at a time. Split a command only when its result decides
|
|
207
|
+
what you run next.
|
|
208
|
+
|
|
209
|
+
Return the plan, the URLs that you read, and each documentation gap. Stop after you return
|
|
210
|
+
the findings to the main coding agent.
|
|
@@ -4,61 +4,67 @@ 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
|
-
|
|
8
|
-
below. Ask only about choices that remain unknown.
|
|
7
|
+
These are the agent frameworks and their default vendors:
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
9
|
+
| Framework | Default vendor |
|
|
10
|
+
| ---------------------------------- | --------------- |
|
|
11
|
+
| AG2 | OpenAI |
|
|
12
|
+
| ADK | Google |
|
|
13
|
+
| Agno | OpenAI |
|
|
14
|
+
| Built-in CopilotKit agent | OpenAI |
|
|
15
|
+
| Claude Agent SDK (Python) | Anthropic |
|
|
16
|
+
| Claude Agent SDK (TypeScript) | Anthropic |
|
|
17
|
+
| CrewAI Flows | Project-defined |
|
|
18
|
+
| Deep Agents | OpenAI |
|
|
19
|
+
| LangGraph FastAPI | OpenAI |
|
|
20
|
+
| LangGraph Python | OpenAI |
|
|
21
|
+
| LangGraph TypeScript | OpenAI |
|
|
22
|
+
| LlamaIndex | OpenAI |
|
|
23
|
+
| Mastra | OpenAI |
|
|
24
|
+
| Microsoft Agent Framework (.NET) | GitHub Models |
|
|
25
|
+
| Microsoft Agent Framework (Python) | OpenAI |
|
|
26
|
+
| MS Agent Harness (.NET) | GitHub Models |
|
|
27
|
+
| Pydantic AI | OpenAI |
|
|
28
|
+
| Strands Agents (Python) | OpenAI |
|
|
29
|
+
| Strands Agents (TypeScript) | OpenAI |
|
|
13
30
|
|
|
14
|
-
|
|
31
|
+
If the project already has an agent in a listed framework, preserve that framework and
|
|
32
|
+
its model setup. Ask only about choices that remain unknown.
|
|
15
33
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
| LangGraph Python | OpenAI |
|
|
19
|
-
| LangGraph TypeScript | OpenAI |
|
|
20
|
-
| Google ADK | Google |
|
|
21
|
-
| AWS Strands Python | OpenAI |
|
|
22
|
-
| Mastra | OpenAI |
|
|
23
|
-
| Claude Agent SDK Python | Anthropic |
|
|
24
|
-
| Claude Agent SDK TypeScript | Anthropic |
|
|
25
|
-
| PydanticAI | OpenAI |
|
|
26
|
-
| Microsoft Agent Framework Python | OpenAI |
|
|
27
|
-
| Microsoft Agent Framework .NET | GitHub Models |
|
|
28
|
-
| Agno | OpenAI |
|
|
29
|
-
| LlamaIndex | OpenAI |
|
|
34
|
+
If the project needs an agent, show the options and one recommendation based on repository
|
|
35
|
+
evidence. Match the language the repository already uses. Ask the developer to choose.
|
|
30
36
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
37
|
+
If the project is empty, state that no repository-based recommendation exists. Give these
|
|
38
|
+
documented defaults: LangGraph TypeScript, LangGraph Python, ADK, Microsoft Agent Framework
|
|
39
|
+
Python, Microsoft Agent Framework .NET, and Mastra. Explain which default matches the
|
|
40
|
+
developer's stated purpose. Show the other listed frameworks as options. Do not describe a
|
|
41
|
+
documented default as a repository-based recommendation.
|
|
34
42
|
|
|
35
|
-
Do not offer
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
Show the public options and one recommendation based on repository evidence. If the
|
|
39
|
-
repository has no agent, ask the developer to choose. Do not show the internal route.
|
|
43
|
+
Do not offer a framework that is not listed above. Do not port an existing agent to
|
|
44
|
+
another framework. Do not show the internal route.
|
|
40
45
|
|
|
41
46
|
Use exactly one matching internal route:
|
|
42
47
|
|
|
43
|
-
1.
|
|
44
|
-
2.
|
|
45
|
-
3.
|
|
46
|
-
4.
|
|
47
|
-
5.
|
|
48
|
-
6.
|
|
49
|
-
7.
|
|
50
|
-
8.
|
|
51
|
-
9.
|
|
52
|
-
10.
|
|
53
|
-
11.
|
|
54
|
-
12.
|
|
55
|
-
13. Microsoft Agent Framework Python: `npx copilotkit@4.
|
|
56
|
-
14. Microsoft Agent Framework .NET: `npx copilotkit@4.
|
|
57
|
-
15.
|
|
58
|
-
16.
|
|
59
|
-
17.
|
|
60
|
-
18.
|
|
61
|
-
19.
|
|
48
|
+
1. AG2: `npx --yes copilotkit@4.9.0 onboard read framework/ag2`
|
|
49
|
+
2. Agno: `npx --yes copilotkit@4.9.0 onboard read framework/agno`
|
|
50
|
+
3. Built-in CopilotKit agent: `npx --yes copilotkit@4.9.0 onboard read framework/built-in`
|
|
51
|
+
4. Claude Agent SDK Python: `npx --yes copilotkit@4.9.0 onboard read framework/claude-sdk-python`
|
|
52
|
+
5. Claude Agent SDK TypeScript: `npx --yes copilotkit@4.9.0 onboard read framework/claude-sdk-typescript`
|
|
53
|
+
6. CrewAI Flows: `npx --yes copilotkit@4.9.0 onboard read framework/crewai-flows`
|
|
54
|
+
7. Deep Agents: `npx --yes copilotkit@4.9.0 onboard read framework/deep-agents`
|
|
55
|
+
8. LangGraph Python: `npx --yes copilotkit@4.9.0 onboard read framework/langgraph-python`
|
|
56
|
+
9. LangGraph FastAPI: `npx --yes copilotkit@4.9.0 onboard read framework/langgraph-fastapi`
|
|
57
|
+
10. LangGraph TypeScript: `npx --yes copilotkit@4.9.0 onboard read framework/langgraph-typescript`
|
|
58
|
+
11. LlamaIndex: `npx --yes copilotkit@4.9.0 onboard read framework/llamaindex`
|
|
59
|
+
12. ADK: `npx --yes copilotkit@4.9.0 onboard read framework/google-adk`
|
|
60
|
+
13. Microsoft Agent Framework Python: `npx --yes copilotkit@4.9.0 onboard read framework/ms-agent-python`
|
|
61
|
+
14. Microsoft Agent Framework .NET: `npx --yes copilotkit@4.9.0 onboard read framework/ms-agent-dotnet`
|
|
62
|
+
15. Mastra: `npx --yes copilotkit@4.9.0 onboard read framework/mastra`
|
|
63
|
+
16. MS Agent Harness .NET: `npx --yes copilotkit@4.9.0 onboard read framework/ms-agent-harness-dotnet`
|
|
64
|
+
17. Pydantic AI: `npx --yes copilotkit@4.9.0 onboard read framework/pydantic-ai`
|
|
65
|
+
18. Strands Agents Python: `npx --yes copilotkit@4.9.0 onboard read framework/strands-python`
|
|
66
|
+
19. Strands Agents TypeScript: `npx --yes copilotkit@4.9.0 onboard read framework/strands-typescript`
|
|
62
67
|
|
|
63
|
-
If no listed framework fits,
|
|
64
|
-
|
|
68
|
+
If the project has an agent in another framework, or no listed framework fits, keep the
|
|
69
|
+
developer's current agent and run
|
|
70
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,29 @@
|
|
|
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.0 onboard complete`, carrying the
|
|
25
|
+
visual-check result:
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
npx --yes copilotkit@4.9.0 onboard complete --visual-check <outcome>
|
|
29
|
+
```
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
# Configure AG2
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
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`.
|
|
5
8
|
|
|
6
9
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
7
10
|
store, or request a secret value.
|
|
@@ -11,12 +14,35 @@ store, or request a secret value.
|
|
|
11
14
|
- https://docs.copilotkit.ai/ag2/quickstart.md
|
|
12
15
|
- https://docs.copilotkit.ai/ag2/inspector.md
|
|
13
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.
|
|
14
38
|
|
|
15
|
-
|
|
16
|
-
|
|
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.
|
|
17
43
|
|
|
18
44
|
If the pages support the selection, run
|
|
19
|
-
`npx copilotkit@4.
|
|
45
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
20
46
|
|
|
21
|
-
If a page does not
|
|
22
|
-
`npx copilotkit@4.
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|