copilotkit 4.16.0 → 4.17.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 +69 -4
- package/cli-build-info.json +7 -7
- package/index.js +3993 -2742
- package/onboarding/index.json +1 -1
- package/onboarding/prompts/authenticate/start.md +17 -15
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +20 -20
- package/onboarding/prompts/credentials/plan.md +21 -21
- package/onboarding/prompts/credentials/settle-credentials.md +46 -10
- package/onboarding/prompts/credentials/write-plan.md +35 -20
- package/onboarding/prompts/fallback/best-effort.md +23 -15
- package/onboarding/prompts/feature/a2ui/implement.md +40 -12
- package/onboarding/prompts/feature/a2ui/proof.md +29 -9
- package/onboarding/prompts/feature/a2ui/start.md +8 -10
- package/onboarding/prompts/feature/blocked-by-plan.md +4 -4
- package/onboarding/prompts/feature/channels/implement.md +41 -13
- package/onboarding/prompts/feature/channels/proof.md +30 -11
- package/onboarding/prompts/feature/channels/start.md +11 -9
- package/onboarding/prompts/feature/chat-suggestions/implement.md +40 -12
- package/onboarding/prompts/feature/chat-suggestions/proof.md +29 -9
- package/onboarding/prompts/feature/chat-suggestions/start.md +8 -10
- package/onboarding/prompts/feature/complete.md +2 -2
- package/onboarding/prompts/feature/learning/implement.md +58 -26
- package/onboarding/prompts/feature/learning/proof.md +30 -10
- package/onboarding/prompts/feature/learning/start.md +15 -12
- package/onboarding/prompts/feature/open-generative-ui/implement.md +41 -13
- package/onboarding/prompts/feature/open-generative-ui/proof.md +29 -9
- package/onboarding/prompts/feature/open-generative-ui/start.md +8 -10
- package/onboarding/prompts/feature/realtime-sync/implement.md +41 -13
- package/onboarding/prompts/feature/realtime-sync/proof.md +31 -10
- package/onboarding/prompts/feature/realtime-sync/start.md +8 -9
- package/onboarding/prompts/feature/rich-threads/implement.md +42 -14
- package/onboarding/prompts/feature/rich-threads/proof.md +31 -10
- package/onboarding/prompts/feature/rich-threads/start.md +8 -9
- package/onboarding/prompts/feature/stop.md +3 -3
- package/onboarding/prompts/feature/voice/implement.md +40 -12
- package/onboarding/prompts/feature/voice/proof.md +29 -9
- package/onboarding/prompts/feature/voice/start.md +8 -9
- package/onboarding/prompts/framework/ag2.md +2 -2
- package/onboarding/prompts/framework/agno.md +4 -4
- package/onboarding/prompts/framework/built-in.md +2 -2
- package/onboarding/prompts/framework/claude-sdk-python.md +8 -7
- package/onboarding/prompts/framework/claude-sdk-typescript.md +2 -2
- package/onboarding/prompts/framework/crewai-flows.md +15 -7
- package/onboarding/prompts/framework/deep-agents.md +4 -3
- package/onboarding/prompts/framework/google-adk.md +7 -7
- package/onboarding/prompts/framework/langgraph-fastapi.md +2 -2
- package/onboarding/prompts/framework/langgraph-python.md +2 -2
- package/onboarding/prompts/framework/langgraph-typescript.md +2 -2
- package/onboarding/prompts/framework/llamaindex.md +4 -4
- package/onboarding/prompts/framework/mastra.md +2 -2
- package/onboarding/prompts/framework/ms-agent-dotnet.md +2 -2
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +2 -2
- package/onboarding/prompts/framework/ms-agent-python.md +6 -6
- package/onboarding/prompts/framework/pydantic-ai.md +2 -2
- package/onboarding/prompts/framework/strands-python.md +4 -4
- package/onboarding/prompts/framework/strands-typescript.md +4 -4
- package/onboarding/prompts/frontend/angular.md +3 -3
- package/onboarding/prompts/frontend/nextjs.md +16 -3
- package/onboarding/prompts/frontend/plan.md +7 -7
- package/onboarding/prompts/frontend/react-native.md +2 -2
- package/onboarding/prompts/frontend/react-spa.md +2 -2
- package/onboarding/prompts/frontend/vue.md +2 -2
- package/onboarding/prompts/implementation/build-and-validate.md +67 -28
- package/onboarding/prompts/proof/complete.md +21 -14
- package/onboarding/prompts/proof/oss-baseline.md +16 -12
- package/onboarding/prompts/proof/round-trip.md +33 -22
- package/onboarding/prompts/research/gather.md +8 -7
- package/onboarding/prompts/research/merge.md +3 -3
- package/onboarding/prompts/research/preflight.md +4 -4
- package/onboarding/prompts/research/route.md +6 -6
- package/onboarding/prompts/starter/clone.md +14 -11
- package/onboarding/prompts/stopped/run-failed.md +9 -9
- package/onboarding/prompts/subagent/create-plan.md +15 -10
- package/onboarding/prompts/subagent/implement-and-validate.md +25 -11
- package/onboarding/prompts/subagent/inspect-repository.md +14 -6
- package/onboarding/prompts/subagent/prove-oss-baseline.md +5 -4
- package/onboarding/prompts/subagent/prove-round-trip.md +38 -14
- package/onboarding/prompts/unsupported/no-validated-path.md +2 -2
- package/package.json +1 -5
- package/release/release-tool.js +171 -40
|
@@ -10,26 +10,46 @@ When microphone permission is unavailable, use the official guide's documented c
|
|
|
10
10
|
developer's behalf or claim a live recording was made. Record the visible control, transcript
|
|
11
11
|
path, agent response, app URL, and process IDs. Fix changed-file defects and repeat.
|
|
12
12
|
|
|
13
|
+
Give the proof subagent the protected path list and the authorized list. Take that list from
|
|
14
|
+
the latest audit, and copy the paths under `Authorized to modify:`. Tell it this rule: a fix
|
|
15
|
+
can change a path on the authorized list. When a fix needs any other protected path, it must
|
|
16
|
+
not edit it. It returns a result that starts with `Status: blocked` and names the file under
|
|
17
|
+
Blockers.
|
|
18
|
+
|
|
19
|
+
That result is a question for the developer. The file has not changed yet, so consent can
|
|
20
|
+
still go on the record. Name the file and why the fix needs it, then end your turn and wait
|
|
21
|
+
for the developer's answer. If they allow it, record their answer before any edit:
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Continue only when the result starts with `Status: passed`. Run the audit again, take the
|
|
28
|
+
new list from its `Authorized to modify:` block, and spawn a fresh proof subagent with the
|
|
29
|
+
same handoff and that list. A subagent that already returned cannot pick up consent recorded
|
|
30
|
+
after it was spawned. If you cannot ask, or the developer declines, take the feature stop
|
|
31
|
+
route below.
|
|
32
|
+
|
|
13
33
|
Report each attempt at the proof as it ends, counting from one:
|
|
14
34
|
|
|
15
35
|
```text
|
|
16
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
36
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard checkpoint --phase journey-attempted --attempt 1
|
|
17
37
|
```
|
|
18
38
|
|
|
19
39
|
Report each repair cycle the same way, counting from one:
|
|
20
40
|
|
|
21
41
|
```text
|
|
22
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
42
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard checkpoint --phase repair-attempted --attempt 1
|
|
23
43
|
```
|
|
24
44
|
|
|
25
45
|
After the final attempt, report the gate exactly once:
|
|
26
46
|
|
|
27
47
|
```text
|
|
28
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
48
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
|
|
29
49
|
```
|
|
30
50
|
|
|
31
51
|
Use `passed` only for proved voice input, `failed` for an attempted proof that failed, and
|
|
32
|
-
`skipped` when the proof could not run. Then run `npx --prefer-offline --yes copilotkit@4.
|
|
52
|
+
`skipped` when the proof could not run. Then run `npx --prefer-offline --yes copilotkit@4.17.0 onboard audit`.
|
|
33
53
|
Continue only when it starts with `Status: passed`.
|
|
34
54
|
|
|
35
55
|
If the audit fails, never repair, reset, or revert a protected path. Compare each named path
|
|
@@ -37,16 +57,16 @@ with the proof subagent's `Files changed` section. If that section does not name
|
|
|
37
57
|
run `onboard protect --accept-external --path <path>`, or
|
|
38
58
|
`onboard protect --accept-credential --path <path>` for an env file where the developer
|
|
39
59
|
placed a requested credential. If the subagent names the path, or its report does not settle
|
|
40
|
-
who changed it,
|
|
41
|
-
|
|
42
|
-
Run the audit again after each accepted
|
|
60
|
+
who changed it, the change is this run's own, made without consent. Do not ask the developer
|
|
61
|
+
to allow it: the CLI refuses consent for a path that already changed. Route out, and name
|
|
62
|
+
the path and the change the audit reports. Run the audit again after each accepted change.
|
|
43
63
|
|
|
44
64
|
If the audit still fails, or starts with `Status: blocked`, route out and stop:
|
|
45
65
|
|
|
46
66
|
```text
|
|
47
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
67
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard read feature/stop
|
|
48
68
|
```
|
|
49
69
|
|
|
50
70
|
When the audit passes, run
|
|
51
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
71
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read feature/complete` with the actual surface
|
|
52
72
|
outcome.
|
|
@@ -6,7 +6,7 @@ read-only, implementation, and proof subagents, each restricted to the target pr
|
|
|
6
6
|
Before any subagent or project process runs, capture the developer's existing work:
|
|
7
7
|
|
|
8
8
|
```text
|
|
9
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
9
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard protect
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Keep the exact protected path list it prints and give that list to every subagent. No
|
|
@@ -16,14 +16,13 @@ approved authorization before implementation.
|
|
|
16
16
|
Before edits, inspect the runtime route, CopilotKit provider/chat composer, current agent,
|
|
17
17
|
existing provider credential variable names (presence only), package versions, browser
|
|
18
18
|
permissions approach, and test/dev commands. Prove the existing OSS baseline with `/info`,
|
|
19
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
20
|
-
and a real UI request when a browser is available.
|
|
21
|
-
and direct the developer to generic onboarding first.
|
|
19
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 verify --expect-runtime oss --round-trip --agent <agent-id> --json`,
|
|
20
|
+
and a real UI request when a browser is available.
|
|
22
21
|
|
|
23
22
|
Wait for the inspection subagent to finish. Then report that the inspection came back:
|
|
24
23
|
|
|
25
24
|
```text
|
|
26
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
25
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard checkpoint --phase research-returned
|
|
27
26
|
```
|
|
28
27
|
|
|
29
28
|
A refused checkpoint prints its reason and leaves onboarding unaffected. It is not a
|
|
@@ -33,7 +32,7 @@ If the inspection did not prove the baseline this intent extends, stop here with
|
|
|
33
32
|
changing files:
|
|
34
33
|
|
|
35
34
|
```text
|
|
36
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
35
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard read feature/stop
|
|
37
36
|
```
|
|
38
37
|
|
|
39
38
|
Do not run login, select Intelligence, create a credential, read a credential value, or
|
|
@@ -54,7 +53,7 @@ one.
|
|
|
54
53
|
After approval, record each approved path before implementation:
|
|
55
54
|
|
|
56
55
|
```text
|
|
57
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
56
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
|
|
58
57
|
```
|
|
59
58
|
|
|
60
59
|
If an approved path changed after capture and no implementation step has run, add
|
|
@@ -64,7 +63,7 @@ authorize a path the approved plan did not list.
|
|
|
64
63
|
Then report the plan this run is about to implement:
|
|
65
64
|
|
|
66
65
|
```text
|
|
67
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
66
|
+
npx --prefer-offline --yes copilotkit@4.17.0 onboard checkpoint --phase plan-written
|
|
68
67
|
```
|
|
69
68
|
|
|
70
|
-
Then run `npx --prefer-offline --yes copilotkit@4.
|
|
69
|
+
Then run `npx --prefer-offline --yes copilotkit@4.17.0 onboard read feature/voice/implement`.
|
|
@@ -31,7 +31,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
31
31
|
URLs, and the A2UI documentation gap.
|
|
32
32
|
|
|
33
33
|
If the pages support the selection, run
|
|
34
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
34
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
35
35
|
|
|
36
36
|
If the documentation does not support the selection, run
|
|
37
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
37
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -23,8 +23,8 @@ new agent. For a new agent, install the documented Python dependencies
|
|
|
23
23
|
the endpoint without repository evidence.
|
|
24
24
|
|
|
25
25
|
The agent-readonly page does not bundle its Agno backend context setup. Do not invent it.
|
|
26
|
-
If the requested work
|
|
27
|
-
unsupported route below.
|
|
26
|
+
If the requested work passes project data to the agent and the project does not already have that
|
|
27
|
+
setup, run the unsupported route below. Otherwise, record the gap and continue.
|
|
28
28
|
|
|
29
29
|
A2UI is not on this path. If the developer asks for it, say first that its page has no Agno
|
|
30
30
|
backend schema-loading, render-operations, or runtime setup snippet, so there is nothing to
|
|
@@ -34,7 +34,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
URLs, the documented dependencies and adapter, and the context documentation gap.
|
|
35
35
|
|
|
36
36
|
If the pages support the selection, run
|
|
37
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
37
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
38
38
|
|
|
39
39
|
If the documentation does not support the selection, run
|
|
40
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
40
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -29,7 +29,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
29
29
|
these URLs.
|
|
30
30
|
|
|
31
31
|
If the pages support the selection, run
|
|
32
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
32
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
33
33
|
|
|
34
34
|
If the documentation does not support the selection, run
|
|
35
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
35
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -13,6 +13,7 @@ Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
|
|
|
13
13
|
- https://docs.copilotkit.ai/claude-sdk-python/inspector.md
|
|
14
14
|
- https://docs.copilotkit.ai/claude-sdk-python/generative-ui/tool-based.md
|
|
15
15
|
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
16
|
+
- https://docs.copilotkit.ai/claude-sdk-python/shared-state/agent-readonly.md
|
|
16
17
|
|
|
17
18
|
The documentation scope is `claude-sdk-python`. For an existing agent, install the exact
|
|
18
19
|
documented backend set with
|
|
@@ -25,15 +26,15 @@ A2UI is not on this path. If the developer asks for it, say first that the docum
|
|
|
25
26
|
Python setup does not support `action_handlers` on `a2ui.render`, so its button callback
|
|
26
27
|
cannot return a decision to the agent.
|
|
27
28
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
29
|
+
Where the requested work passes project data to the agent, follow the agent-readonly page above for
|
|
30
|
+
both sides. The adapter does not add the context to the Claude prompt by itself, so the
|
|
31
|
+
agent-side step on that page, which appends the context to the system prompt, is required.
|
|
31
32
|
|
|
32
|
-
Record the selected framework, vendor, model, required credential variable names,
|
|
33
|
-
URLs
|
|
33
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
34
|
+
these URLs.
|
|
34
35
|
|
|
35
36
|
If the pages support the selection, run
|
|
36
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
37
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
37
38
|
|
|
38
39
|
If the documentation does not support the selection, run
|
|
39
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
40
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -37,7 +37,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
37
37
|
URLs, and the context limit.
|
|
38
38
|
|
|
39
39
|
If the pages support the selection, run
|
|
40
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
40
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
41
41
|
|
|
42
42
|
If the documentation does not support the selection, run
|
|
43
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
43
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -4,6 +4,13 @@ Preserve the project's existing CrewAI Flow, provider, model, and deployment. Th
|
|
|
4
4
|
pages do not name a default model vendor or model credential variable. Do not choose a
|
|
5
5
|
vendor or credential name for the developer.
|
|
6
6
|
|
|
7
|
+
When the target directory holds no project, do not ask the vendor question yet. The
|
|
8
|
+
frontend is chosen next, and with Next.js the run clones the CrewAI Flows starter, which
|
|
9
|
+
reads `OPENAI_API_KEY`, so an answer here decides nothing. If the run clones that
|
|
10
|
+
starter, tell the developer that the starter decides the vendor. If the frontend prompt
|
|
11
|
+
sends you to its Documentation section instead, ask the vendor question below at that
|
|
12
|
+
point, before the plan.
|
|
13
|
+
|
|
7
14
|
When the repository shows a provider, keep it and ask nothing further about it. When
|
|
8
15
|
neither the repository nor these pages show one, the developer decides, so ask. Ask one
|
|
9
16
|
short question: which model vendor the CrewAI Flow will call. Say that the CopilotKit
|
|
@@ -24,6 +31,7 @@ vendor. That route is for a documentation page that does not support the selecti
|
|
|
24
31
|
- https://docs.copilotkit.ai/crewai-crews/inspector.md
|
|
25
32
|
- https://docs.copilotkit.ai/crewai-crews/generative-ui/tool-based.md
|
|
26
33
|
- https://docs.copilotkit.ai/crewai-crews/shared-state/in-app-agent-read.md
|
|
34
|
+
- https://docs.copilotkit.ai/crewai-crews/agent-app-context.md
|
|
27
35
|
|
|
28
36
|
The public onboarding route ID is `crewai-flows`. The canonical documentation scope is
|
|
29
37
|
`crewai-crews`. The quickstart and feature pages also contain older `/crewai-flows/`
|
|
@@ -45,16 +53,16 @@ A2UI is not on this path. If the developer asks for it, say first that its page
|
|
|
45
53
|
this base adapter rather than standing alone, so it needs the Flow to call
|
|
46
54
|
`copilotkit_emit_tool_result` itself.
|
|
47
55
|
|
|
48
|
-
The shared-state page is not an agent-app-context guide.
|
|
49
|
-
|
|
50
|
-
|
|
56
|
+
The shared-state page is not an agent-app-context guide. Where the requested work passes project data
|
|
57
|
+
to the agent, follow the agent-app-context page above for both sides. The Flow does not
|
|
58
|
+
receive the context by itself, so the steps that declare `context` on the state class and
|
|
59
|
+
render it into the crew's work are required.
|
|
51
60
|
|
|
52
61
|
Record the selected framework, project-defined provider and model, the credential
|
|
53
|
-
variable names the repository proves or the developer named, these URLs, the adapter
|
|
54
|
-
shared-state limit.
|
|
62
|
+
variable names the repository proves or the developer named, these URLs, and the adapter.
|
|
55
63
|
|
|
56
64
|
If the pages support the selection, run
|
|
57
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
65
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
58
66
|
|
|
59
67
|
If the documentation does not support the selection, run
|
|
60
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
68
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -20,7 +20,8 @@ Preserve the project's existing deployment path. Choose the same `Deep Agent` or
|
|
|
20
20
|
deployment to FastAPI or a FastAPI deployment to Deep Agent.
|
|
21
21
|
|
|
22
22
|
No Deep Agents agent-app-context Markdown page is available. Do not invent an
|
|
23
|
-
agent-app-context setup. If the requested work
|
|
23
|
+
agent-app-context setup. If the requested work passes project data to the agent, run the unsupported
|
|
24
|
+
route below. Otherwise, record the gap and continue.
|
|
24
25
|
|
|
25
26
|
A2UI is not on this path. If the developer asks for it, say first that its backend example
|
|
26
27
|
is Python-only, so a TypeScript project has nothing to follow.
|
|
@@ -32,7 +33,7 @@ Record the selected framework, language, vendor, model, required credential vari
|
|
|
32
33
|
names, these URLs, and each documentation gap.
|
|
33
34
|
|
|
34
35
|
If the pages support the selection, run
|
|
35
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
36
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
36
37
|
|
|
37
38
|
If the documentation does not support the selection, run
|
|
38
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
39
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -14,15 +14,15 @@ key.
|
|
|
14
14
|
- https://docs.copilotkit.ai/google-adk/inspector.md
|
|
15
15
|
- https://docs.copilotkit.ai/google-adk/generative-ui/tool-based.md
|
|
16
16
|
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
17
|
+
- https://docs.copilotkit.ai/google-adk/agent-app-context.md
|
|
17
18
|
|
|
18
19
|
The documentation scope is `google-adk`. A `/adk/` URL answers with a redirect stub
|
|
19
20
|
whose body is the canonical path, so fetch the `google-adk` form.
|
|
20
21
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
agent and not for ADK.
|
|
22
|
+
Follow the agent-app-context page above for both sides of frontend context. The ADK
|
|
23
|
+
agent does not receive the context by itself, so the agent-side step on that page is
|
|
24
|
+
required. Do not read the built-in-agent context page in its place: that page states no
|
|
25
|
+
backend work is needed, which holds for the built-in agent and not for ADK.
|
|
26
26
|
|
|
27
27
|
Connect the Copilot Runtime with `HttpAgent` from `@ag-ui/client`.
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
30
|
these URLs.
|
|
31
31
|
|
|
32
32
|
If the pages support the selection, run
|
|
33
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
33
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
34
34
|
|
|
35
35
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
36
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -25,7 +25,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
25
25
|
these URLs.
|
|
26
26
|
|
|
27
27
|
If the pages support the selection, run
|
|
28
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
28
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
29
29
|
|
|
30
30
|
If the documentation does not support the selection, run
|
|
31
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
31
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -19,7 +19,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
19
19
|
these URLs.
|
|
20
20
|
|
|
21
21
|
If the pages support the selection, run
|
|
22
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
22
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
23
23
|
|
|
24
24
|
If the documentation does not support the selection, run
|
|
25
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
25
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -19,7 +19,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
19
19
|
these URLs.
|
|
20
20
|
|
|
21
21
|
If the pages support the selection, run
|
|
22
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
22
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
23
23
|
|
|
24
24
|
If the documentation does not support the selection, run
|
|
25
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
25
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -27,14 +27,14 @@ LlamaIndex backend code but does not bundle its runtime setup, so it only works
|
|
|
27
27
|
the quickstart runtime it extends.
|
|
28
28
|
|
|
29
29
|
The shared-state page is not an agent-app-context guide. Do not use it to invent a
|
|
30
|
-
`useAgentContext` backend setup. If the requested work
|
|
31
|
-
|
|
30
|
+
`useAgentContext` backend setup. If the requested work passes project data to the agent, run the
|
|
31
|
+
unsupported route below. Otherwise, record the gap and continue.
|
|
32
32
|
|
|
33
33
|
Record the selected framework, vendor, model, required credential variable names, these
|
|
34
34
|
URLs, the documented dependencies and adapter, and both documentation limits.
|
|
35
35
|
|
|
36
36
|
If the pages support the selection, run
|
|
37
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
37
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
38
38
|
|
|
39
39
|
If the documentation does not support the selection, run
|
|
40
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
40
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -47,7 +47,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
47
47
|
these URLs.
|
|
48
48
|
|
|
49
49
|
If the pages support the selection, run
|
|
50
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
50
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
51
51
|
|
|
52
52
|
If the documentation does not support the selection, run
|
|
53
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
53
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -36,7 +36,7 @@ Record the selected framework, provider, model, required credential variable nam
|
|
|
36
36
|
these URLs.
|
|
37
37
|
|
|
38
38
|
If the pages support the selection, run
|
|
39
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
39
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
40
40
|
|
|
41
41
|
If the documentation does not support the selection, run
|
|
42
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
42
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -44,7 +44,7 @@ Record the selected framework, provider, model, required credential variable nam
|
|
|
44
44
|
URLs, and the quickstart gap.
|
|
45
45
|
|
|
46
46
|
If the pages support the selection, run
|
|
47
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
47
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
48
48
|
|
|
49
49
|
If the documentation does not support the selection, run
|
|
50
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
50
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -4,10 +4,10 @@ Preserve an existing Microsoft Agent Framework model setup. Start with OpenAI fo
|
|
|
4
4
|
agent. Offer another vendor only after an exact CopilotKit Markdown page names it. The
|
|
5
5
|
page must name its credential variables and setup steps.
|
|
6
6
|
|
|
7
|
-
Name the model credential `OPENAI_API_KEY`, in `agent/.env
|
|
8
|
-
Azure OpenAI, through `AZURE_OPENAI_ENDPOINT` and
|
|
9
|
-
|
|
10
|
-
looks finished and reads no key.
|
|
7
|
+
Name the model credential `OPENAI_API_KEY`, in `agent/.env`, for a new agent. This
|
|
8
|
+
framework also accepts Azure OpenAI, through `AZURE_OPENAI_ENDPOINT` and
|
|
9
|
+
`AZURE_OPENAI_CHAT_DEPLOYMENT_NAME`. Keep Azure OpenAI only when the project already uses
|
|
10
|
+
it. A scaffold that writes one spelling and reads the other looks finished and reads no key.
|
|
11
11
|
|
|
12
12
|
This framework reads no `.env` on its own. Whatever loads the file is application code,
|
|
13
13
|
so a scaffold that writes `agent/.env` and never loads it starts with no credential.
|
|
@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
30
|
these URLs.
|
|
31
31
|
|
|
32
32
|
If the pages support the selection, run
|
|
33
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
33
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
34
34
|
|
|
35
35
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
36
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -43,7 +43,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
43
43
|
URLs, and the two-step context route.
|
|
44
44
|
|
|
45
45
|
If the pages support the selection, run
|
|
46
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
46
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
47
47
|
|
|
48
48
|
If the documentation does not support the selection, run
|
|
49
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
49
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -20,8 +20,8 @@ A2UI tool makes its own OpenAI call, so it bills a second model call this plan d
|
|
|
20
20
|
account for.
|
|
21
21
|
|
|
22
22
|
No Strands agent-app-context Markdown page is available. Do not invent an
|
|
23
|
-
agent-app-context setup. If the requested work
|
|
24
|
-
|
|
23
|
+
agent-app-context setup. If the requested work passes project data to the agent, run the unsupported
|
|
24
|
+
route below. Otherwise, record the gap and continue.
|
|
25
25
|
|
|
26
26
|
Connect the Copilot Runtime with `HttpAgent` from `@ag-ui/client`.
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
29
29
|
URLs, and the context documentation gap.
|
|
30
30
|
|
|
31
31
|
If the pages support the selection, run
|
|
32
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
32
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
33
33
|
|
|
34
34
|
If the documentation does not support the selection, run
|
|
35
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
35
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -18,8 +18,8 @@ these pages. Install `@modelcontextprotocol/sdk` as a runtime dependency.
|
|
|
18
18
|
`@strands-agents/sdk` loads it even when the application does not use MCP.
|
|
19
19
|
|
|
20
20
|
No Strands TypeScript agent-app-context Markdown page is available. Do not translate
|
|
21
|
-
another language's backend example or invent that setup. If the requested work
|
|
22
|
-
run the unsupported route below.
|
|
21
|
+
another language's backend example or invent that setup. If the requested work passes project data
|
|
22
|
+
to the agent, run the unsupported route below. Otherwise, record the gap and continue.
|
|
23
23
|
|
|
24
24
|
A2UI is not on this path. If the developer asks for it, say first that its page has no
|
|
25
25
|
Strands TypeScript backend example, so a TypeScript project has nothing to follow.
|
|
@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
30
|
URLs, and the context documentation gap.
|
|
31
31
|
|
|
32
32
|
If the pages support the selection, run
|
|
33
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
33
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/plan`.
|
|
34
34
|
|
|
35
35
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
36
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -5,7 +5,7 @@ Preserve an existing Angular frontend. Use the selected page for a new frontend.
|
|
|
5
5
|
Use the starter shortcut only if all these facts are true: the target directory holds no
|
|
6
6
|
project, its name is a valid `init` project name, and the selected framework is ADK.
|
|
7
7
|
If all three facts are true, record Angular as the selected frontend. Then run
|
|
8
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
8
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read starter/clone` before you fetch documentation.
|
|
9
9
|
|
|
10
10
|
## Documentation
|
|
11
11
|
|
|
@@ -63,7 +63,7 @@ you create or build an Angular project. If the installed version is lower, selec
|
|
|
63
63
|
supported version first and use it for every later command in this project.
|
|
64
64
|
|
|
65
65
|
If the pages support the selection, record Angular and these URLs. Then run
|
|
66
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
66
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read credentials/finalize-plan`.
|
|
67
67
|
|
|
68
68
|
If the documentation does not support the selection, or the two version lines do not fit
|
|
69
|
-
together, run `npx --prefer-offline --yes copilotkit@4.
|
|
69
|
+
together, run `npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -15,7 +15,7 @@ These TypeScript options have starters: Claude Agent SDK TypeScript, LangGraph T
|
|
|
15
15
|
Mastra, and Strands Agents TypeScript. The .NET option is Microsoft Agent Framework .NET.
|
|
16
16
|
|
|
17
17
|
If all shortcut conditions are true, record Next.js as the selected frontend. Then run
|
|
18
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
18
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read starter/clone` before you fetch documentation.
|
|
19
19
|
|
|
20
20
|
## Documentation
|
|
21
21
|
|
|
@@ -26,8 +26,21 @@ agent framework documentation instead. This page configures the CopilotKit built
|
|
|
26
26
|
agent as the default agent, which is correct only for a project that has no agent.
|
|
27
27
|
Do not replace the developer's existing agent with the built-in agent.
|
|
28
28
|
|
|
29
|
+
## Files that `next dev` writes
|
|
30
|
+
|
|
31
|
+
If a coding agent starts `next dev` on Next.js 16.3 or later, Next.js writes `AGENTS.md`
|
|
32
|
+
and `CLAUDE.md` in the app directory. If one of the files exists, Next.js adds its own
|
|
33
|
+
block to that file. These files are Next.js output. They are not your work and not the
|
|
34
|
+
developer's work.
|
|
35
|
+
|
|
36
|
+
- For a new frontend that you create, pass `--no-agents-md` to `create-next-app`. If
|
|
37
|
+
the installed Next.js is 16.3 or later, also set `agentRules: false` in
|
|
38
|
+
`next.config.ts`.
|
|
39
|
+
- For an existing frontend, do not change `next.config.ts` for this.
|
|
40
|
+
- Do not claim, revert, or delete these files. Name them in the report as Next.js output.
|
|
41
|
+
|
|
29
42
|
If the page supports the selection, record Next.js and this URL. Then run
|
|
30
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
43
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read credentials/finalize-plan`.
|
|
31
44
|
|
|
32
45
|
If the documentation does not support the selection, run
|
|
33
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
46
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -36,15 +36,15 @@ CopilotKit web apps. Then recommend the one the developer names, and say what ea
|
|
|
36
36
|
|
|
37
37
|
Use exactly one matching internal route:
|
|
38
38
|
|
|
39
|
-
1. React SPA: `npx --prefer-offline --yes copilotkit@4.
|
|
40
|
-
2. Next.js: `npx --prefer-offline --yes copilotkit@4.
|
|
41
|
-
3. Angular: `npx --prefer-offline --yes copilotkit@4.
|
|
42
|
-
4. Vue 3: `npx --prefer-offline --yes copilotkit@4.
|
|
43
|
-
5. React Native: `npx --prefer-offline --yes copilotkit@4.
|
|
44
|
-
6. Slack or Microsoft Teams: `npx --prefer-offline --yes copilotkit@4.
|
|
39
|
+
1. React SPA: `npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/react-spa`
|
|
40
|
+
2. Next.js: `npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/nextjs`
|
|
41
|
+
3. Angular: `npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/angular`
|
|
42
|
+
4. Vue 3: `npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/vue`
|
|
43
|
+
5. React Native: `npx --prefer-offline --yes copilotkit@4.17.0 onboard read frontend/react-native`
|
|
44
|
+
6. Slack or Microsoft Teams: `npx --prefer-offline --yes copilotkit@4.17.0 onboard read feature/channels/start`
|
|
45
45
|
|
|
46
46
|
If they chose Slack or Microsoft Teams, tell that node which one they chose so it
|
|
47
47
|
does not ask again.
|
|
48
48
|
|
|
49
49
|
If no listed frontend fits, run
|
|
50
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
50
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -18,7 +18,7 @@ documents `useRenderTool`, which is React Native's own hook for drawing a tool t
|
|
|
18
18
|
already has. That is a different job and needs a tool in the agent.
|
|
19
19
|
|
|
20
20
|
If the pages support the selection, record React Native and these URLs. Then run
|
|
21
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
21
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read credentials/finalize-plan`.
|
|
22
22
|
|
|
23
23
|
If the documentation does not support the selection, run
|
|
24
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
24
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -14,7 +14,7 @@ not move the agent into it.
|
|
|
14
14
|
- https://docs.copilotkit.ai/react-spa.md
|
|
15
15
|
|
|
16
16
|
If the page supports the selection, record React SPA and this URL. Then run
|
|
17
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
17
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read credentials/finalize-plan`.
|
|
18
18
|
|
|
19
19
|
If the documentation does not support the selection, run
|
|
20
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
20
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|
|
@@ -19,7 +19,7 @@ page above. Vue has its own `useComponent`, which is not the React package. Take
|
|
|
19
19
|
that reference page rather than from a Vue generative-UI guide, which is not published.
|
|
20
20
|
|
|
21
21
|
If the pages support the selection, record Vue 3 and these URLs. Then run
|
|
22
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
22
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read credentials/finalize-plan`.
|
|
23
23
|
|
|
24
24
|
If the documentation does not support the selection, run
|
|
25
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
25
|
+
`npx --prefer-offline --yes copilotkit@4.17.0 onboard read unsupported/no-validated-path`.
|