copilotkit 4.8.4 → 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 +22 -5
- package/cli-build-info.json +7 -7
- package/index.js +109 -33
- package/onboarding/index.json +140 -1
- package/onboarding/prompts/authenticate/start.md +21 -4
- package/onboarding/prompts/credentials/finalize-plan.md +39 -14
- package/onboarding/prompts/credentials/plan.md +48 -16
- package/onboarding/prompts/fallback/best-effort.md +29 -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 +16 -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 +18 -9
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +26 -11
- package/onboarding/prompts/subagent/create-plan.md +14 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +10 -0
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +21 -8
- package/onboarding/prompts/unsupported/no-validated-path.md +22 -9
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
|
@@ -10,8 +10,10 @@ Wait for the subagent to finish.
|
|
|
10
10
|
Give the subagent this guide for continued-development tools:
|
|
11
11
|
https://docs.copilotkit.ai/build-with-agents.md
|
|
12
12
|
|
|
13
|
-
If the subagent proves the complete round trip
|
|
14
|
-
`npx copilotkit@4.
|
|
13
|
+
If the subagent proves the complete round trip, run
|
|
14
|
+
`npx --yes copilotkit@4.9.0 onboard read proof/complete`. The round trip proves core success
|
|
15
|
+
even if a continued-development tool fails. Keep the Skills and MCP results separate from
|
|
16
|
+
the proof result.
|
|
15
17
|
|
|
16
18
|
If the round trip fails, decide which kind of failure it is before you route. A failure
|
|
17
19
|
caused by a file this run created or changed is a defect in the new work. Send it back to
|
|
@@ -19,7 +21,7 @@ the proof subagent to fix and prove again, at most three attempts.
|
|
|
19
21
|
|
|
20
22
|
Route out only when the failure is not yours to fix, when the same proof still fails after
|
|
21
23
|
three attempts, or when no evidence of the round trip can be produced. In those cases run
|
|
22
|
-
`npx copilotkit@4.
|
|
24
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
23
25
|
|
|
24
26
|
## Proof subagent brief
|
|
25
27
|
|
|
@@ -33,6 +35,11 @@ Use the proof steps and documentation URLs from the approved plan. Fetch every s
|
|
|
33
35
|
URL in one step before you start, rather than one after another.
|
|
34
36
|
Do not use remembered CopilotKit instructions.
|
|
35
37
|
|
|
38
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
39
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
40
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
41
|
+
documentation gap only after a second method also fails.
|
|
42
|
+
|
|
36
43
|
Read the port the developer's agent already serves from this project's own
|
|
37
44
|
configuration. Do not assume a default, and do not start a second copy of an agent this
|
|
38
45
|
project is already running. Before you bind any new server, check that the port is free
|
|
@@ -40,8 +47,12 @@ and pick another one if it is not. Record every port you used.
|
|
|
40
47
|
|
|
41
48
|
Start the agent and the selected frontend.
|
|
42
49
|
|
|
50
|
+
Leave the agent and frontend servers running after proof. Record each process ID and a
|
|
51
|
+
safe command that stops that process. Record the frontend URL and the commands that start
|
|
52
|
+
both servers again.
|
|
53
|
+
|
|
43
54
|
With both running, check the wiring in one command before you open a browser:
|
|
44
|
-
`npx copilotkit@4.
|
|
55
|
+
`npx --yes copilotkit@4.9.0 verify --json`. Add `--runtime-url` when the runtime is not at
|
|
45
56
|
`http://localhost:3000/api/copilotkit`. Read the individual checks rather than the summary
|
|
46
57
|
alone: a check reported `undetermined` did not run, and that is not a pass. Fix anything
|
|
47
58
|
that is not a pass before the browser, because a browser failure stacked on broken wiring
|
|
@@ -60,7 +71,7 @@ because the runtime reports no thread-endpoint state, the runtime predates the f
|
|
|
60
71
|
Record that and move on — there is nothing to repair.
|
|
61
72
|
|
|
62
73
|
Then prove that the agent actually runs, which is the gate for this node:
|
|
63
|
-
`npx copilotkit@4.
|
|
74
|
+
`npx --yes copilotkit@4.9.0 verify --round-trip --json`. It sends one request through the
|
|
64
75
|
runtime and reads the answer back from the thread, so it separates an agent that is
|
|
65
76
|
configured from an agent that works. Use `--agent <id>` when the runtime declares more
|
|
66
77
|
than one. If it reports `user-not-identified`, this project's `identifyUser` reads a
|
|
@@ -72,6 +83,11 @@ it.
|
|
|
72
83
|
Then send one real request through the frontend. Make sure that the request passes through
|
|
73
84
|
CopilotKit and reaches the selected agent.
|
|
74
85
|
|
|
86
|
+
For a recorded `both-oss` starting state: Compare the final round trip with the recorded
|
|
87
|
+
OSS baseline. The same frontend request must still reach the same agent and produce the
|
|
88
|
+
same kind of user-visible result. The runtime must now report `licenseStatus`, and the
|
|
89
|
+
authenticated Intelligence checks must pass. Record both before and after evidence.
|
|
90
|
+
|
|
75
91
|
Before you trust the agent, confirm that the process answering is the one in this
|
|
76
92
|
repository. `verify` reports which agents the runtime declares and has nothing to compare
|
|
77
93
|
them against, and `--round-trip` proves an agent answers under the declared id without
|
|
@@ -125,15 +141,14 @@ project's data never reaches the agent, the agent receives it and its instructio
|
|
|
125
141
|
it, the page loads its data after the context was registered, or the run wired a different
|
|
126
142
|
source than the page renders. Fix that cause, then prove again.
|
|
127
143
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
no reason. Fetch the continued-development guide from the main coding agent at the same
|
|
131
|
-
time as the proof documentation.
|
|
144
|
+
Fetch the continued-development guide from the main coding agent with the proof
|
|
145
|
+
documentation. Try the continued-development tools after the application passes proof.
|
|
132
146
|
Use it to install the project-scoped CopilotKit Skills.
|
|
133
147
|
Use it to configure the CopilotKit documentation MCP server for the current coding agent.
|
|
134
148
|
|
|
135
|
-
|
|
136
|
-
|
|
149
|
+
Do not validate whether the Skills or MCP server installed correctly. Record the command
|
|
150
|
+
result for each attempt. Report each tool result separately. A tool error does not change
|
|
151
|
+
the proof result.
|
|
137
152
|
|
|
138
153
|
Gather what you need in as few commands as possible. Combine independent reads into one
|
|
139
154
|
command rather than running them one at a time. Split a command only when its result decides
|
|
@@ -4,6 +4,11 @@ Use the selected framework, frontend, model, repository findings, and documentat
|
|
|
4
4
|
from the main coding agent. Fetch every selected URL in one step rather than one after
|
|
5
5
|
another. Do not use remembered CopilotKit instructions.
|
|
6
6
|
|
|
7
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
8
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
9
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
10
|
+
documentation gap only after a second method also fails.
|
|
11
|
+
|
|
7
12
|
Name the application the project asks for, and plan that application. Each documentation
|
|
8
13
|
page teaches through one worked example, and that example carries a domain of its own.
|
|
9
14
|
The domain belongs to the page. The project's purpose from the repository findings
|
|
@@ -19,11 +24,18 @@ Preserve each agent or frontend that already exists.
|
|
|
19
24
|
|
|
20
25
|
Plan the runtime to consume the Intelligence credential. The runtime takes an
|
|
21
26
|
`intelligence` option holding a client built from the project key. A runtime given a
|
|
22
|
-
`runner` option instead is the
|
|
23
|
-
|
|
27
|
+
`runner` option instead is the OSS runtime. It never reads the Intelligence key, and the
|
|
28
|
+
Inspector reads the project as locked. The default in-memory OSS runner is ephemeral.
|
|
29
|
+
SQLite, custom, or framework persistence can be durable. The two options cannot be
|
|
24
30
|
combined. Take the constructor from the connect-your-runtime page. Where a framework
|
|
25
31
|
quickstart shows a `runner` option instead, the connect-your-runtime page wins.
|
|
26
32
|
|
|
33
|
+
When the starting state is `both-oss`, use its recorded live baseline evidence. Preserve
|
|
34
|
+
the working agent, frontend, CopilotKit integration, and OSS behavior. Plan only the
|
|
35
|
+
project selection, Intelligence runtime configuration, and authenticated proof needed for
|
|
36
|
+
the conversion. Preserve the existing persistence and user-visible request. Do not
|
|
37
|
+
rebuild a path that already works.
|
|
38
|
+
|
|
27
39
|
Where the SDK requires an application-level value that the repository cannot supply, such
|
|
28
40
|
as an end-user identity for threads, use one clearly marked local placeholder and name what
|
|
29
41
|
production requires instead. Do not stop onboarding to ask the developer for it.
|
|
@@ -4,6 +4,11 @@ Use only the approved plan and the selected documentation URLs. Fetch every URL
|
|
|
4
4
|
step, before you change the project, rather than one after another.
|
|
5
5
|
Do not use remembered CopilotKit instructions.
|
|
6
6
|
|
|
7
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
8
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
9
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
10
|
+
documentation gap only after a second method also fails.
|
|
11
|
+
|
|
7
12
|
Add only the props, options, and imports that appear in the fetched documentation. A
|
|
8
13
|
remembered API from an earlier CopilotKit version will fail type checking against this
|
|
9
14
|
release, so do not decorate a documented example with anything it does not show.
|
|
@@ -20,6 +25,11 @@ file outside the project directory: not for a credential, and not for an API que
|
|
|
20
25
|
fetched documentation answers. A missing credential is the main coding agent's to ask
|
|
21
26
|
for.
|
|
22
27
|
|
|
28
|
+
For a recorded `both-oss` baseline, preserve the existing agent, frontend, CopilotKit
|
|
29
|
+
integration, user-visible request, and runtime behavior. Do not replace the existing
|
|
30
|
+
persistence. Change only the approved project selection and Intelligence runtime wiring.
|
|
31
|
+
Run the recorded baseline checks after the change and report any regression.
|
|
32
|
+
|
|
23
33
|
When the documentation creates the frontend with the framework's own scaffolder,
|
|
24
34
|
run that scaffolder rather than hand-authoring what it emits.
|
|
25
35
|
Do not re-declare a compiler option it set. Every real project of that framework
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Prove the existing OSS CopilotKit baseline
|
|
2
|
+
|
|
3
|
+
Read and run only inside the project directory. Do not edit source, configuration,
|
|
4
|
+
dependencies, or tracked files. Do not read, show, store, or return secret values.
|
|
5
|
+
|
|
6
|
+
Find the expected agent id from the project. Start the existing agent and frontend only
|
|
7
|
+
when they are not already running. Before using a port, identify its process and working
|
|
8
|
+
directory. Do not stop a process outside this project.
|
|
9
|
+
|
|
10
|
+
Prove the live runtime in this order:
|
|
11
|
+
|
|
12
|
+
1. GET `/info` from the project's CopilotKit runtime and require a valid response.
|
|
13
|
+
2. Require `/info` to declare the expected agent id.
|
|
14
|
+
3. Confirm that `licenseStatus` is absent. Its presence means the live runtime uses
|
|
15
|
+
Intelligence and is not an OSS starting state.
|
|
16
|
+
4. Confirm from project files that the runtime constructor passes a `runner` option rather
|
|
17
|
+
than an `intelligence` option. A package, import, project file, or key is not use proof.
|
|
18
|
+
5. Run
|
|
19
|
+
`npx --yes copilotkit@4.9.0 verify --expect-runtime oss --round-trip --agent <expected-agent-id> --json`,
|
|
20
|
+
with the runtime URL or auth header options that this project needs. Require exit zero
|
|
21
|
+
and the JSON `ok` field to be `true`.
|
|
22
|
+
6. Drive one real request through the existing frontend, CopilotKit runtime, and expected
|
|
23
|
+
agent. Require the existing user-visible result. If no browser tool is available, the
|
|
24
|
+
round trip is not proved and the state is `unproved`.
|
|
25
|
+
|
|
26
|
+
Classify the state as `both-oss` only when all six predicates are true: agent present,
|
|
27
|
+
interface present, CopilotKit present, CopilotKit round trip proven, runtime connection
|
|
28
|
+
`oss`, and managed Intelligence not configured. Return each predicate and its secret-safe
|
|
29
|
+
evidence.
|
|
30
|
+
|
|
31
|
+
The default in-memory OSS runner is ephemeral. SQLite, custom, or framework persistence
|
|
32
|
+
can be durable. Report the persistence that project evidence proves, or `unproved`. Do not
|
|
33
|
+
replace it and do not describe all OSS runs as ephemeral.
|
|
34
|
+
|
|
35
|
+
Stop after returning the baseline result, process ids and ports used, and evidence paths.
|
|
@@ -4,6 +4,11 @@ Use the proof steps and documentation URLs from the approved plan. Fetch every s
|
|
|
4
4
|
URL in one step before you start, rather than one after another.
|
|
5
5
|
Do not use remembered CopilotKit instructions.
|
|
6
6
|
|
|
7
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
8
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
9
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
10
|
+
documentation gap only after a second method also fails.
|
|
11
|
+
|
|
7
12
|
Read the port the developer's agent already serves from this project's own
|
|
8
13
|
configuration. Do not assume a default, and do not start a second copy of an agent this
|
|
9
14
|
project is already running. Before you bind any new server, check that the port is free
|
|
@@ -11,8 +16,12 @@ and pick another one if it is not. Record every port you used.
|
|
|
11
16
|
|
|
12
17
|
Start the agent and the selected frontend.
|
|
13
18
|
|
|
19
|
+
Leave the agent and frontend servers running after proof. Record each process ID and a
|
|
20
|
+
safe command that stops that process. Record the frontend URL and the commands that start
|
|
21
|
+
both servers again.
|
|
22
|
+
|
|
14
23
|
With both running, check the wiring in one command before you open a browser:
|
|
15
|
-
`npx copilotkit@4.
|
|
24
|
+
`npx --yes copilotkit@4.9.0 verify --json`. Add `--runtime-url` when the runtime is not at
|
|
16
25
|
`http://localhost:3000/api/copilotkit`. Read the individual checks rather than the summary
|
|
17
26
|
alone: a check reported `undetermined` did not run, and that is not a pass. Fix anything
|
|
18
27
|
that is not a pass before the browser, because a browser failure stacked on broken wiring
|
|
@@ -31,7 +40,7 @@ because the runtime reports no thread-endpoint state, the runtime predates the f
|
|
|
31
40
|
Record that and move on — there is nothing to repair.
|
|
32
41
|
|
|
33
42
|
Then prove that the agent actually runs, which is the gate for this node:
|
|
34
|
-
`npx copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.9.0 verify --round-trip --json`. It sends one request through the
|
|
35
44
|
runtime and reads the answer back from the thread, so it separates an agent that is
|
|
36
45
|
configured from an agent that works. Use `--agent <id>` when the runtime declares more
|
|
37
46
|
than one. If it reports `user-not-identified`, this project's `identifyUser` reads a
|
|
@@ -43,6 +52,11 @@ it.
|
|
|
43
52
|
Then send one real request through the frontend. Make sure that the request passes through
|
|
44
53
|
CopilotKit and reaches the selected agent.
|
|
45
54
|
|
|
55
|
+
For a recorded `both-oss` starting state: Compare the final round trip with the recorded
|
|
56
|
+
OSS baseline. The same frontend request must still reach the same agent and produce the
|
|
57
|
+
same kind of user-visible result. The runtime must now report `licenseStatus`, and the
|
|
58
|
+
authenticated Intelligence checks must pass. Record both before and after evidence.
|
|
59
|
+
|
|
46
60
|
Before you trust the agent, confirm that the process answering is the one in this
|
|
47
61
|
repository. `verify` reports which agents the runtime declares and has nothing to compare
|
|
48
62
|
them against, and `--round-trip` proves an agent answers under the declared id without
|
|
@@ -96,15 +110,14 @@ project's data never reaches the agent, the agent receives it and its instructio
|
|
|
96
110
|
it, the page loads its data after the context was registered, or the run wired a different
|
|
97
111
|
source than the page renders. Fix that cause, then prove again.
|
|
98
112
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
no reason. Fetch the continued-development guide from the main coding agent at the same
|
|
102
|
-
time as the proof documentation.
|
|
113
|
+
Fetch the continued-development guide from the main coding agent with the proof
|
|
114
|
+
documentation. Try the continued-development tools after the application passes proof.
|
|
103
115
|
Use it to install the project-scoped CopilotKit Skills.
|
|
104
116
|
Use it to configure the CopilotKit documentation MCP server for the current coding agent.
|
|
105
117
|
|
|
106
|
-
|
|
107
|
-
|
|
118
|
+
Do not validate whether the Skills or MCP server installed correctly. Record the command
|
|
119
|
+
result for each attempt. Report each tool result separately. A tool error does not change
|
|
120
|
+
the proof result.
|
|
108
121
|
|
|
109
122
|
Gather what you need in as few commands as possible. Combine independent reads into one
|
|
110
123
|
command rather than running them one at a time. Split a command only when its result decides
|
|
@@ -1,16 +1,29 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Stop without a supported path
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
frontend, authentication, and package choices.
|
|
3
|
+
Keep the developer's current agent, frontend, authentication, and package choices.
|
|
5
4
|
|
|
6
5
|
Explain the exact step that failed. State whether authentication, project selection, project
|
|
7
|
-
credentials, the journey, a documentation URL, implementation, validation, or
|
|
8
|
-
the
|
|
6
|
+
credentials, the journey, a documentation URL, implementation, validation, or the round
|
|
7
|
+
trip caused the route change. Do not say a path works when this release does not support it.
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
Stop onboarding without making more repository changes by default.
|
|
10
|
+
|
|
11
|
+
The documentation-gap exception applies only before implementation starts. If implementation,
|
|
12
|
+
validation, or proof already started, do not use the documentation-gap exception.
|
|
13
|
+
|
|
14
|
+
If the only cause is a failed documentation URL or missing documentation, use the exception.
|
|
15
|
+
Tell the developer about the gap. Then make a best-effort plan from the official pages that
|
|
16
|
+
are available. Search the broader official CopilotKit documentation before you infer an API.
|
|
17
|
+
Mark each step that the selected pages do not prove. Do not treat the documentation gap as
|
|
18
|
+
proof that the requested integration is unsupported.
|
|
19
|
+
|
|
20
|
+
After the developer approves the best-effort plan, run
|
|
21
|
+
`npx --yes copilotkit@4.9.0 onboard read fallback/best-effort`.
|
|
22
|
+
|
|
23
|
+
If the developer permitted external feedback at the start, you can send one short report:
|
|
11
24
|
|
|
12
25
|
```text
|
|
13
|
-
npx copilotkit@4.
|
|
26
|
+
npx --yes copilotkit@4.9.0 onboard feedback
|
|
14
27
|
```
|
|
15
28
|
|
|
16
29
|
Write the feedback message to the command's standard input, in at most four lines.
|
|
@@ -18,5 +31,5 @@ Send no secrets, source code, logs, or command output. The command refuses a rep
|
|
|
18
31
|
that carries any of those, prints the reason, and exits zero. A refused report is not
|
|
19
32
|
a failed step. Reword it and send it again, or stop without a report. The command
|
|
20
33
|
prints what it sent. This is the channel for a stop. Report friction only from a run that
|
|
21
|
-
finished, never from here.
|
|
22
|
-
|
|
34
|
+
finished, never from here. If the developer did not permit feedback, do not run the
|
|
35
|
+
command.
|
package/package.json
CHANGED
package/release/release-tool.js
CHANGED
|
@@ -14695,7 +14695,7 @@ import * as path4 from "node:path";
|
|
|
14695
14695
|
|
|
14696
14696
|
// apps/cli/src/config.ts
|
|
14697
14697
|
function getTemplateRef() {
|
|
14698
|
-
return true ? "
|
|
14698
|
+
return true ? "bf2068734bcc42b9dc9999b183d0fd07a673f713" : "main";
|
|
14699
14699
|
}
|
|
14700
14700
|
|
|
14701
14701
|
// apps/cli/src/services/agentcore-config.ts
|