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
|
@@ -20,31 +20,44 @@ succeeds. Record that state in the plan.
|
|
|
20
20
|
If the developer needs a project or another project, do the selection yourself from the
|
|
21
21
|
target directory. Do not send the developer to another terminal.
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Read the choices first:
|
|
24
24
|
|
|
25
25
|
```text
|
|
26
|
-
npx copilotkit@4.
|
|
26
|
+
npx --yes copilotkit@4.9.0 project list --json
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
With `--json` the payload is the only thing on standard output, so it is safe to parse.
|
|
30
|
-
Show the
|
|
31
|
-
|
|
32
|
-
|
|
30
|
+
Show the current selection and the five most recent projects. Sort recency by `createdAt`.
|
|
31
|
+
Offer search, create-new, and list-all options. Do not show every project unless the
|
|
32
|
+
developer asks.
|
|
33
|
+
|
|
34
|
+
If the developer searches, run:
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
npx --yes copilotkit@4.9.0 project list --search <query> --json
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
If the developer asks for all projects, show the result of the first list command. Ask
|
|
41
|
+
which project to use, or ask for a new project name. Ask this with the frontend and model
|
|
42
|
+
choices when those choices remain unknown.
|
|
33
43
|
|
|
34
44
|
Then record their answer, from the target directory:
|
|
35
45
|
|
|
36
46
|
```text
|
|
37
|
-
npx copilotkit@4.
|
|
47
|
+
npx --yes copilotkit@4.9.0 project select --project <slug-or-id> --json
|
|
38
48
|
```
|
|
39
49
|
|
|
40
50
|
Use `--create <name> --json` instead when they want a new project. The two flags cannot be
|
|
41
51
|
combined. A slug that does not exist fails and lists the real ones, so a typo cannot record
|
|
42
52
|
a selection that points at nothing.
|
|
43
53
|
|
|
44
|
-
Read the JSON result. It reports `api_key_provisioned
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
54
|
+
Read the JSON result. It reports `selected_project_slug`, `api_key_provisioned`,
|
|
55
|
+
`project_file_written`, and `environment_file_written` at the top level. The result does
|
|
56
|
+
not contain a secret. Report `selected_project_slug` as the project slug that the server
|
|
57
|
+
selected or created. Require `api_key_provisioned`, `project_file_written`, and
|
|
58
|
+
`environment_file_written` to be true. If one is false, report the error and stop
|
|
59
|
+
onboarding. Key provisioning is non-fatal, so the command can persist a selection and
|
|
60
|
+
still exit zero with no key. A scaffold with no key looks finished and is not.
|
|
48
61
|
|
|
49
62
|
Never print the payload or any secret value.
|
|
50
63
|
|
|
@@ -103,10 +116,10 @@ values.
|
|
|
103
116
|
Show only the selected framework, frontend, model, planned file changes, validation commands, and proof steps.
|
|
104
117
|
|
|
105
118
|
If the developer approves the plan, run
|
|
106
|
-
`npx copilotkit@4.
|
|
119
|
+
`npx --yes copilotkit@4.9.0 onboard read implementation/build-and-validate`.
|
|
107
120
|
|
|
108
121
|
If no exact supported path or documentation URL exists, run
|
|
109
|
-
`npx copilotkit@4.
|
|
122
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
110
123
|
|
|
111
124
|
## Planning subagent brief
|
|
112
125
|
|
|
@@ -120,6 +133,11 @@ Use the selected framework, frontend, model, repository findings, and documentat
|
|
|
120
133
|
from the main coding agent. Fetch every selected URL in one step rather than one after
|
|
121
134
|
another. Do not use remembered CopilotKit instructions.
|
|
122
135
|
|
|
136
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
137
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
138
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
139
|
+
documentation gap only after a second method also fails.
|
|
140
|
+
|
|
123
141
|
Name the application the project asks for, and plan that application. Each documentation
|
|
124
142
|
page teaches through one worked example, and that example carries a domain of its own.
|
|
125
143
|
The domain belongs to the page. The project's purpose from the repository findings
|
|
@@ -135,11 +153,18 @@ Preserve each agent or frontend that already exists.
|
|
|
135
153
|
|
|
136
154
|
Plan the runtime to consume the Intelligence credential. The runtime takes an
|
|
137
155
|
`intelligence` option holding a client built from the project key. A runtime given a
|
|
138
|
-
`runner` option instead is the
|
|
139
|
-
|
|
156
|
+
`runner` option instead is the OSS runtime. It never reads the Intelligence key, and the
|
|
157
|
+
Inspector reads the project as locked. The default in-memory OSS runner is ephemeral.
|
|
158
|
+
SQLite, custom, or framework persistence can be durable. The two options cannot be
|
|
140
159
|
combined. Take the constructor from the connect-your-runtime page. Where a framework
|
|
141
160
|
quickstart shows a `runner` option instead, the connect-your-runtime page wins.
|
|
142
161
|
|
|
162
|
+
When the starting state is `both-oss`, use its recorded live baseline evidence. Preserve
|
|
163
|
+
the working agent, frontend, CopilotKit integration, and OSS behavior. Plan only the
|
|
164
|
+
project selection, Intelligence runtime configuration, and authenticated proof needed for
|
|
165
|
+
the conversion. Preserve the existing persistence and user-visible request. Do not
|
|
166
|
+
rebuild a path that already works.
|
|
167
|
+
|
|
143
168
|
Where the SDK requires an application-level value that the repository cannot supply, such
|
|
144
169
|
as an end-user identity for threads, use one clearly marked local placeholder and name what
|
|
145
170
|
production requires instead. Do not stop onboarding to ask the developer for it.
|
|
@@ -4,16 +4,29 @@ Use the repository findings to select the agent framework. Ask the developer onl
|
|
|
4
4
|
choices that the repository does not show. Do not change application code in this phase.
|
|
5
5
|
Do not read, show, store, or request a secret value.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
These are the agent frameworks and their default vendors:
|
|
8
8
|
|
|
9
|
-
| Framework | Default vendor
|
|
10
|
-
| ---------------------------------- |
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
9
|
+
| Framework | Default vendor |
|
|
10
|
+
| ---------------------------------- | --------------- |
|
|
11
|
+
| AG2 | OpenAI |
|
|
12
|
+
| ADK | Google |
|
|
13
|
+
| Agno | OpenAI |
|
|
14
|
+
| Built-in CopilotKit agent | OpenAI |
|
|
15
|
+
| Claude Agent SDK (Python) | Anthropic |
|
|
16
|
+
| Claude Agent SDK (TypeScript) | Anthropic |
|
|
17
|
+
| CrewAI Flows | Project-defined |
|
|
18
|
+
| Deep Agents | OpenAI |
|
|
19
|
+
| LangGraph FastAPI | OpenAI |
|
|
20
|
+
| LangGraph Python | OpenAI |
|
|
21
|
+
| LangGraph TypeScript | OpenAI |
|
|
22
|
+
| LlamaIndex | OpenAI |
|
|
23
|
+
| Mastra | OpenAI |
|
|
24
|
+
| Microsoft Agent Framework (.NET) | GitHub Models |
|
|
25
|
+
| Microsoft Agent Framework (Python) | OpenAI |
|
|
26
|
+
| MS Agent Harness (.NET) | GitHub Models |
|
|
27
|
+
| Pydantic AI | OpenAI |
|
|
28
|
+
| Strands Agents (Python) | OpenAI |
|
|
29
|
+
| Strands Agents (TypeScript) | OpenAI |
|
|
17
30
|
|
|
18
31
|
If the project already has an agent in a listed framework, preserve that framework and
|
|
19
32
|
its model setup. Ask only about choices that remain unknown.
|
|
@@ -21,18 +34,37 @@ its model setup. Ask only about choices that remain unknown.
|
|
|
21
34
|
If the project needs an agent, show the options and one recommendation based on repository
|
|
22
35
|
evidence. Match the language the repository already uses. Ask the developer to choose.
|
|
23
36
|
|
|
37
|
+
If the project is empty, state that no repository-based recommendation exists. Give these
|
|
38
|
+
documented defaults: LangGraph TypeScript, LangGraph Python, ADK, Microsoft Agent Framework
|
|
39
|
+
Python, Microsoft Agent Framework .NET, and Mastra. Explain which default matches the
|
|
40
|
+
developer's stated purpose. Show the other listed frameworks as options. Do not describe a
|
|
41
|
+
documented default as a repository-based recommendation.
|
|
42
|
+
|
|
24
43
|
Do not offer a framework that is not listed above. Do not port an existing agent to
|
|
25
44
|
another framework. Do not show the internal route.
|
|
26
45
|
|
|
27
46
|
Use exactly one matching internal route:
|
|
28
47
|
|
|
29
|
-
1.
|
|
30
|
-
2.
|
|
31
|
-
3.
|
|
32
|
-
4.
|
|
33
|
-
5.
|
|
34
|
-
6.
|
|
48
|
+
1. AG2: `npx --yes copilotkit@4.9.0 onboard read framework/ag2`
|
|
49
|
+
2. Agno: `npx --yes copilotkit@4.9.0 onboard read framework/agno`
|
|
50
|
+
3. Built-in CopilotKit agent: `npx --yes copilotkit@4.9.0 onboard read framework/built-in`
|
|
51
|
+
4. Claude Agent SDK Python: `npx --yes copilotkit@4.9.0 onboard read framework/claude-sdk-python`
|
|
52
|
+
5. Claude Agent SDK TypeScript: `npx --yes copilotkit@4.9.0 onboard read framework/claude-sdk-typescript`
|
|
53
|
+
6. CrewAI Flows: `npx --yes copilotkit@4.9.0 onboard read framework/crewai-flows`
|
|
54
|
+
7. Deep Agents: `npx --yes copilotkit@4.9.0 onboard read framework/deep-agents`
|
|
55
|
+
8. LangGraph Python: `npx --yes copilotkit@4.9.0 onboard read framework/langgraph-python`
|
|
56
|
+
9. LangGraph FastAPI: `npx --yes copilotkit@4.9.0 onboard read framework/langgraph-fastapi`
|
|
57
|
+
10. LangGraph TypeScript: `npx --yes copilotkit@4.9.0 onboard read framework/langgraph-typescript`
|
|
58
|
+
11. LlamaIndex: `npx --yes copilotkit@4.9.0 onboard read framework/llamaindex`
|
|
59
|
+
12. ADK: `npx --yes copilotkit@4.9.0 onboard read framework/google-adk`
|
|
60
|
+
13. Microsoft Agent Framework Python: `npx --yes copilotkit@4.9.0 onboard read framework/ms-agent-python`
|
|
61
|
+
14. Microsoft Agent Framework .NET: `npx --yes copilotkit@4.9.0 onboard read framework/ms-agent-dotnet`
|
|
62
|
+
15. Mastra: `npx --yes copilotkit@4.9.0 onboard read framework/mastra`
|
|
63
|
+
16. MS Agent Harness .NET: `npx --yes copilotkit@4.9.0 onboard read framework/ms-agent-harness-dotnet`
|
|
64
|
+
17. Pydantic AI: `npx --yes copilotkit@4.9.0 onboard read framework/pydantic-ai`
|
|
65
|
+
18. Strands Agents Python: `npx --yes copilotkit@4.9.0 onboard read framework/strands-python`
|
|
66
|
+
19. Strands Agents TypeScript: `npx --yes copilotkit@4.9.0 onboard read framework/strands-typescript`
|
|
35
67
|
|
|
36
68
|
If the project has an agent in another framework, or no listed framework fits, keep the
|
|
37
69
|
developer's current agent and run
|
|
38
|
-
`npx copilotkit@4.
|
|
70
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Build from the best available official documentation
|
|
2
|
+
|
|
3
|
+
Tell the implementation subagent which plan steps lack direct documentation. Give it the
|
|
4
|
+
approved plan, repository findings, and all official documentation that you found.
|
|
5
|
+
|
|
6
|
+
Tell the subagent to preserve the existing project. It must not invent a CopilotKit API.
|
|
7
|
+
It can combine compatible APIs from different official pages when one page omits the
|
|
8
|
+
selected framework and frontend combination.
|
|
9
|
+
|
|
10
|
+
Run the approved implementation and validation steps. Repair a failure in new work at most
|
|
11
|
+
three times. Stop if the fix requires changes to the developer's existing agent or
|
|
12
|
+
frontend.
|
|
13
|
+
|
|
14
|
+
After validation passes, prove the runtime, agent round trip, and real frontend path. Use
|
|
15
|
+
the same proof rules from the approved plan. Keep the development servers running after
|
|
16
|
+
proof.
|
|
17
|
+
|
|
18
|
+
Do not block core proof on CopilotKit Skills or MCP configuration. Try these tools after
|
|
19
|
+
the application passes proof. Report each tool result separately.
|
|
20
|
+
|
|
21
|
+
Report the documentation gap and each assumption with the proof evidence. Do not claim
|
|
22
|
+
that the selected documentation proved an inferred step.
|
|
23
|
+
|
|
24
|
+
When the proof is complete, run `npx --yes copilotkit@4.9.0 onboard complete`, carrying the
|
|
25
|
+
visual-check result:
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
npx --yes copilotkit@4.9.0 onboard complete --visual-check <outcome>
|
|
29
|
+
```
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Configure AG2
|
|
2
|
+
|
|
3
|
+
Preserve an existing AG2 model setup. Start with OpenAI for a new agent. Offer another
|
|
4
|
+
vendor only after an exact CopilotKit Markdown page names it. The page must name its
|
|
5
|
+
credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/ag2/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/ag2/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/ag2/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/ag2/readables.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `ag2`. Use only the Python examples from these pages.
|
|
22
|
+
Preserve the existing `AGUIStream` endpoint and its route. The quickstart uses a sample
|
|
23
|
+
repository with `uv sync`. It does not name a dependency list for an existing project.
|
|
24
|
+
Do not replace the project's dependency manifest with a guessed list, and do not change
|
|
25
|
+
an existing endpoint to the quickstart's `/weather` sample route.
|
|
26
|
+
|
|
27
|
+
The fixed-schema page has no AG2 backend schema-loading, render-operations, or runtime
|
|
28
|
+
setup snippet. Do not invent a fixed-schema A2UI backend setup. If the requested work
|
|
29
|
+
needs that missing setup, run the unsupported route below.
|
|
30
|
+
|
|
31
|
+
The Readables page includes the AG2 backend context path. Use its `ContextVariables` and
|
|
32
|
+
`AGUIStream` examples when the project needs frontend context. Do not substitute another
|
|
33
|
+
framework's context setup.
|
|
34
|
+
|
|
35
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
36
|
+
URLs, and the fixed-schema documentation gap. Do not use remembered CopilotKit
|
|
37
|
+
instructions.
|
|
38
|
+
|
|
39
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
40
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
41
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
42
|
+
unavailable only after a second method also fails.
|
|
43
|
+
|
|
44
|
+
If the pages support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
46
|
+
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Configure Agno
|
|
2
|
+
|
|
3
|
+
Preserve an existing Agno model setup. Start with OpenAI for a new agent. Offer another
|
|
4
|
+
vendor only after an exact CopilotKit Markdown page names it. The page must name its
|
|
5
|
+
credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/agno/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/agno/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/agno/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/agno/shared-state/agent-readonly.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `agno`. Use only the Python agent examples from these pages.
|
|
22
|
+
When the repository already has an Agno agent, use the quickstart's
|
|
23
|
+
`Use an existing agent` path. Use `Start from scratch` only when the repository needs a
|
|
24
|
+
new agent. For a new agent, install the documented Python dependencies
|
|
25
|
+
`agno fastapi uvicorn openai ag-ui-protocol`. Preserve an existing `AgentOS` with the
|
|
26
|
+
`AGUI` interface and its endpoint. In the documented runtime, `AgnoAgent` from
|
|
27
|
+
`@ag-ui/agno` targets `/agui`. Do not replace that adapter with a generic agent or change
|
|
28
|
+
the endpoint without repository evidence.
|
|
29
|
+
|
|
30
|
+
The fixed-schema page has no Agno backend schema-loading, render-operations, or runtime
|
|
31
|
+
setup snippet. The agent-readonly page does not bundle its Agno backend context setup.
|
|
32
|
+
Do not invent either missing backend setup. If the requested work needs one of those
|
|
33
|
+
setups and the project does not already have it, run the unsupported route below.
|
|
34
|
+
|
|
35
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
36
|
+
URLs, the documented dependencies and adapter, and both documentation gaps. Do not use
|
|
37
|
+
remembered CopilotKit instructions.
|
|
38
|
+
|
|
39
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
40
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
41
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
42
|
+
unavailable only after a second method also fails.
|
|
43
|
+
|
|
44
|
+
If the pages support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
46
|
+
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Configure the built-in CopilotKit agent
|
|
2
|
+
|
|
3
|
+
Preserve an existing built-in agent model setup. Start with OpenAI for a new agent. Offer
|
|
4
|
+
another vendor only after an exact CopilotKit Markdown page names it. The page must name
|
|
5
|
+
its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
The built-in agent runs in the CopilotKit Runtime process.
|
|
13
|
+
Do not create or start a separate agent server.
|
|
14
|
+
Keep the agent, model choice, tools, and runtime endpoint in the project's existing
|
|
15
|
+
runtime setup.
|
|
16
|
+
|
|
17
|
+
## Documentation
|
|
18
|
+
|
|
19
|
+
- https://docs.copilotkit.ai/built-in-agent.md
|
|
20
|
+
- https://docs.copilotkit.ai/quickstart.md
|
|
21
|
+
- https://docs.copilotkit.ai/inspector.md
|
|
22
|
+
- https://docs.copilotkit.ai/agent-app-context.md
|
|
23
|
+
- https://docs.copilotkit.ai/model-selection.md
|
|
24
|
+
- https://docs.copilotkit.ai/generative-ui/tool-based.md
|
|
25
|
+
|
|
26
|
+
Fetch all six pages in one step rather than one after another.
|
|
27
|
+
|
|
28
|
+
These pages use the root documentation scope. Do not add a framework path segment to
|
|
29
|
+
their URLs. Use the tool-based generative UI page for this built-in route.
|
|
30
|
+
|
|
31
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
32
|
+
these URLs. Do not use remembered CopilotKit instructions.
|
|
33
|
+
|
|
34
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
35
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
36
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
37
|
+
unavailable only after a second method also fails.
|
|
38
|
+
|
|
39
|
+
If the pages support the selection, run
|
|
40
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
41
|
+
|
|
42
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
43
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Configure Claude Agent SDK for Python
|
|
2
|
+
|
|
3
|
+
Preserve an existing Claude Agent SDK model setup. Start with Anthropic for a new agent.
|
|
4
|
+
Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
|
|
5
|
+
name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
|
|
8
|
+
`ANTHROPIC_MODEL`.
|
|
9
|
+
|
|
10
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
11
|
+
store, or request a secret value.
|
|
12
|
+
|
|
13
|
+
## Documentation
|
|
14
|
+
|
|
15
|
+
- https://docs.copilotkit.ai/claude-sdk-python/quickstart.md
|
|
16
|
+
- https://docs.copilotkit.ai/claude-sdk-python/inspector.md
|
|
17
|
+
- https://docs.copilotkit.ai/claude-sdk-python/generative-ui/a2ui/fixed-schema.md
|
|
18
|
+
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
19
|
+
|
|
20
|
+
Fetch all four pages in one step rather than one after another.
|
|
21
|
+
|
|
22
|
+
The documentation scope is `claude-sdk-python`. For an existing agent, install the exact
|
|
23
|
+
documented backend set with
|
|
24
|
+
`uv add claude-agent-sdk ag-ui-claude-sdk ag-ui-protocol anthropic fastapi uvicorn python-dotenv`.
|
|
25
|
+
Expose the agent through FastAPI and use `ClaudeAgentAdapter` from `ag_ui_claude_sdk`.
|
|
26
|
+
Keep one long-lived adapter at module scope. Register the remote endpoint in Copilot Runtime
|
|
27
|
+
with `HttpAgent`. Do not replace this transport with a different Claude or AG-UI adapter.
|
|
28
|
+
|
|
29
|
+
For fixed-schema A2UI, keep the tool in the agent. Set `injectA2UITool` to `false` in the
|
|
30
|
+
runtime. The documented Python setup does not support `action_handlers` on
|
|
31
|
+
`a2ui.render`. Do not add them or claim that the fixed-schema button callback works.
|
|
32
|
+
|
|
33
|
+
No Claude Agent SDK Python agent-app-context Markdown page is available. The reference
|
|
34
|
+
page above documents the frontend hook only. Do not invent the missing agent-side context
|
|
35
|
+
setup. If the requested work needs that setup, run the unsupported route below.
|
|
36
|
+
|
|
37
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
38
|
+
URLs, and the context and A2UI limits. Do not use remembered CopilotKit instructions.
|
|
39
|
+
|
|
40
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
41
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
42
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
43
|
+
unavailable only after a second method also fails.
|
|
44
|
+
|
|
45
|
+
If the pages support the selection, run
|
|
46
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
47
|
+
|
|
48
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
49
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Configure Claude Agent SDK for TypeScript
|
|
2
|
+
|
|
3
|
+
Preserve an existing Claude Agent SDK model setup. Start with Anthropic for a new agent.
|
|
4
|
+
Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
|
|
5
|
+
name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
|
|
8
|
+
`CLAUDE_MODEL`.
|
|
9
|
+
|
|
10
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
11
|
+
store, or request a secret value.
|
|
12
|
+
|
|
13
|
+
## Documentation
|
|
14
|
+
|
|
15
|
+
- https://docs.copilotkit.ai/claude-sdk-typescript/quickstart.md
|
|
16
|
+
- https://docs.copilotkit.ai/claude-sdk-typescript/inspector.md
|
|
17
|
+
- https://docs.copilotkit.ai/claude-sdk-typescript/generative-ui/a2ui/fixed-schema.md
|
|
18
|
+
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
19
|
+
|
|
20
|
+
Fetch all four pages in one step rather than one after another.
|
|
21
|
+
|
|
22
|
+
The documentation scope is `claude-sdk-typescript`. For an existing agent, install the
|
|
23
|
+
documented packages, including `@anthropic-ai/claude-agent-sdk@^0.2.58`,
|
|
24
|
+
`@anthropic-ai/sdk`, `@ag-ui/claude-agent-sdk`, `@ag-ui/core`, `@ag-ui/encoder`,
|
|
25
|
+
`express`, `dotenv`, and `zod`. Keep the Express AG-UI endpoint. Use
|
|
26
|
+
`ClaudeAgentAdapter` from `@ag-ui/claude-agent-sdk` in that endpoint and `HttpAgent` in
|
|
27
|
+
Copilot Runtime. Do not replace either adapter.
|
|
28
|
+
|
|
29
|
+
For fixed-schema A2UI, expose the backend tool through the in-process Claude SDK MCP
|
|
30
|
+
server. Set `injectA2UITool` to `false` so the agent-owned tool is the only A2UI tool.
|
|
31
|
+
The Claude Agent SDK adapter does not bridge CopilotKit frontend or runtime tools through
|
|
32
|
+
AG-UI. If the requested path needs those tools, run the unsupported route below. Do not
|
|
33
|
+
replace the Claude Agent SDK with the direct Anthropic Messages API fallback.
|
|
34
|
+
|
|
35
|
+
The adapter appends AG-UI `input.context` entries to the Claude system prompt. Pair that
|
|
36
|
+
backend path with the frontend hook from the reference page. Treat this as read-only app
|
|
37
|
+
context. It does not provide an agent-to-frontend write-back path. Inspect the installed,
|
|
38
|
+
pinned adapter source before using this path. If the package no longer handles
|
|
39
|
+
`input.context`, run the unsupported route below.
|
|
40
|
+
|
|
41
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
42
|
+
URLs, and the adapter and context limits. Do not use remembered CopilotKit instructions.
|
|
43
|
+
|
|
44
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
45
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
46
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
47
|
+
unavailable only after a second method also fails.
|
|
48
|
+
|
|
49
|
+
If the pages support the selection, run
|
|
50
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
51
|
+
|
|
52
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
53
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Configure CrewAI Flows
|
|
2
|
+
|
|
3
|
+
Preserve the project's existing CrewAI Flow, model, and deployment. The selected pages do
|
|
4
|
+
not name a default model vendor or model credential variable. Do not choose a vendor or
|
|
5
|
+
credential name for the developer. Ask only for a choice that the repository does not
|
|
6
|
+
show and the documentation supports.
|
|
7
|
+
|
|
8
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
9
|
+
store, or request a secret value.
|
|
10
|
+
|
|
11
|
+
## Documentation
|
|
12
|
+
|
|
13
|
+
- https://docs.copilotkit.ai/crewai-crews/quickstart.md
|
|
14
|
+
- https://docs.copilotkit.ai/crewai-crews/inspector.md
|
|
15
|
+
- https://docs.copilotkit.ai/crewai-crews/generative-ui/a2ui/fixed-schema.md
|
|
16
|
+
- https://docs.copilotkit.ai/crewai-crews/shared-state/in-app-agent-read.md
|
|
17
|
+
|
|
18
|
+
Fetch all four pages in one step rather than one after another.
|
|
19
|
+
|
|
20
|
+
The public onboarding route ID is `crewai-flows`. The canonical documentation scope is
|
|
21
|
+
`crewai-crews`. The quickstart and feature pages also contain older `/crewai-flows/`
|
|
22
|
+
links. Use the canonical Markdown URLs above and keep the project's CrewAI Flow name.
|
|
23
|
+
|
|
24
|
+
The quickstart offers `Use the CopilotKit CLI (NextJS only)` and `Code along`. It assumes
|
|
25
|
+
an existing Flow. Preserve the vendor, model, and credential variable that the project
|
|
26
|
+
already uses. The new quickstart example uses GitHub Models. An existing OpenAI Flow can
|
|
27
|
+
keep OpenAI and `OPENAI_API_KEY`. Do not change vendors to match the example.
|
|
28
|
+
|
|
29
|
+
The current Python base adapter is `ag-ui-crewai==0.3.0`. Add the endpoint to the
|
|
30
|
+
project's FastAPI app with
|
|
31
|
+
`add_crewai_flow_fastapi_endpoint(app, ExistingFlow(), "/chat")`. Keep the existing Flow
|
|
32
|
+
and its regular, non-conversational mode. Use the generic `HttpAgent` for the `/chat`
|
|
33
|
+
endpoint. Do not invent a `CrewAIAgent` runtime class.
|
|
34
|
+
|
|
35
|
+
The fixed-schema page extends this base adapter. Keep the fixed-schema tool on the CrewAI
|
|
36
|
+
Flow path, call `copilotkit_emit_tool_result`, and set `injectA2UITool: false` in the
|
|
37
|
+
runtime catalog. Do not replace the existing Flow with a Crew, Agent, or Task graph.
|
|
38
|
+
|
|
39
|
+
The shared-state page is not an agent-app-context guide. Do not use it to invent a
|
|
40
|
+
`useAgentContext` backend setup. If the requested work needs app context rather than the
|
|
41
|
+
documented shared-state path, run the unsupported route below.
|
|
42
|
+
|
|
43
|
+
Record the selected framework, project-defined vendor and model, repository-proven
|
|
44
|
+
credential variable names, these URLs, the adapter, and both documentation limits. Do not
|
|
45
|
+
use remembered CopilotKit instructions.
|
|
46
|
+
|
|
47
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
48
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
49
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
50
|
+
unavailable only after a second method also fails.
|
|
51
|
+
|
|
52
|
+
If the pages support the selection, run
|
|
53
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
54
|
+
|
|
55
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
56
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Configure Deep Agents
|
|
2
|
+
|
|
3
|
+
Preserve an existing Deep Agents language and model setup. Start with OpenAI for a new
|
|
4
|
+
agent. Offer another vendor only after an exact CopilotKit Markdown page names it. The
|
|
5
|
+
page must name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/deepagents/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/deepagents/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/deepagents/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/deepagents/shared-state/agent-readonly.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `deepagents`. Do not use `deep-agents` in a documentation URL.
|
|
22
|
+
The quickstart has Python and TypeScript tabs. Preserve the project's current language.
|
|
23
|
+
Preserve the project's existing deployment path. Choose the same `Deep Agent` or
|
|
24
|
+
`FastAPI` tab in both the quickstart and runtime setup. Do not change a Deep Agent
|
|
25
|
+
deployment to FastAPI or a FastAPI deployment to Deep Agent.
|
|
26
|
+
|
|
27
|
+
The fixed-schema A2UI backend example is Python-only. No Deep Agents agent-app-context
|
|
28
|
+
Markdown page is available. Do not invent a TypeScript A2UI backend or an
|
|
29
|
+
agent-app-context setup. If the requested work needs either missing setup, run the
|
|
30
|
+
unsupported route below.
|
|
31
|
+
|
|
32
|
+
Record the selected framework, language, vendor, model, required credential variable
|
|
33
|
+
names, these URLs, and each documentation gap. Do not use remembered CopilotKit
|
|
34
|
+
instructions.
|
|
35
|
+
|
|
36
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
37
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
38
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
39
|
+
unavailable only after a second method also fails.
|
|
40
|
+
|
|
41
|
+
If the pages support the selection, run
|
|
42
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
43
|
+
|
|
44
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -34,8 +34,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
these URLs.
|
|
35
35
|
Do not use remembered CopilotKit instructions.
|
|
36
36
|
|
|
37
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
38
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
39
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
40
|
+
unavailable only after a second method also fails.
|
|
41
|
+
|
|
37
42
|
If the pages support the selection, run
|
|
38
|
-
`npx copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
39
44
|
|
|
40
|
-
If a page does not
|
|
41
|
-
`npx copilotkit@4.
|
|
45
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
46
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Configure LangGraph FastAPI
|
|
2
|
+
|
|
3
|
+
Preserve an existing LangGraph FastAPI model setup. Start with OpenAI for a new agent.
|
|
4
|
+
Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
|
|
5
|
+
name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
8
|
+
store, or request a secret value.
|
|
9
|
+
|
|
10
|
+
## Documentation
|
|
11
|
+
|
|
12
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/quickstart.md
|
|
13
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/inspector.md
|
|
14
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/generative-ui/a2ui/fixed-schema.md
|
|
15
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/agent-app-context.md
|
|
16
|
+
|
|
17
|
+
Fetch all four pages in one step rather than one after another. Sequential fetching
|
|
18
|
+
cost about nine minutes of the first proven journey.
|
|
19
|
+
|
|
20
|
+
Read the FastAPI tab of the quickstart.
|
|
21
|
+
Preserve an existing FastAPI transport and its persistence.
|
|
22
|
+
The FastAPI graph must have a checkpointer.
|
|
23
|
+
Keep the existing checkpointer. For a new local agent, use `MemorySaver` only for
|
|
24
|
+
development.
|
|
25
|
+
Use `add_langgraph_fastapi_endpoint` for the FastAPI agent endpoint.
|
|
26
|
+
Use `LangGraphHttpAgent` in the Copilot Runtime.
|
|
27
|
+
Do not copy the LangSmith path, its no-checkpointer rule, or its `LangGraphAgent` adapter.
|
|
28
|
+
|
|
29
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
30
|
+
these URLs.
|
|
31
|
+
Do not use remembered CopilotKit instructions.
|
|
32
|
+
|
|
33
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
34
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
35
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
36
|
+
unavailable only after a second method also fails.
|
|
37
|
+
|
|
38
|
+
If the pages support the selection, run
|
|
39
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
40
|
+
|
|
41
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
42
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -21,8 +21,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
21
21
|
these URLs.
|
|
22
22
|
Do not use remembered CopilotKit instructions.
|
|
23
23
|
|
|
24
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
25
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
26
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
27
|
+
unavailable only after a second method also fails.
|
|
28
|
+
|
|
24
29
|
If the pages support the selection, run
|
|
25
|
-
`npx copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
26
31
|
|
|
27
|
-
If a page does not
|
|
28
|
-
`npx copilotkit@4.
|
|
32
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
33
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|