copilotkit 4.26.0 → 4.27.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 +271 -25
- package/cli-build-info.json +7 -7
- package/index.js +6785 -3294
- package/onboarding/index.json +2 -2
- package/onboarding/prompts/authenticate/start.md +28 -23
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +34 -25
- package/onboarding/prompts/credentials/plan.md +46 -33
- package/onboarding/prompts/credentials/settle-credentials.md +38 -14
- package/onboarding/prompts/credentials/write-plan.md +104 -47
- package/onboarding/prompts/deployment/choose-local.md +17 -20
- package/onboarding/prompts/deployment/local-evaluation.md +45 -21
- package/onboarding/prompts/fallback/best-effort.md +11 -9
- package/onboarding/prompts/feature/a2ui/implement.md +4 -4
- package/onboarding/prompts/feature/a2ui/plan.md +3 -3
- package/onboarding/prompts/feature/a2ui/proof.md +5 -5
- package/onboarding/prompts/feature/a2ui/start.md +10 -8
- package/onboarding/prompts/feature/channels/implement.md +11 -8
- package/onboarding/prompts/feature/channels/plan.md +15 -7
- package/onboarding/prompts/feature/channels/proof.md +5 -5
- package/onboarding/prompts/feature/channels/start.md +11 -10
- package/onboarding/prompts/feature/chat-suggestions/implement.md +4 -4
- package/onboarding/prompts/feature/chat-suggestions/plan.md +3 -3
- package/onboarding/prompts/feature/chat-suggestions/proof.md +5 -5
- package/onboarding/prompts/feature/chat-suggestions/start.md +10 -8
- package/onboarding/prompts/feature/complete.md +2 -2
- package/onboarding/prompts/feature/learning/implement.md +14 -12
- package/onboarding/prompts/feature/learning/plan.md +4 -4
- package/onboarding/prompts/feature/learning/proof.md +24 -14
- package/onboarding/prompts/feature/learning/start.md +8 -8
- package/onboarding/prompts/feature/open-generative-ui/implement.md +4 -4
- package/onboarding/prompts/feature/open-generative-ui/plan.md +3 -3
- package/onboarding/prompts/feature/open-generative-ui/proof.md +5 -5
- package/onboarding/prompts/feature/open-generative-ui/start.md +10 -8
- package/onboarding/prompts/feature/realtime-sync/implement.md +7 -5
- package/onboarding/prompts/feature/realtime-sync/plan.md +3 -3
- package/onboarding/prompts/feature/realtime-sync/proof.md +5 -5
- package/onboarding/prompts/feature/realtime-sync/start.md +7 -7
- package/onboarding/prompts/feature/rich-threads/implement.md +8 -6
- package/onboarding/prompts/feature/rich-threads/plan.md +3 -3
- package/onboarding/prompts/feature/rich-threads/proof.md +5 -5
- package/onboarding/prompts/feature/rich-threads/start.md +7 -7
- package/onboarding/prompts/feature/stop.md +4 -4
- package/onboarding/prompts/feature/voice/implement.md +4 -4
- package/onboarding/prompts/feature/voice/plan.md +4 -4
- package/onboarding/prompts/feature/voice/proof.md +5 -5
- package/onboarding/prompts/feature/voice/start.md +10 -8
- package/onboarding/prompts/framework/ag2.md +20 -5
- package/onboarding/prompts/framework/agno.md +25 -9
- package/onboarding/prompts/framework/built-in.md +21 -6
- package/onboarding/prompts/framework/claude-sdk-python.md +11 -5
- package/onboarding/prompts/framework/claude-sdk-typescript.md +13 -6
- package/onboarding/prompts/framework/crewai-flows.md +24 -10
- package/onboarding/prompts/framework/custom-ag-ui.md +62 -28
- package/onboarding/prompts/framework/deep-agents.md +26 -9
- package/onboarding/prompts/framework/google-adk.md +18 -5
- package/onboarding/prompts/framework/langgraph-fastapi.md +20 -5
- package/onboarding/prompts/framework/langgraph-python.md +20 -5
- package/onboarding/prompts/framework/langgraph-typescript.md +27 -7
- package/onboarding/prompts/framework/llamaindex.md +24 -8
- package/onboarding/prompts/framework/mastra.md +21 -8
- package/onboarding/prompts/framework/ms-agent-dotnet.md +24 -6
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +24 -5
- package/onboarding/prompts/framework/ms-agent-python.md +21 -5
- package/onboarding/prompts/framework/pydantic-ai.md +20 -5
- package/onboarding/prompts/framework/strands-python.md +27 -12
- package/onboarding/prompts/framework/strands-typescript.md +27 -12
- package/onboarding/prompts/frontend/angular.md +4 -4
- package/onboarding/prompts/frontend/nextjs.md +4 -4
- package/onboarding/prompts/frontend/plan.md +21 -13
- package/onboarding/prompts/frontend/react-native.md +3 -3
- package/onboarding/prompts/frontend/react-spa.md +3 -3
- package/onboarding/prompts/frontend/vue.md +3 -3
- package/onboarding/prompts/implementation/build-and-validate.md +25 -20
- package/onboarding/prompts/proof/complete.md +10 -7
- package/onboarding/prompts/proof/oss-baseline.md +6 -6
- package/onboarding/prompts/proof/round-trip.md +10 -10
- package/onboarding/prompts/research/gather.md +8 -8
- package/onboarding/prompts/research/merge.md +3 -3
- package/onboarding/prompts/research/preflight.md +2 -2
- package/onboarding/prompts/research/route.md +4 -4
- package/onboarding/prompts/setup/questions.md +192 -159
- package/onboarding/prompts/starter/clone.md +126 -51
- package/onboarding/prompts/stopped/run-failed.md +5 -3
- package/onboarding/prompts/subagent/create-plan.md +73 -20
- package/onboarding/prompts/subagent/implement-and-validate.md +30 -14
- package/onboarding/prompts/subagent/inspect-repository.md +3 -2
- package/onboarding/prompts/subagent/prove-oss-baseline.md +10 -5
- package/onboarding/prompts/subagent/prove-round-trip.md +23 -14
- package/onboarding/prompts/unsupported/no-validated-path.md +5 -4
- package/package.json +1 -1
- package/release/release-tool.js +12 -2
|
@@ -1,20 +1,51 @@
|
|
|
1
|
-
# Connect
|
|
1
|
+
# Connect a custom agent
|
|
2
|
+
|
|
3
|
+
This route is for any agent that is none of the listed frameworks. It has three cases:
|
|
4
|
+
|
|
5
|
+
1. The project has an agent that speaks AG-UI, such as an `AbstractAgent` subclass that
|
|
6
|
+
the project wrote, or a service that streams AG-UI events through AG-UI middleware.
|
|
7
|
+
Connect it as it is.
|
|
8
|
+
2. The project has an agent that does not speak AG-UI. Write an adapter around it: an
|
|
9
|
+
`AbstractAgent` subclass that calls the agent's existing entry point, such as its
|
|
10
|
+
function or its HTTP route, and emits AG-UI events, as the `backend/ag-ui.md` page
|
|
11
|
+
below shows. The adapter is new code. The agent's own code does not change.
|
|
12
|
+
3. The developer wants a new agent on a framework that is not listed. `onboard
|
|
13
|
+
setup-answers` prints its name as `frameworkName`. The plan builds it with that
|
|
14
|
+
framework's own documentation and the vendor that `setup/questions` recorded, then
|
|
15
|
+
connects it as case 1 or case 2. For case 3, the default vendor is
|
|
16
|
+
OpenAI.
|
|
17
|
+
|
|
18
|
+
In cases 1 and 2, do not port the agent to a listed framework, and do not rewrite its
|
|
19
|
+
tools, model, or prompts. Preserve its model setup and the credential variable names that
|
|
20
|
+
the repository already uses. An existing agent has no default vendor on this route.
|
|
21
|
+
|
|
22
|
+
This release offers a new agent on this route OpenAI or an OpenAI-compatible provider
|
|
23
|
+
only. For a new agent, if the developer names Anthropic or Google, say that this release
|
|
24
|
+
supports OpenAI or an OpenAI-compatible provider on this route, that Anthropic and Google
|
|
25
|
+
come in a later release, and offer the built-in CopilotKit agent if they need Anthropic or
|
|
26
|
+
Google now. An existing agent keeps its vendor and model. If it runs on Anthropic or
|
|
27
|
+
Google, add one line to the plan: the page context that CopilotKit sends can fail with
|
|
28
|
+
that vendor until a CopilotKit SDK release fixes it (PE-728).
|
|
29
|
+
|
|
30
|
+
The research findings name the case and cite the file. Either of these proves case 1:
|
|
2
31
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
Do not port the agent to a listed framework. Do not rewrite its tools, model, or prompts.
|
|
8
|
-
Preserve its model setup and the credential variable names that the repository already
|
|
9
|
-
uses. This route has no default vendor.
|
|
32
|
+
- a class that extends `AbstractAgent` from `@ag-ui/client` and implements `run`,
|
|
33
|
+
- an endpoint that the project serves and that streams AG-UI events: its response is
|
|
34
|
+
`text/event-stream`, with events such as `RUN_STARTED` and `TEXT_MESSAGE_CONTENT`.
|
|
10
35
|
|
|
11
|
-
|
|
36
|
+
A package that names AG-UI is not proof. Read the entry point before you choose case 2.
|
|
37
|
+
Case 2 applies only to an entry point that takes a user message and returns the agent's
|
|
38
|
+
answer, from a model or from rules, as a function the runtime can import or as an HTTP
|
|
39
|
+
route. An entry point that
|
|
40
|
+
streams AG-UI events is case 1. If no entry point fits, such as an agent in another
|
|
41
|
+
language with no HTTP route, or code that is not an agent, ask the developer how the agent
|
|
42
|
+
runs, and do not write an adapter yet.
|
|
12
43
|
|
|
13
|
-
|
|
14
|
-
- an endpoint that the project serves and that streams AG-UI events.
|
|
44
|
+
Before you end your turn to wait for the developer, report the pause:
|
|
15
45
|
|
|
16
|
-
|
|
17
|
-
|
|
46
|
+
```text
|
|
47
|
+
npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
|
|
48
|
+
```
|
|
18
49
|
|
|
19
50
|
## Documentation
|
|
20
51
|
|
|
@@ -63,7 +94,7 @@ it.
|
|
|
63
94
|
Before you end your turn to wait for the developer, report the pause:
|
|
64
95
|
|
|
65
96
|
```text
|
|
66
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
97
|
+
npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
|
|
67
98
|
```
|
|
68
99
|
|
|
69
100
|
## Keep the agent working on a clone
|
|
@@ -76,32 +107,35 @@ fields, so this applies only to a subclass.
|
|
|
76
107
|
|
|
77
108
|
Read the subclass before you plan. If `run` reads a field that the subclass sets, and
|
|
78
109
|
the subclass does not override `clone()`, the plan adds an override. The override calls
|
|
79
|
-
`super.clone()` and copies those fields.
|
|
80
|
-
the agent's code. Name it in the plan.
|
|
110
|
+
`super.clone()` and copies those fields. Name it in the plan.
|
|
81
111
|
|
|
82
112
|
## Project data
|
|
83
113
|
|
|
84
114
|
The agent receives `useAgentContext` entries on the AG-UI run input, in its `context`
|
|
85
|
-
field.
|
|
86
|
-
|
|
87
|
-
agent's
|
|
88
|
-
|
|
115
|
+
field. If the requested work passes project data to the agent, and the agent's code does
|
|
116
|
+
not already read `context`, pass the entries on. In case 2, the adapter passes them to the
|
|
117
|
+
agent's entry point, for example as part of its input. In case 1, the project's own
|
|
118
|
+
`AbstractAgent` subclass passes them to its model, and a service behind `HttpAgent` that
|
|
119
|
+
ignores `context` reads it in its own code. These changes and the `clone()` override are
|
|
120
|
+
the only changes this route makes to the agent's code. Name each one in the plan.
|
|
89
121
|
|
|
90
|
-
|
|
91
|
-
|
|
122
|
+
If the developer asks for A2UI, https://docs.copilotkit.ai/generative-ui/a2ui.md has its
|
|
123
|
+
steps.
|
|
92
124
|
|
|
93
125
|
## Record the selection
|
|
94
126
|
|
|
95
|
-
The Copilot Runtime that this route adds runs on Node
|
|
96
|
-
the project runs it now.
|
|
127
|
+
The Copilot Runtime that this route adds runs on Node, and so does an adapter. The agent
|
|
128
|
+
keeps running the way the project runs it now. An adapter for an agent in another language
|
|
129
|
+
calls it through its HTTP route.
|
|
97
130
|
|
|
98
|
-
Record the selected framework `custom-ag-ui
|
|
131
|
+
Record the selected framework `custom-ag-ui`, the case, and the agent id. Record how the agent
|
|
99
132
|
connects: in the runtime process, or through `HttpAgent` and its URL. Record the
|
|
100
133
|
credential variable names that the agent already uses, the `clone()` finding, and these
|
|
101
|
-
URLs.
|
|
134
|
+
URLs. For case 3, record the credential variable of the recorded vendor, such as
|
|
135
|
+
`OPENAI_API_KEY`.
|
|
102
136
|
|
|
103
137
|
If the pages support the selection, run
|
|
104
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
138
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
105
139
|
|
|
106
140
|
If the documentation does not support the selection, run
|
|
107
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
141
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,9 +1,25 @@
|
|
|
1
1
|
# Configure Deep Agents
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing Deep Agents language and model setup. For a new agent, use the vendor
|
|
4
|
-
that the framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
that the framework step recorded. Use OpenAI only when the record and this conversation
|
|
9
|
+
have no vendor. This release offers a new agent on this framework OpenAI or an
|
|
10
|
+
OpenAI-compatible provider only. For a new agent, if the developer names Anthropic or
|
|
11
|
+
Google, say that this release supports OpenAI or an OpenAI-compatible provider on this
|
|
12
|
+
framework, that Anthropic and Google come in a later release, and offer the built-in
|
|
13
|
+
CopilotKit agent if they need Anthropic or Google now. An existing agent keeps its vendor
|
|
14
|
+
and model. If it runs on Anthropic or Google, add one line to the plan: the page context
|
|
15
|
+
that CopilotKit sends can fail with that vendor until a CopilotKit SDK release fixes it
|
|
16
|
+
(PE-728). Take that vendor's package, class, and credential variable names from the
|
|
17
|
+
framework's own documentation, and use a model id that the vendor serves to a new key
|
|
18
|
+
today. For an OpenAI-compatible provider, keep `OPENAI_API_KEY`, use the model id that
|
|
19
|
+
`setup/questions` recorded, and write the base URL that `setup/questions` recorded as
|
|
20
|
+
`OPENAI_BASE_URL` in the app's env file. The key can stay in its own file. Where the
|
|
21
|
+
framework does not read that variable, also pass it in code. Take every CopilotKit step
|
|
22
|
+
from the pages below.
|
|
7
23
|
|
|
8
24
|
Name the default model credential `OPENAI_API_KEY`.
|
|
9
25
|
|
|
@@ -20,9 +36,10 @@ Preserve the project's existing deployment path. Choose the same `Deep Agent` or
|
|
|
20
36
|
`FastAPI` tab in both the quickstart and runtime setup. Do not change a Deep Agent
|
|
21
37
|
deployment to FastAPI or a FastAPI deployment to Deep Agent.
|
|
22
38
|
|
|
23
|
-
|
|
24
|
-
agent-app-context
|
|
25
|
-
|
|
39
|
+
The agent receives `useAgentContext` entries on the AG-UI run input, in its `context`
|
|
40
|
+
field, as https://docs.copilotkit.ai/agent-app-context.md shows. If the requested work
|
|
41
|
+
passes project data to the agent, read `context` in the agent with this framework's own
|
|
42
|
+
API, and pass it to the model. Name that code in the plan.
|
|
26
43
|
|
|
27
44
|
A2UI is not on this path. If the developer asks for it, say first that its backend example
|
|
28
45
|
is Python-only, so a TypeScript project has nothing to follow.
|
|
@@ -31,10 +48,10 @@ Connect the Copilot Runtime with `LangGraphAgent` from `@copilotkit/runtime/lang
|
|
|
31
48
|
on the Deep Agent path, or `HttpAgent` from `@ag-ui/client` on the FastAPI path.
|
|
32
49
|
|
|
33
50
|
Record the selected framework, language, vendor, model, required credential variable
|
|
34
|
-
names, these URLs, and
|
|
51
|
+
names, these URLs, and how the agent reads `context`.
|
|
35
52
|
|
|
36
53
|
If the pages support the selection, run
|
|
37
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
54
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
38
55
|
|
|
39
56
|
If the documentation does not support the selection, run
|
|
40
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
57
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,8 +1,21 @@
|
|
|
1
1
|
# Configure ADK
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
vendor
|
|
5
|
-
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
7
|
+
Preserve an existing ADK model setup. For a new agent, use the recorded vendor. Use Google
|
|
8
|
+
only when the record and this conversation have no vendor. This release runs ADK on
|
|
9
|
+
Google, OpenAI, or an OpenAI-compatible provider. For a new agent, if the developer names
|
|
10
|
+
Anthropic, say that this release supports Google, OpenAI, or an OpenAI-compatible provider
|
|
11
|
+
on ADK, that Anthropic comes in a later release, and offer the built-in CopilotKit agent
|
|
12
|
+
if they need Anthropic now. An existing agent keeps its vendor and model. Take that
|
|
13
|
+
vendor's package, class, and credential variable names from the framework's own
|
|
14
|
+
documentation, and use a model id that the vendor serves to a new key today. For an
|
|
15
|
+
OpenAI-compatible provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions`
|
|
16
|
+
recorded, and write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in
|
|
17
|
+
the app's env file. The key can stay in its own file. Where the framework does not read
|
|
18
|
+
that variable, also pass it in code. Take every CopilotKit step from the pages below.
|
|
6
19
|
|
|
7
20
|
Name the model credential `GOOGLE_API_KEY`. This framework accepts more than one
|
|
8
21
|
spelling, and a scaffold that reaches for a different one looks finished and reads no
|
|
@@ -30,7 +43,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
43
|
these URLs.
|
|
31
44
|
|
|
32
45
|
If the pages support the selection, run
|
|
33
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
46
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
34
47
|
|
|
35
48
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
49
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
# Configure LangGraph FastAPI
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing LangGraph FastAPI model setup. For a new agent, use the vendor that
|
|
4
|
-
the framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
the framework step recorded. Use OpenAI only when the record and this conversation have no
|
|
9
|
+
vendor. This release offers a new agent on this framework OpenAI or an OpenAI-compatible
|
|
10
|
+
provider only. For a new agent, if the developer names Anthropic or Google, say that this
|
|
11
|
+
release supports OpenAI or an OpenAI-compatible provider on this framework, that Anthropic
|
|
12
|
+
and Google come in a later release, and offer the built-in CopilotKit agent if they need
|
|
13
|
+
Anthropic or Google now. An existing agent keeps its vendor and model. If it runs on
|
|
14
|
+
Anthropic or Google, add one line to the plan: the page context that CopilotKit sends can
|
|
15
|
+
fail with that vendor until a CopilotKit SDK release fixes it (PE-728). Take that vendor's
|
|
16
|
+
package, class, and credential variable names from the framework's own documentation, and
|
|
17
|
+
use a model id that the vendor serves to a new key today. For an OpenAI-compatible
|
|
18
|
+
provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and
|
|
19
|
+
write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env
|
|
20
|
+
file. The key can stay in its own file. Where the framework does not read that variable,
|
|
21
|
+
also pass it in code. Take every CopilotKit step from the pages below.
|
|
7
22
|
|
|
8
23
|
Name the default model credential `OPENAI_API_KEY`.
|
|
9
24
|
|
|
@@ -28,7 +43,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
28
43
|
these URLs.
|
|
29
44
|
|
|
30
45
|
If the pages support the selection, run
|
|
31
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
46
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
32
47
|
|
|
33
48
|
If the documentation does not support the selection, run
|
|
34
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
49
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
# Configure LangGraph Python
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing LangGraph Python model setup. For a new agent, use the vendor that
|
|
4
|
-
the framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
the framework step recorded. Use OpenAI only when the record and this conversation have no
|
|
9
|
+
vendor. This release offers a new agent on this framework OpenAI or an OpenAI-compatible
|
|
10
|
+
provider only. For a new agent, if the developer names Anthropic or Google, say that this
|
|
11
|
+
release supports OpenAI or an OpenAI-compatible provider on this framework, that Anthropic
|
|
12
|
+
and Google come in a later release, and offer the built-in CopilotKit agent if they need
|
|
13
|
+
Anthropic or Google now. An existing agent keeps its vendor and model. If it runs on
|
|
14
|
+
Anthropic or Google, add one line to the plan: the page context that CopilotKit sends can
|
|
15
|
+
fail with that vendor until a CopilotKit SDK release fixes it (PE-728). Take that vendor's
|
|
16
|
+
package, class, and credential variable names from the framework's own documentation, and
|
|
17
|
+
use a model id that the vendor serves to a new key today. For an OpenAI-compatible
|
|
18
|
+
provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and
|
|
19
|
+
write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env
|
|
20
|
+
file. The key can stay in its own file. Where the framework does not read that variable,
|
|
21
|
+
also pass it in code. Take every CopilotKit step from the pages below.
|
|
7
22
|
|
|
8
23
|
Name the default model credential `OPENAI_API_KEY`.
|
|
9
24
|
|
|
@@ -22,7 +37,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
22
37
|
these URLs.
|
|
23
38
|
|
|
24
39
|
If the pages support the selection, run
|
|
25
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
40
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
26
41
|
|
|
27
42
|
If the documentation does not support the selection, run
|
|
28
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
43
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,9 +1,25 @@
|
|
|
1
1
|
# Configure LangGraph TypeScript
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing LangGraph TypeScript model setup. For a new agent, use the vendor
|
|
4
|
-
that the framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
that the framework step recorded. Use OpenAI only when the record and this conversation
|
|
9
|
+
have no vendor. This release offers a new agent on this framework OpenAI or an
|
|
10
|
+
OpenAI-compatible provider only. For a new agent, if the developer names Anthropic or
|
|
11
|
+
Google, say that this release supports OpenAI or an OpenAI-compatible provider on this
|
|
12
|
+
framework, that Anthropic and Google come in a later release, and offer the built-in
|
|
13
|
+
CopilotKit agent if they need Anthropic or Google now. An existing agent keeps its vendor
|
|
14
|
+
and model. If it runs on Anthropic or Google, add one line to the plan: the page context
|
|
15
|
+
that CopilotKit sends can fail with that vendor until a CopilotKit SDK release fixes it
|
|
16
|
+
(PE-728). Take that vendor's package, class, and credential variable names from the
|
|
17
|
+
framework's own documentation, and use a model id that the vendor serves to a new key
|
|
18
|
+
today. For an OpenAI-compatible provider, keep `OPENAI_API_KEY`, use the model id that
|
|
19
|
+
`setup/questions` recorded, and write the base URL that `setup/questions` recorded as
|
|
20
|
+
`OPENAI_BASE_URL` in the app's env file. The key can stay in its own file. Where the
|
|
21
|
+
framework does not read that variable, also pass it in code. Take every CopilotKit step
|
|
22
|
+
from the pages below.
|
|
7
23
|
|
|
8
24
|
Name the default model credential `OPENAI_API_KEY`.
|
|
9
25
|
|
|
@@ -18,11 +34,15 @@ Connect the Copilot Runtime with `LangGraphAgent` from `@copilotkit/runtime/lang
|
|
|
18
34
|
on the LangSmith path, or `HttpAgent` from `@ag-ui/client` on the FastAPI path.
|
|
19
35
|
`LangGraphHttpAgent` is deprecated. Do not use it.
|
|
20
36
|
|
|
21
|
-
|
|
22
|
-
|
|
37
|
+
A package script that starts a new LangGraph TypeScript agent runs
|
|
38
|
+
`npx @langchain/langgraph-cli dev`. The JavaScript CLI installs its binary as `langgraphjs`.
|
|
39
|
+
`langgraph` is the Python CLI, and a JavaScript project does not have it.
|
|
40
|
+
|
|
41
|
+
Record the selected framework, vendor, model, required credential variable names, this
|
|
42
|
+
start command, and these URLs.
|
|
23
43
|
|
|
24
44
|
If the pages support the selection, run
|
|
25
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
45
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
26
46
|
|
|
27
47
|
If the documentation does not support the selection, run
|
|
28
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
48
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
# Configure LlamaIndex
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing LlamaIndex model setup. For a new agent, use the vendor that the
|
|
4
|
-
framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
framework step recorded. Use OpenAI only when the record and this conversation have no
|
|
9
|
+
vendor. This release offers a new agent on this framework OpenAI or an OpenAI-compatible
|
|
10
|
+
provider only. For a new agent, if the developer names Anthropic or Google, say that this
|
|
11
|
+
release supports OpenAI or an OpenAI-compatible provider on this framework, that Anthropic
|
|
12
|
+
and Google come in a later release, and offer the built-in CopilotKit agent if they need
|
|
13
|
+
Anthropic or Google now. An existing agent keeps its vendor and model. If it runs on
|
|
14
|
+
Anthropic or Google, add one line to the plan: the page context that CopilotKit sends can
|
|
15
|
+
fail with that vendor until a CopilotKit SDK release fixes it (PE-728). Take that vendor's
|
|
16
|
+
package, class, and credential variable names from the framework's own documentation, and
|
|
17
|
+
use a model id that the vendor serves to a new key today. For an OpenAI-compatible
|
|
18
|
+
provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and
|
|
19
|
+
write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env
|
|
20
|
+
file. The key can stay in its own file. Where the framework does not read that variable,
|
|
21
|
+
also pass it in code. Take every CopilotKit step from the pages below.
|
|
7
22
|
|
|
8
23
|
Name the default model credential `OPENAI_API_KEY`.
|
|
9
24
|
|
|
@@ -27,15 +42,16 @@ A2UI is not on this path. If the developer asks for it, say first that its page
|
|
|
27
42
|
LlamaIndex backend code but does not bundle its runtime setup, so it only works on top of
|
|
28
43
|
the quickstart runtime it extends.
|
|
29
44
|
|
|
30
|
-
The
|
|
31
|
-
|
|
32
|
-
|
|
45
|
+
The agent receives `useAgentContext` entries on the AG-UI run input, in its `context`
|
|
46
|
+
field, as https://docs.copilotkit.ai/agent-app-context.md shows. If the requested work
|
|
47
|
+
passes project data to the agent, read `context` in the agent with this framework's own
|
|
48
|
+
API, and pass it to the model. Name that code in the plan.
|
|
33
49
|
|
|
34
50
|
Record the selected framework, vendor, model, required credential variable names, these
|
|
35
51
|
URLs, the documented dependencies and adapter, and both documentation limits.
|
|
36
52
|
|
|
37
53
|
If the pages support the selection, run
|
|
38
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
54
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
39
55
|
|
|
40
56
|
If the documentation does not support the selection, run
|
|
41
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
57
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,13 +1,26 @@
|
|
|
1
1
|
# Configure Mastra
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing Mastra model setup. For a new agent, use the vendor that the
|
|
4
|
-
framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
framework step recorded. Use OpenAI only when the record and this conversation have no
|
|
9
|
+
vendor. This release offers a new agent on this framework OpenAI or an OpenAI-compatible
|
|
10
|
+
provider only. For a new agent, if the developer names Anthropic or Google, say that this
|
|
11
|
+
release supports OpenAI or an OpenAI-compatible provider on this framework, that Anthropic
|
|
12
|
+
and Google come in a later release, and offer the built-in CopilotKit agent if they need
|
|
13
|
+
Anthropic or Google now. An existing agent keeps its vendor and model. If it runs on
|
|
14
|
+
Anthropic or Google, add one line to the plan: the page context that CopilotKit sends can
|
|
15
|
+
fail with that vendor until a CopilotKit SDK release fixes it (PE-728). Take that vendor's
|
|
16
|
+
package, class, and credential variable names from the framework's own documentation, and
|
|
17
|
+
use a model id that the vendor serves to a new key today. For an OpenAI-compatible
|
|
18
|
+
provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and
|
|
19
|
+
write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env
|
|
20
|
+
file. The key can stay in its own file. Where the framework does not read that variable,
|
|
21
|
+
also pass it in code. Take every CopilotKit step from the pages below.
|
|
7
22
|
|
|
8
|
-
Name the default model credential `OPENAI_API_KEY`.
|
|
9
|
-
quickstart's steps to run the agent on Anthropic, and name the credential
|
|
10
|
-
`ANTHROPIC_API_KEY`.
|
|
23
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
11
24
|
|
|
12
25
|
`mastra dev` loads the `.env` beside the project it serves and does not look in a
|
|
13
26
|
parent directory. When one credential file serves more than one part of the repository,
|
|
@@ -50,7 +63,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
50
63
|
these URLs.
|
|
51
64
|
|
|
52
65
|
If the pages support the selection, run
|
|
53
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
66
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
54
67
|
|
|
55
68
|
If the documentation does not support the selection, run
|
|
56
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
69
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,7 +1,25 @@
|
|
|
1
1
|
# Configure Microsoft Agent Framework for .NET
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
7
|
+
Preserve an existing Microsoft Agent Framework model setup. For a new agent, use the
|
|
8
|
+
vendor that the framework step recorded. Use direct OpenAI only when the record and this
|
|
9
|
+
conversation have no vendor, and name its credential `OPENAI_API_KEY`. This release offers
|
|
10
|
+
a new agent on this framework OpenAI or an OpenAI-compatible provider only. For a new
|
|
11
|
+
agent, if the developer names Anthropic or Google, say that this release supports OpenAI
|
|
12
|
+
or an OpenAI-compatible provider on this framework, that Anthropic and Google come in a
|
|
13
|
+
later release, and offer the built-in CopilotKit agent if they need Anthropic or Google
|
|
14
|
+
now. An existing agent keeps its vendor and model. If it runs on Anthropic or Google, add
|
|
15
|
+
one line to the plan: the page context that CopilotKit sends can fail with that vendor
|
|
16
|
+
until a CopilotKit SDK release fixes it (PE-728). Take that vendor's package, class, and
|
|
17
|
+
credential variable names from the framework's own documentation, and use a model id that
|
|
18
|
+
the vendor serves to a new key today. For an OpenAI-compatible provider, keep
|
|
19
|
+
`OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and write the base URL
|
|
20
|
+
that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env file. The key can
|
|
21
|
+
stay in its own file. Where the framework does not read that variable, also pass it in
|
|
22
|
+
code. Take every CopilotKit step from the pages below. Do not change an existing provider.
|
|
5
23
|
|
|
6
24
|
.NET configuration reads appsettings, environment variables, and user secrets. It does not
|
|
7
25
|
read a `.env` file. If the project uses `.env`, application code must load it before the
|
|
@@ -15,13 +33,13 @@ Run `dotnet --version` before you change the project. If it fails, no .NET SDK i
|
|
|
15
33
|
shell's PATH. Do not change the project, and do not install the SDK yourself. Tell the
|
|
16
34
|
developer to install the .NET SDK from https://dotnet.microsoft.com/download. Say that the
|
|
17
35
|
coding agent's shell cannot see a new install until the developer restarts the coding
|
|
18
|
-
agent. Give them `npx --prefer-offline --yes copilotkit@4.
|
|
36
|
+
agent. Give them `npx --prefer-offline --yes copilotkit@4.27.0 onboard start --run <onboarding_run_id>`
|
|
19
37
|
to resume the run after the restart.
|
|
20
38
|
|
|
21
39
|
Before you end your turn to wait for the developer, report the pause:
|
|
22
40
|
|
|
23
41
|
```text
|
|
24
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
42
|
+
npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
|
|
25
43
|
```
|
|
26
44
|
|
|
27
45
|
Then end your turn and wait for the developer.
|
|
@@ -49,7 +67,7 @@ Record the selected framework, provider, model, required credential variable nam
|
|
|
49
67
|
these URLs.
|
|
50
68
|
|
|
51
69
|
If the pages support the selection, run
|
|
52
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
70
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
53
71
|
|
|
54
72
|
If the documentation does not support the selection, run
|
|
55
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
73
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,7 +1,26 @@
|
|
|
1
1
|
# Configure MS Agent Harness for .NET
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing MS Agent Harness model, provider, credential name, and host setup.
|
|
4
|
-
|
|
8
|
+
For a new setup, use the vendor that the framework step recorded. Use direct OpenAI only
|
|
9
|
+
when the record and this conversation have no vendor, and name its credential
|
|
10
|
+
`OPENAI_API_KEY`. This release offers a new agent on this framework OpenAI or an
|
|
11
|
+
OpenAI-compatible provider only. For a new agent, if the developer names Anthropic or
|
|
12
|
+
Google, say that this release supports OpenAI or an OpenAI-compatible provider on this
|
|
13
|
+
framework, that Anthropic and Google come in a later release, and offer the built-in
|
|
14
|
+
CopilotKit agent if they need Anthropic or Google now. An existing agent keeps its vendor
|
|
15
|
+
and model. If it runs on Anthropic or Google, add one line to the plan: the page context
|
|
16
|
+
that CopilotKit sends can fail with that vendor until a CopilotKit SDK release fixes it
|
|
17
|
+
(PE-728). Take that vendor's package, class, and credential variable names from the
|
|
18
|
+
framework's own documentation, and use a model id that the vendor serves to a new key
|
|
19
|
+
today. For an OpenAI-compatible provider, keep `OPENAI_API_KEY`, use the model id that
|
|
20
|
+
`setup/questions` recorded, and write the base URL that `setup/questions` recorded as
|
|
21
|
+
`OPENAI_BASE_URL` in the app's env file. The key can stay in its own file. Where the
|
|
22
|
+
framework does not read that variable, also pass it in code. Take every CopilotKit step
|
|
23
|
+
from the pages below.
|
|
5
24
|
|
|
6
25
|
For a user secret, run `dotnet user-secrets set OPENAI_API_KEY` from the agent directory.
|
|
7
26
|
The app must read the same name through .NET configuration. Run `dotnet --version` before
|
|
@@ -9,13 +28,13 @@ you change the project. If it fails, no .NET SDK is on this shell's PATH. Do not
|
|
|
9
28
|
the project, and do not install the SDK yourself. Tell the developer to install the .NET
|
|
10
29
|
SDK from https://dotnet.microsoft.com/download. Say that the coding agent's shell cannot
|
|
11
30
|
see a new install until the developer restarts the coding agent. Give them
|
|
12
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
31
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard start --run <onboarding_run_id>` to resume the run
|
|
13
32
|
after the restart.
|
|
14
33
|
|
|
15
34
|
Before you end your turn to wait for the developer, report the pause:
|
|
16
35
|
|
|
17
36
|
```text
|
|
18
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
37
|
+
npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
|
|
19
38
|
```
|
|
20
39
|
|
|
21
40
|
Then end your turn and wait for the developer.
|
|
@@ -57,7 +76,7 @@ Record the selected framework, provider, model, required credential variable nam
|
|
|
57
76
|
URLs, and the quickstart gap.
|
|
58
77
|
|
|
59
78
|
If the pages support the selection, run
|
|
60
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
79
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
61
80
|
|
|
62
81
|
If the documentation does not support the selection, run
|
|
63
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
82
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,9 +1,25 @@
|
|
|
1
1
|
# Configure Microsoft Agent Framework for Python
|
|
2
2
|
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
|
|
4
|
+
vendor the framework step recorded, even after this conversation lost it, with
|
|
5
|
+
`vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
|
|
6
|
+
|
|
3
7
|
Preserve an existing Microsoft Agent Framework model setup. For a new agent, use the
|
|
4
|
-
vendor that the framework step recorded.
|
|
5
|
-
|
|
6
|
-
|
|
8
|
+
vendor that the framework step recorded. Use OpenAI only when the record and this
|
|
9
|
+
conversation have no vendor. This release offers a new agent on this framework OpenAI or
|
|
10
|
+
an OpenAI-compatible provider only. For a new agent, if the developer names Anthropic or
|
|
11
|
+
Google, say that this release supports OpenAI or an OpenAI-compatible provider on this
|
|
12
|
+
framework, that Anthropic and Google come in a later release, and offer the built-in
|
|
13
|
+
CopilotKit agent if they need Anthropic or Google now. An existing agent keeps its vendor
|
|
14
|
+
and model. If it runs on Anthropic or Google, add one line to the plan: the page context
|
|
15
|
+
that CopilotKit sends can fail with that vendor until a CopilotKit SDK release fixes it
|
|
16
|
+
(PE-728). Take that vendor's package, class, and credential variable names from the
|
|
17
|
+
framework's own documentation, and use a model id that the vendor serves to a new key
|
|
18
|
+
today. For an OpenAI-compatible provider, keep `OPENAI_API_KEY`, use the model id that
|
|
19
|
+
`setup/questions` recorded, and write the base URL that `setup/questions` recorded as
|
|
20
|
+
`OPENAI_BASE_URL` in the app's env file. The key can stay in its own file. Where the
|
|
21
|
+
framework does not read that variable, also pass it in code. Take every CopilotKit step
|
|
22
|
+
from the pages below.
|
|
7
23
|
|
|
8
24
|
Name the model credential `OPENAI_API_KEY`, in `agent/.env`, for a new agent. This
|
|
9
25
|
framework also accepts Azure OpenAI, through `AZURE_OPENAI_ENDPOINT` and
|
|
@@ -31,7 +47,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
31
47
|
these URLs.
|
|
32
48
|
|
|
33
49
|
If the pages support the selection, run
|
|
34
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
50
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
|
|
35
51
|
|
|
36
52
|
If the documentation does not support the selection, run
|
|
37
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
53
|
+
`npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
|