copilotkit 4.9.2 → 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 +1879 -685
  4. package/onboarding/index.json +15 -0
  5. package/onboarding/prompts/authenticate/start.md +180 -71
  6. package/onboarding/prompts/conversion/plan.md +103 -0
  7. package/onboarding/prompts/credentials/finalize-plan.md +105 -135
  8. package/onboarding/prompts/credentials/plan.md +42 -25
  9. package/onboarding/prompts/fallback/best-effort.md +107 -16
  10. package/onboarding/prompts/framework/ag2.md +8 -19
  11. package/onboarding/prompts/framework/agno.md +12 -20
  12. package/onboarding/prompts/framework/built-in.md +4 -14
  13. package/onboarding/prompts/framework/claude-sdk-python.md +8 -18
  14. package/onboarding/prompts/framework/claude-sdk-typescript.md +10 -20
  15. package/onboarding/prompts/framework/crewai-flows.md +31 -27
  16. package/onboarding/prompts/framework/deep-agents.md +10 -20
  17. package/onboarding/prompts/framework/google-adk.md +4 -16
  18. package/onboarding/prompts/framework/langgraph-fastapi.md +4 -16
  19. package/onboarding/prompts/framework/langgraph-python.md +4 -16
  20. package/onboarding/prompts/framework/langgraph-typescript.md +4 -16
  21. package/onboarding/prompts/framework/llamaindex.md +8 -19
  22. package/onboarding/prompts/framework/mastra.md +4 -16
  23. package/onboarding/prompts/framework/ms-agent-dotnet.md +19 -50
  24. package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +24 -36
  25. package/onboarding/prompts/framework/ms-agent-python.md +4 -16
  26. package/onboarding/prompts/framework/pydantic-ai.md +27 -26
  27. package/onboarding/prompts/framework/strands-python.md +9 -18
  28. package/onboarding/prompts/framework/strands-typescript.md +10 -18
  29. package/onboarding/prompts/frontend/angular.md +22 -19
  30. package/onboarding/prompts/frontend/nextjs.md +6 -16
  31. package/onboarding/prompts/frontend/plan.md +9 -14
  32. package/onboarding/prompts/frontend/react-native.md +11 -14
  33. package/onboarding/prompts/frontend/react-spa.md +5 -15
  34. package/onboarding/prompts/frontend/vue.md +12 -14
  35. package/onboarding/prompts/implementation/build-and-validate.md +61 -101
  36. package/onboarding/prompts/proof/complete.md +24 -5
  37. package/onboarding/prompts/proof/oss-baseline.md +15 -50
  38. package/onboarding/prompts/proof/round-trip.md +96 -271
  39. package/onboarding/prompts/starter/clone.md +4 -4
  40. package/onboarding/prompts/subagent/create-plan.md +49 -11
  41. package/onboarding/prompts/subagent/implement-and-validate.md +71 -51
  42. package/onboarding/prompts/subagent/inspect-repository.md +38 -9
  43. package/onboarding/prompts/subagent/prove-oss-baseline.md +2 -1
  44. package/onboarding/prompts/subagent/prove-round-trip.md +154 -51
  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
@@ -1,71 +1,40 @@
1
1
  # Configure Microsoft Agent Framework for .NET
2
2
 
3
- Preserve an existing Microsoft Agent Framework model setup. Start with GitHub Models for
4
- a new agent, which is what the starter configures. Offer another vendor only after an
5
- exact CopilotKit Markdown page names it. The page must name its credential variables and
6
- setup steps.
3
+ Preserve an existing Microsoft Agent Framework model setup. Use direct OpenAI for a new
4
+ agent. Name its credential `OPENAI_API_KEY`. Do not change an existing provider.
7
5
 
8
- This agent resolves its model credential in a fixed order: the `OPENAI_API_KEY`
9
- environment variable, then `OPENAI_API_KEY` in configuration, then a `GitHubToken` user
10
- secret. The environment variable wins.
6
+ .NET configuration reads appsettings, environment variables, and user secrets. It does not
7
+ read a `.env` file. If the project uses `.env`, application code must load it before the
8
+ OpenAI client starts. Do not create a `.env` file without that loader.
11
9
 
12
- Neither this framework nor .NET configuration reads a `.env`. `builder.Configuration`
13
- sources appsettings, environment variables, and user secrets, and none of those is a
14
- dotenv file. A credential in `.env` works only if application code loads it into the
15
- environment before the chat client constructs: walk up from the working directory for a
16
- `.env` and set each name that is not already set. Otherwise pick a mechanism .NET reads
17
- on its own, an exported variable or a user secret. A scaffold that writes `.env`, reads
18
- `builder.Configuration["OPENAI_API_KEY"]`, and loads nothing falls silently to the
19
- `GitHubToken` branch.
10
+ For a user secret, run `dotnet user-secrets set OPENAI_API_KEY` from the agent directory.
11
+ The app must read the same name through .NET configuration. An exported environment
12
+ variable with that name takes precedence over the user secret.
20
13
 
21
- Pick one and say which. For GitHub Models, set the user secret from the agent directory
22
- with `dotnet user-secrets set GitHubToken`. The agent reads it through
23
- `builder.Configuration["GitHubToken"]`, so the name in the store and the name in the
24
- code have to match exactly. For an OpenAI-compatible vendor, name `OPENAI_API_KEY`
25
- instead.
26
-
27
- The GitHub Models catalog is not the OpenAI catalog. A model name that is valid against
28
- `api.openai.com` can return 404 against `https://models.inference.ai.azure.com`, so a
29
- run that falls back to the `GitHubToken` branch and keeps the same model name gets a 404
30
- that looks like an outage rather than a wrong catalog. Name a model the endpoint you
31
- selected serves.
32
-
33
- Check whether `OPENAI_API_KEY` is already set in the environment before you configure a
34
- user secret. It takes precedence, so a run on a machine that already exports one uses
35
- that key rather than the token you just set, and reports success for the wrong reason.
36
-
37
- The .NET SDK has to be installed before any of this. Confirm `dotnet --version` answers
38
- before scaffolding, rather than after.
39
-
40
- Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
41
- store, or request a secret value.
14
+ Run `dotnet --version` before you change the project.
42
15
 
43
16
  ## Documentation
44
17
 
45
18
  - https://docs.copilotkit.ai/ms-agent-dotnet/quickstart.md
46
19
  - https://docs.copilotkit.ai/ms-agent-dotnet/inspector.md
47
- - 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
48
21
  - https://docs.copilotkit.ai/ms-agent-dotnet/agent-app-context.md
49
-
50
- Fetch all four pages in one step rather than one after another. Sequential fetching
51
- cost about nine minutes of the first proven journey.
22
+ - https://learn.microsoft.com/en-us/agent-framework/integrations/by-component/ui/ag-ui/getting-started
52
23
 
53
24
  The documentation scope is `ms-agent-dotnet`. The quickstart at that scope is
54
25
  byte-identical to the one at `ms-agent-python`: one page serves both languages through
55
26
  a `.NET` and `Python` tab group. The scope in the URL does not select the language, so
56
27
  read the .NET tab.
57
28
 
58
- Record the selected framework, vendor, model, required credential variable names, and
59
- these URLs.
60
- Do not use remembered CopilotKit instructions.
29
+ Use `Microsoft.Agents.AI.Hosting.AGUI.AspNetCore` from the Learn guide. Register the server
30
+ with `AddAGUIServer`. Map the existing `AIAgent` with `MapAGUIServer`. The endpoint accepts
31
+ `RunAgentInput` requests and streams AG-UI events with server-sent events.
61
32
 
62
- A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
63
- not a fact about the page. Retrieve the same URL a second way before you judge it. Run
64
- `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
65
- unavailable only after a second method also fails.
33
+ Record the selected framework, provider, model, required credential variable names, and
34
+ these URLs.
66
35
 
67
36
  If the pages support the selection, run
68
- `npx --yes copilotkit@4.9.2 onboard read frontend/plan`.
37
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
69
38
 
70
- If a second method also fails, or a page that loads does not support the selection, run
71
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
39
+ If the documentation does not support the selection, run
40
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -1,45 +1,38 @@
1
1
  # Configure MS Agent Harness for .NET
2
2
 
3
- Preserve an existing MS Agent Harness model, vendor, credential name, and host setup. The
4
- documented .NET starter uses GitHub Models. Use that vendor for a new matching setup.
3
+ Preserve an existing MS Agent Harness model, provider, credential name, and host setup.
4
+ Use direct OpenAI for a new setup. Name its credential `OPENAI_API_KEY`.
5
5
 
6
- For GitHub Models, name the user secret `GitHubToken`. Set it from the agent directory
7
- with `dotnet user-secrets set GitHubToken`. The app must read the same name through .NET
8
- configuration. Confirm `dotnet --version` works before changing the project.
9
-
10
- For an existing OpenAI setup, keep `OPENAI_API_KEY` and the existing OpenAI client. Do not
11
- convert it to GitHub Models.
12
-
13
- Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
14
- store, or request a secret value.
6
+ For a user secret, run `dotnet user-secrets set OPENAI_API_KEY` from the agent directory.
7
+ The app must read the same name through .NET configuration. Run `dotnet --version` before
8
+ you change the project.
15
9
 
16
10
  ## Documentation
17
11
 
18
12
  - https://docs.copilotkit.ai/ms-agent-harness-dotnet/quickstart.md
19
13
  - https://docs.copilotkit.ai/ms-agent-harness-dotnet/inspector.md
20
- - 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
21
15
  - https://docs.copilotkit.ai/ms-agent-harness-dotnet/agent-app-context.md
22
-
23
- Fetch all four pages in one step rather than one after another.
16
+ - https://learn.microsoft.com/en-us/agent-framework/get-started/harness
17
+ - https://learn.microsoft.com/en-us/agent-framework/integrations/by-component/ui/ag-ui/getting-started
24
18
 
25
19
  The documentation scope is `ms-agent-harness-dotnet`. Read only the `.NET` tab of the
26
20
  quickstart. Do not use its Python tab. Use `Microsoft.Agents.AI.Harness --version 1.19.0`
27
21
  for the stable agent package. The current AG-UI host package is
28
22
  `Microsoft.Agents.AI.Hosting.AGUI.AspNetCore --version 1.19.0-preview.260822.1`.
29
- Use `AddAGUIServer` service registration and a `MapAGUIServer` endpoint. The older
30
- showcase uses `AddAGUI` and `MapAGUI`. Do not copy those stale names into the current
31
- host. Register the remote endpoint in Copilot Runtime with `HttpAgent`.
23
+ Use `AddAGUIServer` service registration and a `MapAGUIServer` endpoint. Register the
24
+ remote endpoint in Copilot Runtime with `HttpAgent`.
32
25
 
33
- The quickstart's generic .NET example uses `CreateAIAgent`. Do not replace an existing
34
- Harness agent with that example. For a new Harness agent, use `AsHarnessAgent` with
35
- `HarnessAgentOptions`. Disable built-in providers that add environment-dependent tools,
36
- then pass the project-owned tools through `ChatOptions`.
26
+ The Learn Harness guide creates a Harness agent from an `IChatClient` with
27
+ `AsHarnessAgent`. Keep one `AgentSession` across turns. The quickstart's generic .NET
28
+ example uses `CreateAIAgent`. Do not replace an existing Harness agent with that example.
29
+ For a new Harness agent, use `AsHarnessAgent` with `HarnessAgentOptions`. Disable built-in
30
+ providers that add environment-dependent tools. Pass the project-owned tools through
31
+ `ChatOptions`.
37
32
 
38
- For fixed-schema A2UI, keep the C# tool and its inline schema in the Harness agent. Set
39
- `injectA2UITool` to `false` in the runtime. The page omits a bundled setup block, and its
40
- action-handler note describes Python SDK behavior. Do not infer C# action-handler support
41
- from the Python-only note. If the visible C# steps do not cover the requested setup, run
42
- 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.
43
36
 
44
37
  A bare `HarnessAgent` does not consume AG-UI app context. The published example adds a
45
38
  custom `DelegatingAIAgent` wrapper that reads context from `ChatOptions.AdditionalProperties`
@@ -47,16 +40,11 @@ and injects a system message. Keep app context unsupported until that wrapper pa
47
40
  browser proof. Do not copy the page's generic `CreateAIAgent` constructor over an existing
48
41
  Harness agent.
49
42
 
50
- Record the selected framework, vendor, model, required credential variable names, these
51
- URLs, and the quickstart and A2UI gaps. Do not use remembered CopilotKit instructions.
52
-
53
- A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
54
- not a fact about the page. Retrieve the same URL a second way before you judge it. Run
55
- `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
56
- unavailable only after a second method also fails.
43
+ Record the selected framework, provider, model, required credential variable names, these
44
+ URLs, and the quickstart gap.
57
45
 
58
46
  If the pages support the selection, run
59
- `npx --yes copilotkit@4.9.2 onboard read frontend/plan`.
47
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
60
48
 
61
- If a second method also fails, or a page that loads does not support the selection, run
62
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
49
+ If the documentation does not support the selection, run
50
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -12,19 +12,13 @@ looks finished and reads no key.
12
12
  This framework reads no `.env` on its own. Whatever loads the file is application code,
13
13
  so a scaffold that writes `agent/.env` and never loads it starts with no credential.
14
14
 
15
- Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
16
- store, or request a secret value.
17
-
18
15
  ## Documentation
19
16
 
20
17
  - https://docs.copilotkit.ai/ms-agent-python/quickstart.md
21
18
  - https://docs.copilotkit.ai/ms-agent-python/inspector.md
22
- - 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
23
20
  - https://docs.copilotkit.ai/ms-agent-python/agent-app-context.md
24
21
 
25
- Fetch all four pages in one step rather than one after another. Sequential fetching
26
- cost about nine minutes of the first proven journey.
27
-
28
22
  The documentation scope is `ms-agent-python`. The quickstart at that scope is
29
23
  byte-identical to the one at `ms-agent-dotnet`: one page serves both languages through
30
24
  a `.NET` and `Python` tab group. The scope in the URL does not select the language, so
@@ -32,15 +26,9 @@ read the Python tab. The first code block on the page is the .NET one.
32
26
 
33
27
  Record the selected framework, vendor, model, required credential variable names, and
34
28
  these URLs.
35
- Do not use remembered CopilotKit instructions.
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
29
 
42
30
  If the pages support the selection, run
43
- `npx --yes copilotkit@4.9.2 onboard read frontend/plan`.
31
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
44
32
 
45
- If a second method also fails, or a page that loads does not support the selection, run
46
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
33
+ If the documentation does not support the selection, run
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -6,43 +6,44 @@ its credential variables and setup steps.
6
6
 
7
7
  Name the default model credential `OPENAI_API_KEY`.
8
8
 
9
- Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
10
- store, or request a secret value.
11
-
12
9
  ## Documentation
13
10
 
14
11
  - https://docs.copilotkit.ai/pydantic-ai/quickstart.md
15
12
  - https://docs.copilotkit.ai/pydantic-ai/inspector.md
16
- - 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
17
15
  - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
18
16
 
19
- Fetch all four pages in one step rather than one after another.
20
-
21
17
  The documentation scope is `pydantic-ai`. For an existing agent, install the exact
22
18
  documented backend set with
23
19
  `uv add 'pydantic-ai-slim[ag-ui,openai]>=2,<3' 'starlette>=0.46.2' uvicorn`.
24
- Keep the Starlette endpoint that calls `AGUIAdapter.dispatch_request`. Register it in
25
- Copilot Runtime with `HttpAgent` and keep `InMemoryAgentRunner` for the documented local
26
- OSS setup. Do not replace this transport with a different Pydantic AI adapter.
27
-
28
- For fixed-schema A2UI, keep the tool in the agent. Set `injectA2UITool` to `false` in the
29
- runtime. The documented Python setup does not support `action_handlers` on
30
- `a2ui.render`. Do not add them or claim that the fixed-schema button callback works.
31
-
32
- No Pydantic AI agent-app-context Markdown page is available. The reference page above
33
- documents the frontend hook only. Do not invent the missing agent-side context setup. If
34
- 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.
35
41
 
36
42
  Record the selected framework, vendor, model, required credential variable names, these
37
- URLs, and the context and A2UI limits. Do not use 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
+ URLs, and the two-step context route.
43
44
 
44
45
  If the pages support the selection, run
45
- `npx --yes copilotkit@4.9.2 onboard read frontend/plan`.
46
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
46
47
 
47
- If a second method also fails, or a page that loads does not support the selection, run
48
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
48
+ If the documentation does not support the selection, run
49
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -6,37 +6,28 @@ credential variables and setup steps.
6
6
 
7
7
  Name the default model credential `OPENAI_API_KEY`.
8
8
 
9
- Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
10
- store, or request a secret value.
11
-
12
9
  ## Documentation
13
10
 
14
11
  - https://docs.copilotkit.ai/strands/quickstart.md
15
12
  - https://docs.copilotkit.ai/strands/inspector.md
16
- - https://docs.copilotkit.ai/strands/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/strands/generative-ui/tool-based.md
17
14
  - https://docs.copilotkit.ai/strands/shared-state/agent-readonly.md
18
15
 
19
- Fetch all four pages in one step rather than one after another.
20
-
21
16
  The documentation scope is `strands`. Use the Python examples from these pages.
22
- The fixed-schema A2UI tool makes its own OpenAI call. Set `injectA2UITool` to `false` when
23
- the fixed-schema A2UI tool makes its own OpenAI call. This prevents a second injected A2UI
24
- 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.
25
21
 
26
22
  No Strands agent-app-context Markdown page is available. Do not invent an
27
23
  agent-app-context setup. If the requested work needs that missing setup, run the
28
24
  unsupported route below.
29
25
 
30
26
  Record the selected framework, vendor, model, required credential variable names, these
31
- URLs, and the context documentation gap. 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.
27
+ URLs, and the context documentation gap.
37
28
 
38
29
  If the pages support the selection, run
39
- `npx --yes copilotkit@4.9.2 onboard read frontend/plan`.
30
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
40
31
 
41
- If a second method also fails, or a page that loads does not support the selection, run
42
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
32
+ If the documentation does not support the selection, run
33
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -6,37 +6,29 @@ credential variables and setup steps.
6
6
 
7
7
  Name the default model credential `OPENAI_API_KEY`.
8
8
 
9
- Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
10
- store, or request a secret value.
11
-
12
9
  ## Documentation
13
10
 
14
11
  - https://docs.copilotkit.ai/strands-typescript/quickstart.md
15
12
  - https://docs.copilotkit.ai/strands-typescript/inspector.md
16
- - https://docs.copilotkit.ai/strands-typescript/generative-ui/a2ui/fixed-schema.md
13
+ - https://docs.copilotkit.ai/strands-typescript/generative-ui/tool-based.md
17
14
  - https://docs.copilotkit.ai/strands-typescript/shared-state/agent-readonly.md
18
15
 
19
- Fetch all four pages in one step rather than one after another.
20
-
21
16
  The documentation scope is `strands-typescript`. Use only the TypeScript examples from
22
17
  these pages. Install `@modelcontextprotocol/sdk` as a runtime dependency.
23
18
  `@strands-agents/sdk` loads it even when the application does not use MCP.
24
19
 
25
- The fixed-schema page has no Strands TypeScript backend example. No Strands TypeScript
26
- agent-app-context Markdown page is available. Do not translate another language's backend
27
- 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,
28
22
  run the unsupported route below.
29
23
 
30
- Record the selected framework, vendor, model, required credential variable names, these
31
- URLs, and both documentation gaps. Do not use remembered CopilotKit instructions.
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.
32
26
 
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.
27
+ Record the selected framework, vendor, model, required credential variable names, these
28
+ URLs, and the context documentation gap.
37
29
 
38
30
  If the pages support the selection, run
39
- `npx --yes copilotkit@4.9.2 onboard read frontend/plan`.
31
+ `npx --yes copilotkit@4.9.17 onboard read frontend/plan`.
40
32
 
41
- If a second method also fails, or a page that loads does not support the selection, run
42
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
33
+ If the documentation does not support the selection, run
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -5,34 +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.2 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
- - Credentials and plan: `Not applicable`
13
- - Implementation and validation: https://docs.copilotkit.ai/angular.md
14
- - Proof: https://docs.copilotkit.ai/angular.md
15
- - Frontend context: https://docs.copilotkit.ai/reference/angular/directives/CopilotKitAgentContext.md
16
-
17
- Fetch both selected documentation pages in one step rather than one after another.
18
- Record Angular as the selected frontend and keep these URLs. Do not use remembered
19
- CopilotKit instructions.
12
+ - https://docs.copilotkit.ai/angular.md
13
+ - https://docs.copilotkit.ai/angular/inspector.md
14
+ - https://docs.copilotkit.ai/reference/angular/directives/CopilotKitAgentContext.md
15
+ - https://docs.copilotkit.ai/angular/guides/frontend-tools-generative-ui.md
20
16
 
21
17
  Take the frontend-context step from the directive page. The agent-framework page shows
22
18
  the React hook, and Angular shares the same context through this directive instead.
19
+ Use the Inspector page for proof.
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.
23
32
 
24
33
  Angular CLI 22 requires Node `^22.22.3 || ^24.15.0 || >=26`. Check the Node version before
25
34
  you create or build an Angular project. If the installed version is lower, select a
26
35
  supported version first and use it for every later command in this project.
27
36
 
28
- A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
29
- not a fact about the page. Retrieve the same URL a second way before you judge it. Run
30
- `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
31
- unavailable only after a second method also fails.
32
-
33
- If the page supports the selection, run
34
- `npx --yes copilotkit@4.9.2 onboard read credentials/finalize-plan`.
37
+ If the pages support the selection, record Angular and these URLs. Then run
38
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
35
39
 
36
- If a second method also fails, or the page that loads does not support the selection,
37
- run
38
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
40
+ If the documentation does not support the selection, run
41
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -15,29 +15,19 @@ 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.2 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
 
22
- - Credentials and plan: `Not applicable`
23
- - Implementation and validation: https://docs.copilotkit.ai/quickstart.md
24
- - Proof: https://docs.copilotkit.ai/quickstart.md
25
-
26
- Fetch each selected documentation URL. Record Next.js as the selected frontend and keep
27
- these URLs. Do not use remembered CopilotKit instructions.
22
+ - https://docs.copilotkit.ai/quickstart.md
28
23
 
29
24
  Take the frontend scaffolding from this page. Take the runtime agent wiring from the
30
25
  agent framework documentation instead. This page configures the CopilotKit built-in
31
26
  agent as the default agent, which is correct only for a project that has no agent.
32
27
  Do not replace the developer's existing agent with the built-in agent.
33
28
 
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.2 onboard read credentials/finalize-plan`.
29
+ If the page supports the selection, record Next.js and this URL. Then run
30
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
41
31
 
42
- If a second method also fails, or a page that loads does not support the selection, run
43
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
32
+ If the documentation does not support the selection, run
33
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -5,9 +5,9 @@ that the repository does not show. Do not change application code in this phase.
5
5
 
6
6
  Use a gentle wizard. Ask one short question at a time. Do not combine separate choices in
7
7
  one question. Put the recommendation first, give its evidence in one sentence, and keep
8
- the alternatives short. When the frontend is unknown, ask only whether to use the
9
- recommended frontend. If the developer declines it, ask one follow-up question that lists
10
- the valid frontend choices. Do not ask about the model or project in this step.
8
+ the alternatives short. When the frontend is unknown, use this rule: Ask one frontend
9
+ question that lists the recommendation and valid choices. Do not ask a yes-or-no question
10
+ first. Do not ask about the model or project in this step.
11
11
 
12
12
  If the project has a frontend, preserve it and use the matching route below. If the project
13
13
  needs a frontend, show the valid choices and one recommendation based on repository
@@ -22,18 +22,13 @@ CopilotKit runtime lives: Next.js hosts it in a route handler, Angular in its SS
22
22
  server, and Vue 3, React SPA and React Native reach a runtime that runs as its own
23
23
  process.
24
24
 
25
- A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
26
- not a fact about the page. Retrieve the same URL a second way before you judge it. Run
27
- `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
28
- unavailable only after a second method also fails.
29
-
30
25
  Use exactly one matching internal route:
31
26
 
32
- 1. React SPA: `npx --yes copilotkit@4.9.2 onboard read frontend/react-spa`
33
- 2. Next.js: `npx --yes copilotkit@4.9.2 onboard read frontend/nextjs`
34
- 3. Angular: `npx --yes copilotkit@4.9.2 onboard read frontend/angular`
35
- 4. Vue 3: `npx --yes copilotkit@4.9.2 onboard read frontend/vue`
36
- 5. React Native: `npx --yes copilotkit@4.9.2 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`
37
32
 
38
33
  If no listed frontend fits, run
39
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
34
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -4,21 +4,18 @@ Preserve an existing React Native frontend. Use the selected page for a new fron
4
4
 
5
5
  ## Documentation
6
6
 
7
- - Credentials and plan: `Not applicable`
8
- - Implementation and validation: https://docs.copilotkit.ai/react-native.md
9
- - Proof: https://docs.copilotkit.ai/react-native.md
7
+ - https://docs.copilotkit.ai/react-native.md
8
+ - https://docs.copilotkit.ai/troubleshooting/event-inspector.md
10
9
 
11
- Fetch the selected documentation page. Record React Native as the selected frontend and
12
- keep this URL. Do not use remembered CopilotKit instructions.
10
+ Use the Event Inspector page for proof.
13
11
 
14
- A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
15
- not a fact about the page. Retrieve the same URL a second way before you judge it. Run
16
- `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
17
- unavailable only after a second method also fails.
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.
18
16
 
19
- If the page supports the selection, run
20
- `npx --yes copilotkit@4.9.2 onboard read credentials/finalize-plan`.
17
+ If the pages support the selection, record React Native and these URLs. Then run
18
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
21
19
 
22
- If a second method also fails, or the page that loads does not support the selection,
23
- run
24
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
20
+ If the documentation does not support the selection, run
21
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.
@@ -8,20 +8,10 @@ not move the agent into it.
8
8
 
9
9
  ## Documentation
10
10
 
11
- - Credentials and plan: `Not applicable`
12
- - Implementation and validation: https://docs.copilotkit.ai/react-spa.md
13
- - Proof: https://docs.copilotkit.ai/react-spa.md
11
+ - https://docs.copilotkit.ai/react-spa.md
14
12
 
15
- Fetch the selected documentation page. Record React SPA as the selected frontend and
16
- keep this URL. Do not use remembered CopilotKit instructions.
13
+ If the page supports the selection, record React SPA and this URL. Then run
14
+ `npx --yes copilotkit@4.9.17 onboard read credentials/finalize-plan`.
17
15
 
18
- A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
19
- not a fact about the page. Retrieve the same URL a second way before you judge it. Run
20
- `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
21
- unavailable only after a second method also fails.
22
-
23
- If the page supports the selection, run
24
- `npx --yes copilotkit@4.9.2 onboard read credentials/finalize-plan`.
25
-
26
- If a second method also fails, or a page that loads does not support the selection, run
27
- `npx --yes copilotkit@4.9.2 onboard read unsupported/no-validated-path`.
16
+ If the documentation does not support the selection, run
17
+ `npx --yes copilotkit@4.9.17 onboard read unsupported/no-validated-path`.