copilotkit 4.9.4 → 4.9.17

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.
Files changed (47) hide show
  1. package/README.md +13 -12
  2. package/cli-build-info.json +8 -8
  3. package/index.js +1752 -672
  4. package/onboarding/index.json +15 -1
  5. package/onboarding/prompts/authenticate/start.md +129 -65
  6. package/onboarding/prompts/conversion/plan.md +103 -0
  7. package/onboarding/prompts/credentials/finalize-plan.md +97 -122
  8. package/onboarding/prompts/credentials/plan.md +26 -21
  9. package/onboarding/prompts/fallback/best-effort.md +99 -19
  10. package/onboarding/prompts/framework/ag2.md +7 -7
  11. package/onboarding/prompts/framework/agno.md +11 -8
  12. package/onboarding/prompts/framework/built-in.md +2 -2
  13. package/onboarding/prompts/framework/claude-sdk-python.md +7 -7
  14. package/onboarding/prompts/framework/claude-sdk-typescript.md +9 -9
  15. package/onboarding/prompts/framework/crewai-flows.md +27 -11
  16. package/onboarding/prompts/framework/deep-agents.md +8 -7
  17. package/onboarding/prompts/framework/google-adk.md +3 -3
  18. package/onboarding/prompts/framework/langgraph-fastapi.md +3 -3
  19. package/onboarding/prompts/framework/langgraph-python.md +3 -3
  20. package/onboarding/prompts/framework/langgraph-typescript.md +3 -3
  21. package/onboarding/prompts/framework/llamaindex.md +6 -6
  22. package/onboarding/prompts/framework/mastra.md +3 -3
  23. package/onboarding/prompts/framework/ms-agent-dotnet.md +3 -3
  24. package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +7 -9
  25. package/onboarding/prompts/framework/ms-agent-python.md +3 -3
  26. package/onboarding/prompts/framework/pydantic-ai.md +26 -15
  27. package/onboarding/prompts/framework/strands-python.md +7 -6
  28. package/onboarding/prompts/framework/strands-typescript.md +9 -7
  29. package/onboarding/prompts/frontend/angular.md +16 -3
  30. package/onboarding/prompts/frontend/nextjs.md +3 -3
  31. package/onboarding/prompts/frontend/plan.md +6 -6
  32. package/onboarding/prompts/frontend/react-native.md +7 -2
  33. package/onboarding/prompts/frontend/react-spa.md +2 -2
  34. package/onboarding/prompts/frontend/vue.md +7 -2
  35. package/onboarding/prompts/implementation/build-and-validate.md +45 -79
  36. package/onboarding/prompts/proof/complete.md +8 -6
  37. package/onboarding/prompts/proof/oss-baseline.md +15 -50
  38. package/onboarding/prompts/proof/round-trip.md +83 -263
  39. package/onboarding/prompts/starter/clone.md +4 -4
  40. package/onboarding/prompts/subagent/create-plan.md +45 -0
  41. package/onboarding/prompts/subagent/implement-and-validate.md +70 -44
  42. package/onboarding/prompts/subagent/inspect-repository.md +25 -3
  43. package/onboarding/prompts/subagent/prove-oss-baseline.md +2 -1
  44. package/onboarding/prompts/subagent/prove-round-trip.md +143 -34
  45. package/onboarding/prompts/unsupported/no-validated-path.md +10 -2
  46. package/package.json +1 -1
  47. package/release/release-tool.js +1 -1
@@ -11,7 +11,7 @@ Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
11
11
 
12
12
  - https://docs.copilotkit.ai/claude-sdk-typescript/quickstart.md
13
13
  - https://docs.copilotkit.ai/claude-sdk-typescript/inspector.md
14
- - https://docs.copilotkit.ai/claude-sdk-typescript/generative-ui/a2ui/fixed-schema.md
14
+ - https://docs.copilotkit.ai/claude-sdk-typescript/generative-ui/tool-based.md
15
15
  - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
16
16
 
17
17
  The documentation scope is `claude-sdk-typescript`. For an existing agent, install the
@@ -21,11 +21,11 @@ documented packages, including `@anthropic-ai/claude-agent-sdk@^0.2.58`,
21
21
  `ClaudeAgentAdapter` from `@ag-ui/claude-agent-sdk` in that endpoint and `HttpAgent` in
22
22
  Copilot Runtime. Do not replace either adapter.
23
23
 
24
- For fixed-schema A2UI, expose the backend tool through the in-process Claude SDK MCP
25
- server. Set `injectA2UITool` to `false` so the agent-owned tool is the only A2UI tool.
26
- The Claude Agent SDK adapter does not bridge CopilotKit frontend or runtime tools through
27
- AG-UI. If the requested path needs those tools, run the unsupported route below. Do not
28
- replace the Claude Agent SDK with the direct Anthropic Messages API fallback.
24
+ The adapter bridges CopilotKit frontend tools: it converts the run's tool list into an
25
+ in-process MCP server and halts its own stream on a frontend tool call so the browser
26
+ renders it. A component registered on the frontend therefore needs nothing added to this
27
+ agent. Do not replace the Claude Agent SDK with the direct Anthropic Messages API
28
+ fallback.
29
29
 
30
30
  The adapter appends AG-UI `input.context` entries to the Claude system prompt. Pair that
31
31
  backend path with the frontend hook from the reference page. Treat this as read-only app
@@ -34,10 +34,10 @@ pinned adapter source before using this path. If the package no longer handles
34
34
  `input.context`, run the unsupported route below.
35
35
 
36
36
  Record the selected framework, vendor, model, required credential variable names, these
37
- URLs, and the adapter and context limits.
37
+ URLs, and the context limit.
38
38
 
39
39
  If the pages support the selection, run
40
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
40
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
41
41
 
42
42
  If the documentation does not support the selection, run
43
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
43
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -1,15 +1,28 @@
1
1
  # Configure CrewAI Flows
2
2
 
3
3
  Preserve the project's existing CrewAI Flow, provider, model, and deployment. The selected
4
- pages do not name a default model vendor or model credential variable. If neither the
5
- repository nor these pages prove a provider, run the unsupported route below. Do not
6
- choose a vendor or credential name for the developer.
4
+ pages do not name a default model vendor or model credential variable. Do not choose a
5
+ vendor or credential name for the developer.
6
+
7
+ When the repository shows a provider, keep it and ask nothing further about it. When
8
+ neither the repository nor these pages show one, the developer decides, so ask. Ask one
9
+ short question: which model vendor the CrewAI Flow will call. Say that the CopilotKit
10
+ CrewAI pages name no vendor, so this release makes no recommendation here and will not
11
+ pick one. If the developer names a vendor and no variable name, propose the variable name
12
+ that vendor's own client reads and ask them to confirm it. A proposal the developer
13
+ confirms is theirs. Ask for a variable name, never the value it holds. Do not combine this
14
+ with a frontend, project, or plan-approval question. Record the answer as the
15
+ project-defined provider, model, and credential variable name, and continue.
16
+
17
+ A vendor nobody has chosen yet is not a missing supported path. This release supports
18
+ CrewAI Flows. Do not run the unsupported route below because the project defines no
19
+ vendor. That route is for a documentation page that does not support the selection.
7
20
 
8
21
  ## Documentation
9
22
 
10
23
  - https://docs.copilotkit.ai/crewai-crews/quickstart.md
11
24
  - https://docs.copilotkit.ai/crewai-crews/inspector.md
12
- - https://docs.copilotkit.ai/crewai-crews/generative-ui/a2ui/fixed-schema.md
25
+ - https://docs.copilotkit.ai/crewai-crews/generative-ui/tool-based.md
13
26
  - https://docs.copilotkit.ai/crewai-crews/shared-state/in-app-agent-read.md
14
27
 
15
28
  The public onboarding route ID is `crewai-flows`. The canonical documentation scope is
@@ -26,19 +39,22 @@ project's FastAPI app with
26
39
  and its regular, non-conversational mode. Use the generic `HttpAgent` for the `/chat`
27
40
  endpoint. Do not invent a `CrewAIAgent` runtime class.
28
41
 
29
- The fixed-schema page extends this base adapter. Keep the fixed-schema tool on the CrewAI
30
- Flow path, call `copilotkit_emit_tool_result`, and set `injectA2UITool: false` in the
31
- runtime catalog. Do not replace the existing Flow with a Crew, Agent, or Task graph.
42
+ Do not replace the existing Flow with a Crew, Agent, or Task graph.
43
+
44
+ A2UI is not on this path. If the developer asks for it, say first that its page extends
45
+ this base adapter rather than standing alone, so it needs the Flow to call
46
+ `copilotkit_emit_tool_result` itself.
32
47
 
33
48
  The shared-state page is not an agent-app-context guide. Do not use it to invent a
34
49
  `useAgentContext` backend setup. If the requested work needs app context rather than the
35
50
  documented shared-state path, run the unsupported route below.
36
51
 
37
- Record the selected framework, project-defined provider and model, repository-proven
38
- credential variable names, these URLs, the adapter, and both documentation limits.
52
+ Record the selected framework, project-defined provider and model, the credential
53
+ variable names the repository proves or the developer named, these URLs, the adapter, and the
54
+ shared-state limit.
39
55
 
40
56
  If the pages support the selection, run
41
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
57
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
42
58
 
43
59
  If the documentation does not support the selection, run
44
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
60
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -10,7 +10,7 @@ Name the default model credential `OPENAI_API_KEY`.
10
10
 
11
11
  - https://docs.copilotkit.ai/deepagents/quickstart.md
12
12
  - https://docs.copilotkit.ai/deepagents/inspector.md
13
- - https://docs.copilotkit.ai/deepagents/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/deepagents/generative-ui/tool-based.md
14
14
  - https://docs.copilotkit.ai/deepagents/shared-state/agent-readonly.md
15
15
 
16
16
  The documentation scope is `deepagents`. Do not use `deep-agents` in a documentation URL.
@@ -19,16 +19,17 @@ Preserve the project's existing deployment path. Choose the same `Deep Agent` or
19
19
  `FastAPI` tab in both the quickstart and runtime setup. Do not change a Deep Agent
20
20
  deployment to FastAPI or a FastAPI deployment to Deep Agent.
21
21
 
22
- The fixed-schema A2UI backend example is Python-only. No Deep Agents agent-app-context
23
- Markdown page is available. Do not invent a TypeScript A2UI backend or an
24
- agent-app-context setup. If the requested work needs either missing setup, run the
25
- unsupported route below.
22
+ No Deep Agents agent-app-context Markdown page is available. Do not invent an
23
+ agent-app-context setup. If the requested work needs it, run the unsupported route below.
24
+
25
+ A2UI is not on this path. If the developer asks for it, say first that its backend example
26
+ is Python-only, so a TypeScript project has nothing to follow.
26
27
 
27
28
  Record the selected framework, language, vendor, model, required credential variable
28
29
  names, these URLs, and each documentation gap.
29
30
 
30
31
  If the pages support the selection, run
31
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
32
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
32
33
 
33
34
  If the documentation does not support the selection, run
34
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
35
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -12,7 +12,7 @@ key.
12
12
 
13
13
  - https://docs.copilotkit.ai/google-adk/quickstart.md
14
14
  - https://docs.copilotkit.ai/google-adk/inspector.md
15
- - https://docs.copilotkit.ai/google-adk/generative-ui/a2ui/fixed-schema.md
15
+ - https://docs.copilotkit.ai/google-adk/generative-ui/tool-based.md
16
16
  - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
17
17
 
18
18
  The documentation scope is `google-adk`. A `/adk/` URL answers with a redirect stub
@@ -28,7 +28,7 @@ Record the selected framework, vendor, model, required credential variable names
28
28
  these URLs.
29
29
 
30
30
  If the pages support the selection, run
31
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
31
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
32
32
 
33
33
  If the documentation does not support the selection, run
34
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -8,7 +8,7 @@ name its credential variables and setup steps.
8
8
 
9
9
  - https://docs.copilotkit.ai/langgraph-fastapi/quickstart.md
10
10
  - https://docs.copilotkit.ai/langgraph-fastapi/inspector.md
11
- - https://docs.copilotkit.ai/langgraph-fastapi/generative-ui/a2ui/fixed-schema.md
11
+ - https://docs.copilotkit.ai/langgraph-fastapi/generative-ui/tool-based.md
12
12
  - https://docs.copilotkit.ai/langgraph-fastapi/agent-app-context.md
13
13
 
14
14
  Read the FastAPI tab of the quickstart.
@@ -24,7 +24,7 @@ Record the selected framework, vendor, model, required credential variable names
24
24
  these URLs.
25
25
 
26
26
  If the pages support the selection, run
27
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
27
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
28
28
 
29
29
  If the documentation does not support the selection, run
30
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
30
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -8,14 +8,14 @@ name its credential variables and setup steps.
8
8
 
9
9
  - https://docs.copilotkit.ai/langgraph-python/quickstart.md
10
10
  - https://docs.copilotkit.ai/langgraph-python/inspector.md
11
- - https://docs.copilotkit.ai/langgraph-python/generative-ui/a2ui/fixed-schema.md
11
+ - https://docs.copilotkit.ai/langgraph-python/generative-ui/tool-based.md
12
12
  - https://docs.copilotkit.ai/langgraph-python/agent-app-context.md
13
13
 
14
14
  Record the selected framework, vendor, model, required credential variable names, and
15
15
  these URLs.
16
16
 
17
17
  If the pages support the selection, run
18
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
18
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
19
19
 
20
20
  If the documentation does not support the selection, run
21
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
21
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -8,14 +8,14 @@ name its credential variables and setup steps.
8
8
 
9
9
  - https://docs.copilotkit.ai/langgraph-typescript/quickstart.md
10
10
  - https://docs.copilotkit.ai/langgraph-typescript/inspector.md
11
- - https://docs.copilotkit.ai/langgraph-typescript/generative-ui/a2ui/fixed-schema.md
11
+ - https://docs.copilotkit.ai/langgraph-typescript/generative-ui/tool-based.md
12
12
  - https://docs.copilotkit.ai/langgraph-typescript/agent-app-context.md
13
13
 
14
14
  Record the selected framework, vendor, model, required credential variable names, and
15
15
  these URLs.
16
16
 
17
17
  If the pages support the selection, run
18
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
18
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
19
19
 
20
20
  If the documentation does not support the selection, run
21
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
21
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -10,7 +10,7 @@ Name the default model credential `OPENAI_API_KEY`.
10
10
 
11
11
  - https://docs.copilotkit.ai/llamaindex/quickstart.md
12
12
  - https://docs.copilotkit.ai/llamaindex/inspector.md
13
- - https://docs.copilotkit.ai/llamaindex/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/llamaindex/generative-ui/tool-based.md
14
14
  - https://docs.copilotkit.ai/llamaindex/shared-state/in-app-agent-read.md
15
15
 
16
16
  The documentation scope is `llamaindex`. Use only the Python agent examples from these
@@ -22,9 +22,9 @@ Preserve the existing `get_ag_ui_workflow_router` and its FastAPI router. In the
22
22
  documented runtime, `LlamaIndexAgent` from `@ag-ui/llamaindex` targets `/run`. Do not
23
23
  replace that adapter or change its route without repository evidence.
24
24
 
25
- The fixed-schema page includes LlamaIndex backend code but does not bundle its runtime
26
- setup. Use it only when the project already has the working quickstart runtime that the
27
- page extends. Do not invent a replacement runtime setup.
25
+ A2UI is not on this path. If the developer asks for it, say first that its page includes
26
+ LlamaIndex backend code but does not bundle its runtime setup, so it only works on top of
27
+ the quickstart runtime it extends.
28
28
 
29
29
  The shared-state page is not an agent-app-context guide. Do not use it to invent a
30
30
  `useAgentContext` backend setup. If the requested work needs app context rather than the
@@ -34,7 +34,7 @@ Record the selected framework, vendor, model, required credential variable names
34
34
  URLs, the documented dependencies and adapter, and both documentation limits.
35
35
 
36
36
  If the pages support the selection, run
37
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
37
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
38
38
 
39
39
  If the documentation does not support the selection, run
40
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
40
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -38,14 +38,14 @@ what the developer had.
38
38
 
39
39
  - https://docs.copilotkit.ai/mastra/quickstart.md
40
40
  - https://docs.copilotkit.ai/mastra/inspector.md
41
- - https://docs.copilotkit.ai/mastra/generative-ui/a2ui/fixed-schema.md
41
+ - https://docs.copilotkit.ai/mastra/generative-ui/tool-based.md
42
42
  - https://docs.copilotkit.ai/mastra/agent-app-context.md
43
43
 
44
44
  Record the selected framework, vendor, model, required credential variable names, and
45
45
  these URLs.
46
46
 
47
47
  If the pages support the selection, run
48
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
48
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
49
49
 
50
50
  If the documentation does not support the selection, run
51
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
51
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -17,7 +17,7 @@ Run `dotnet --version` before you change the project.
17
17
 
18
18
  - https://docs.copilotkit.ai/ms-agent-dotnet/quickstart.md
19
19
  - https://docs.copilotkit.ai/ms-agent-dotnet/inspector.md
20
- - https://docs.copilotkit.ai/ms-agent-dotnet/generative-ui/a2ui/fixed-schema.md
20
+ - https://docs.copilotkit.ai/ms-agent-dotnet/generative-ui/tool-based.md
21
21
  - https://docs.copilotkit.ai/ms-agent-dotnet/agent-app-context.md
22
22
  - https://learn.microsoft.com/en-us/agent-framework/integrations/by-component/ui/ag-ui/getting-started
23
23
 
@@ -34,7 +34,7 @@ Record the selected framework, provider, model, required credential variable nam
34
34
  these URLs.
35
35
 
36
36
  If the pages support the selection, run
37
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
37
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
38
38
 
39
39
  If the documentation does not support the selection, run
40
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
40
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -11,7 +11,7 @@ you change the project.
11
11
 
12
12
  - https://docs.copilotkit.ai/ms-agent-harness-dotnet/quickstart.md
13
13
  - https://docs.copilotkit.ai/ms-agent-harness-dotnet/inspector.md
14
- - https://docs.copilotkit.ai/ms-agent-harness-dotnet/generative-ui/a2ui/fixed-schema.md
14
+ - https://docs.copilotkit.ai/ms-agent-harness-dotnet/generative-ui/tool-based.md
15
15
  - https://docs.copilotkit.ai/ms-agent-harness-dotnet/agent-app-context.md
16
16
  - https://learn.microsoft.com/en-us/agent-framework/get-started/harness
17
17
  - https://learn.microsoft.com/en-us/agent-framework/integrations/by-component/ui/ag-ui/getting-started
@@ -30,11 +30,9 @@ For a new Harness agent, use `AsHarnessAgent` with `HarnessAgentOptions`. Disabl
30
30
  providers that add environment-dependent tools. Pass the project-owned tools through
31
31
  `ChatOptions`.
32
32
 
33
- For fixed-schema A2UI, keep the C# tool and its inline schema in the Harness agent. Set
34
- `injectA2UITool` to `false` in the runtime. The page omits a bundled setup block, and its
35
- action-handler note describes Python SDK behavior. Do not infer C# action-handler support
36
- from the Python-only note. If the visible C# steps do not cover the requested setup, run
37
- the unsupported route below.
33
+ A2UI is not on this path. If the developer asks for it, say first that its page omits a
34
+ bundled setup block and that its action-handler note describes Python SDK behavior, so C#
35
+ action-handler support cannot be inferred from it.
38
36
 
39
37
  A bare `HarnessAgent` does not consume AG-UI app context. The published example adds a
40
38
  custom `DelegatingAIAgent` wrapper that reads context from `ChatOptions.AdditionalProperties`
@@ -43,10 +41,10 @@ browser proof. Do not copy the page's generic `CreateAIAgent` constructor over a
43
41
  Harness agent.
44
42
 
45
43
  Record the selected framework, provider, model, required credential variable names, these
46
- URLs, and the quickstart and A2UI gaps.
44
+ URLs, and the quickstart gap.
47
45
 
48
46
  If the pages support the selection, run
49
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
47
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
50
48
 
51
49
  If the documentation does not support the selection, run
52
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
50
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -16,7 +16,7 @@ so a scaffold that writes `agent/.env` and never loads it starts with no credent
16
16
 
17
17
  - https://docs.copilotkit.ai/ms-agent-python/quickstart.md
18
18
  - https://docs.copilotkit.ai/ms-agent-python/inspector.md
19
- - https://docs.copilotkit.ai/ms-agent-python/generative-ui/a2ui/fixed-schema.md
19
+ - https://docs.copilotkit.ai/ms-agent-python/generative-ui/tool-based.md
20
20
  - https://docs.copilotkit.ai/ms-agent-python/agent-app-context.md
21
21
 
22
22
  The documentation scope is `ms-agent-python`. The quickstart at that scope is
@@ -28,7 +28,7 @@ Record the selected framework, vendor, model, required credential variable names
28
28
  these URLs.
29
29
 
30
30
  If the pages support the selection, run
31
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
31
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
32
32
 
33
33
  If the documentation does not support the selection, run
34
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -10,29 +10,40 @@ Name the default model credential `OPENAI_API_KEY`.
10
10
 
11
11
  - https://docs.copilotkit.ai/pydantic-ai/quickstart.md
12
12
  - https://docs.copilotkit.ai/pydantic-ai/inspector.md
13
- - https://docs.copilotkit.ai/pydantic-ai/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/pydantic-ai/generative-ui/tool-based.md
14
+ - https://docs.copilotkit.ai/pydantic-ai/agent-app-context.md
14
15
  - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
15
16
 
16
17
  The documentation scope is `pydantic-ai`. For an existing agent, install the exact
17
18
  documented backend set with
18
19
  `uv add 'pydantic-ai-slim[ag-ui,openai]>=2,<3' 'starlette>=0.46.2' uvicorn`.
19
- Keep the Starlette endpoint that calls `AGUIAdapter.dispatch_request`. Register it in
20
- Copilot Runtime with `HttpAgent` and keep `InMemoryAgentRunner` for the documented local
21
- OSS setup. Do not replace this transport with a different Pydantic AI adapter.
22
-
23
- For fixed-schema A2UI, keep the tool in the agent. Set `injectA2UITool` to `false` in the
24
- runtime. The documented Python setup does not support `action_handlers` on
25
- `a2ui.render`. Do not add them or claim that the fixed-schema button callback works.
26
-
27
- No Pydantic AI agent-app-context Markdown page is available. The reference page above
28
- documents the frontend hook only. Do not invent the missing agent-side context setup. If
29
- the requested work needs that setup, run the unsupported route below.
20
+ Keep the Starlette endpoint that calls `AGUIAdapter.dispatch_request`, unless the app
21
+ context route below replaces it with the two-step form. Register it in Copilot Runtime
22
+ with `HttpAgent` and keep `InMemoryAgentRunner` for the documented local OSS setup. Do not replace this transport with a different Pydantic AI adapter.
23
+
24
+ A2UI is not on this path. If the developer asks for it, say first that the documented
25
+ Python setup does not support `action_handlers` on `a2ui.render`, so its button callback
26
+ cannot return a decision to the agent.
27
+
28
+ The AG-UI adapter does not pass `RunAgentInput.context` to the agent, and it does not
29
+ warn when it drops it. The frontend hook alone leaves the agent with nothing, and the
30
+ agent still answers as though it had the data. Wiring `useAgentContext` is not enough on
31
+ its own.
32
+
33
+ Follow the agent-app-context page above for the agent side. Build the adapter with
34
+ `AGUIAdapter.from_request`, pass `adapter.run_input.context` into `deps`, and read the
35
+ entries back through a tool. `dispatch_request` parses the request itself and leaves no
36
+ `run_input`, so the context route needs the two-step form even though every other route
37
+ here uses the one-liner. Parse `value` with `json.loads`: the hook stringifies it and
38
+ AG-UI types it as a string, so a shape check on it never passes. Never build
39
+ `instructions` from an entry. Entries are client-submitted and reach the model as tool
40
+ output only.
30
41
 
31
42
  Record the selected framework, vendor, model, required credential variable names, these
32
- URLs, and the context and A2UI limits.
43
+ URLs, and the two-step context route.
33
44
 
34
45
  If the pages support the selection, run
35
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
46
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
36
47
 
37
48
  If the documentation does not support the selection, run
38
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
49
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -10,13 +10,14 @@ Name the default model credential `OPENAI_API_KEY`.
10
10
 
11
11
  - https://docs.copilotkit.ai/strands/quickstart.md
12
12
  - https://docs.copilotkit.ai/strands/inspector.md
13
- - https://docs.copilotkit.ai/strands/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/strands/generative-ui/tool-based.md
14
14
  - https://docs.copilotkit.ai/strands/shared-state/agent-readonly.md
15
15
 
16
16
  The documentation scope is `strands`. Use the Python examples from these pages.
17
- The fixed-schema A2UI tool makes its own OpenAI call. Set `injectA2UITool` to `false` when
18
- the fixed-schema A2UI tool makes its own OpenAI call. This prevents a second injected A2UI
19
- tool from changing the documented setup.
17
+
18
+ A2UI is not on this path. If the developer asks for it, say first that the fixed-schema
19
+ A2UI tool makes its own OpenAI call, so it bills a second model call this plan does not
20
+ account for.
20
21
 
21
22
  No Strands agent-app-context Markdown page is available. Do not invent an
22
23
  agent-app-context setup. If the requested work needs that missing setup, run the
@@ -26,7 +27,7 @@ Record the selected framework, vendor, model, required credential variable names
26
27
  URLs, and the context documentation gap.
27
28
 
28
29
  If the pages support the selection, run
29
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
30
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
30
31
 
31
32
  If the documentation does not support the selection, run
32
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
33
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -10,23 +10,25 @@ Name the default model credential `OPENAI_API_KEY`.
10
10
 
11
11
  - https://docs.copilotkit.ai/strands-typescript/quickstart.md
12
12
  - https://docs.copilotkit.ai/strands-typescript/inspector.md
13
- - https://docs.copilotkit.ai/strands-typescript/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/strands-typescript/generative-ui/tool-based.md
14
14
  - https://docs.copilotkit.ai/strands-typescript/shared-state/agent-readonly.md
15
15
 
16
16
  The documentation scope is `strands-typescript`. Use only the TypeScript examples from
17
17
  these pages. Install `@modelcontextprotocol/sdk` as a runtime dependency.
18
18
  `@strands-agents/sdk` loads it even when the application does not use MCP.
19
19
 
20
- The fixed-schema page has no Strands TypeScript backend example. No Strands TypeScript
21
- agent-app-context Markdown page is available. Do not translate another language's backend
22
- example or invent either missing setup. If the requested work needs either missing setup,
20
+ No Strands TypeScript agent-app-context Markdown page is available. Do not translate
21
+ another language's backend example or invent that setup. If the requested work needs it,
23
22
  run the unsupported route below.
24
23
 
24
+ A2UI is not on this path. If the developer asks for it, say first that its page has no
25
+ Strands TypeScript backend example, so a TypeScript project has nothing to follow.
26
+
25
27
  Record the selected framework, vendor, model, required credential variable names, these
26
- URLs, and both documentation gaps.
28
+ URLs, and the context documentation gap.
27
29
 
28
30
  If the pages support the selection, run
29
- `npx --yes copilotkit@4.9.4 onboard read frontend/plan`.
31
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
30
32
 
31
33
  If the documentation does not support the selection, run
32
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -5,24 +5,37 @@ Preserve an existing Angular frontend. Use the selected page for a new frontend.
5
5
  Use the starter shortcut only if all these facts are true: the target directory contains
6
6
  no entries, its name is a valid `init` project name, and the selected framework is ADK.
7
7
  If all three facts are true, record Angular as the selected frontend. Then run
8
- `npx --yes copilotkit@4.9.4 onboard read starter/clone` before you fetch documentation.
8
+ `npx --yes copilotkit@4.9.17 onboard read starter/clone` before you fetch documentation.
9
9
 
10
10
  ## Documentation
11
11
 
12
12
  - https://docs.copilotkit.ai/angular.md
13
13
  - https://docs.copilotkit.ai/angular/inspector.md
14
14
  - https://docs.copilotkit.ai/reference/angular/directives/CopilotKitAgentContext.md
15
+ - https://docs.copilotkit.ai/angular/guides/frontend-tools-generative-ui.md
15
16
 
16
17
  Take the frontend-context step from the directive page. The agent-framework page shows
17
18
  the React hook, and Angular shares the same context through this directive instead.
18
19
  Use the Inspector page for proof.
19
20
 
21
+ Angular has no `useComponent`. Render the terminal component with `registerComponent` from
22
+ `@copilotkit/angular`, from the generative-UI guide above. The component is an ordinary
23
+ `ToolRenderer`: it takes a required `toolCall` signal input and reads `toolCall().args`.
24
+ The framework page shows the React hook. This function is Angular's equivalent, and the
25
+ two are the same tool to the agent, so nothing changes on the agent side.
26
+
27
+ `registerComponent` takes no `handler`, because the component only displays. If the
28
+ installed `@copilotkit/angular` does not export it, use `registerFrontendTool` with the
29
+ same `component` and `handler: async () => {}` instead, and record that substitution. Do
30
+ not give the handler a body: a display-only tool that returns a value writes it into the
31
+ thread as the tool's result.
32
+
20
33
  Angular CLI 22 requires Node `^22.22.3 || ^24.15.0 || >=26`. Check the Node version before
21
34
  you create or build an Angular project. If the installed version is lower, select a
22
35
  supported version first and use it for every later command in this project.
23
36
 
24
37
  If the pages support the selection, record Angular and these URLs. Then run
25
- `npx --yes copilotkit@4.9.4 onboard read credentials/finalize-plan`.
38
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
26
39
 
27
40
  If the documentation does not support the selection, run
28
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
41
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -15,7 +15,7 @@ These TypeScript options have starters: Claude Agent SDK TypeScript, LangGraph T
15
15
  Mastra, and Strands Agents TypeScript. The .NET option is Microsoft Agent Framework .NET.
16
16
 
17
17
  If all shortcut conditions are true, record Next.js as the selected frontend. Then run
18
- `npx --yes copilotkit@4.9.4 onboard read starter/clone` before you fetch documentation.
18
+ `npx --yes copilotkit@4.9.17 onboard read starter/clone` before you fetch documentation.
19
19
 
20
20
  ## Documentation
21
21
 
@@ -27,7 +27,7 @@ agent as the default agent, which is correct only for a project that has no agen
27
27
  Do not replace the developer's existing agent with the built-in agent.
28
28
 
29
29
  If the page supports the selection, record Next.js and this URL. Then run
30
- `npx --yes copilotkit@4.9.4 onboard read credentials/finalize-plan`.
30
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
31
31
 
32
32
  If the documentation does not support the selection, run
33
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
33
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -24,11 +24,11 @@ process.
24
24
 
25
25
  Use exactly one matching internal route:
26
26
 
27
- 1. React SPA: `npx --yes copilotkit@4.9.4 onboard read frontend/react-spa`
28
- 2. Next.js: `npx --yes copilotkit@4.9.4 onboard read frontend/nextjs`
29
- 3. Angular: `npx --yes copilotkit@4.9.4 onboard read frontend/angular`
30
- 4. Vue 3: `npx --yes copilotkit@4.9.4 onboard read frontend/vue`
31
- 5. React Native: `npx --yes copilotkit@4.9.4 onboard read frontend/react-native`
27
+ 1. React SPA: `npx --yes copilotkit@4.9.17 onboard read frontend/react-spa`
28
+ 2. Next.js: `npx --yes copilotkit@4.9.17 onboard read frontend/nextjs`
29
+ 3. Angular: `npx --yes copilotkit@4.9.17 onboard read frontend/angular`
30
+ 4. Vue 3: `npx --yes copilotkit@4.9.17 onboard read frontend/vue`
31
+ 5. React Native: `npx --yes copilotkit@4.9.17 onboard read frontend/react-native`
32
32
 
33
33
  If no listed frontend fits, run
34
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -9,8 +9,13 @@ Preserve an existing React Native frontend. Use the selected page for a new fron
9
9
 
10
10
  Use the Event Inspector page for proof.
11
11
 
12
+ Render the terminal component with `useComponent` from `@copilotkit/react-native`. The
13
+ package re-exports it from react-core, and it behaves as it does on the web. The page also
14
+ documents `useRenderTool`, which is React Native's own hook for drawing a tool the agent
15
+ already has. That is a different job and needs a tool in the agent.
16
+
12
17
  If the pages support the selection, record React Native and these URLs. Then run
13
- `npx --yes copilotkit@4.9.4 onboard read credentials/finalize-plan`.
18
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
14
19
 
15
20
  If the documentation does not support the selection, run
16
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
21
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -11,7 +11,7 @@ not move the agent into it.
11
11
  - https://docs.copilotkit.ai/react-spa.md
12
12
 
13
13
  If the page supports the selection, record React SPA and this URL. Then run
14
- `npx --yes copilotkit@4.9.4 onboard read credentials/finalize-plan`.
14
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
15
15
 
16
16
  If the documentation does not support the selection, run
17
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
17
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -7,11 +7,16 @@ Preserve an existing Vue 3 frontend. Use the selected page for a new frontend.
7
7
  - https://docs.copilotkit.ai/vue.md
8
8
  - https://docs.copilotkit.ai/reference/vue/components/CopilotKitProvider.md
9
9
  - https://docs.copilotkit.ai/reference/vue/hooks/useAgentContext.md
10
+ - https://docs.copilotkit.ai/reference/vue/hooks/useComponent.md
10
11
 
11
12
  Use the component page for the provider setup. Use the hook page for frontend context.
12
13
 
14
+ Render the terminal component with `useComponent` from `@copilotkit/vue/v2`, from the hook
15
+ page above. Vue has its own `useComponent`, which is not the React package. Take it from
16
+ that reference page rather than from a Vue generative-UI guide, which is not published.
17
+
13
18
  If the pages support the selection, record Vue 3 and these URLs. Then run
14
- `npx --yes copilotkit@4.9.4 onboard read credentials/finalize-plan`.
19
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
15
20
 
16
21
  If the documentation does not support the selection, run
17
- `npx --yes copilotkit@4.9.4 onboard read unsupported/no-validated-path`.
22
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.