copilotkit 4.8.3 → 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 +183 -2
- package/cli-build-info.json +7 -7
- package/index.js +5645 -3567
- package/onboarding/index.json +33 -33
- package/onboarding/prompts/authenticate/start.md +63 -10
- package/onboarding/prompts/credentials/finalize-plan.md +168 -15
- package/onboarding/prompts/credentials/plan.md +55 -49
- package/onboarding/prompts/fallback/best-effort.md +29 -0
- package/onboarding/prompts/framework/ag2.md +33 -7
- package/onboarding/prompts/framework/agno.md +32 -7
- package/onboarding/prompts/framework/built-in.md +30 -8
- package/onboarding/prompts/framework/claude-sdk-python.md +35 -7
- package/onboarding/prompts/framework/claude-sdk-typescript.md +39 -7
- package/onboarding/prompts/framework/crewai-flows.md +41 -7
- package/onboarding/prompts/framework/deep-agents.md +30 -6
- package/onboarding/prompts/framework/google-adk.md +32 -8
- package/onboarding/prompts/framework/langgraph-fastapi.md +24 -5
- package/onboarding/prompts/framework/langgraph-python.md +15 -5
- package/onboarding/prompts/framework/langgraph-typescript.md +15 -5
- package/onboarding/prompts/framework/llamaindex.md +35 -7
- package/onboarding/prompts/framework/mastra.md +48 -6
- package/onboarding/prompts/framework/ms-agent-dotnet.md +57 -7
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +48 -8
- package/onboarding/prompts/framework/ms-agent-python.md +32 -7
- package/onboarding/prompts/framework/pydantic-ai.md +34 -9
- package/onboarding/prompts/framework/strands-python.md +28 -9
- package/onboarding/prompts/framework/strands-typescript.md +28 -9
- package/onboarding/prompts/frontend/angular.md +20 -5
- package/onboarding/prompts/frontend/nextjs.md +13 -3
- package/onboarding/prompts/frontend/plan.md +20 -19
- 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 +82 -7
- package/onboarding/prompts/proof/complete.md +63 -2
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +150 -8
- package/onboarding/prompts/subagent/create-plan.md +69 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +48 -3
- package/onboarding/prompts/subagent/inspect-repository.md +13 -3
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +118 -11
- package/onboarding/prompts/unsupported/no-validated-path.md +27 -9
- package/package.json +1 -1
- package/release/release-tool.js +32 -4
- package/onboarding/prompts/frontend/slack.md +0 -20
- package/onboarding/prompts/frontend/teams.md +0 -20
|
@@ -1,6 +1,41 @@
|
|
|
1
|
-
# Configure Microsoft Agent Framework .NET
|
|
1
|
+
# Configure Microsoft Agent Framework for .NET
|
|
2
2
|
|
|
3
|
-
Preserve an existing Microsoft Agent Framework
|
|
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.
|
|
7
|
+
|
|
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.
|
|
11
|
+
|
|
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.
|
|
20
|
+
|
|
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.
|
|
4
39
|
|
|
5
40
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
6
41
|
store, or request a secret value.
|
|
@@ -10,12 +45,27 @@ store, or request a secret value.
|
|
|
10
45
|
- https://docs.copilotkit.ai/ms-agent-dotnet/quickstart.md
|
|
11
46
|
- https://docs.copilotkit.ai/ms-agent-dotnet/inspector.md
|
|
12
47
|
- https://docs.copilotkit.ai/ms-agent-dotnet/generative-ui/a2ui/fixed-schema.md
|
|
48
|
+
- 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.
|
|
52
|
+
|
|
53
|
+
The documentation scope is `ms-agent-dotnet`. The quickstart at that scope is
|
|
54
|
+
byte-identical to the one at `ms-agent-python`: one page serves both languages through
|
|
55
|
+
a `.NET` and `Python` tab group. The scope in the URL does not select the language, so
|
|
56
|
+
read the .NET tab.
|
|
57
|
+
|
|
58
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
59
|
+
these URLs.
|
|
60
|
+
Do not use remembered CopilotKit instructions.
|
|
13
61
|
|
|
14
|
-
|
|
15
|
-
|
|
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.
|
|
16
66
|
|
|
17
67
|
If the pages support the selection, run
|
|
18
|
-
`npx copilotkit@4.
|
|
68
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
19
69
|
|
|
20
|
-
If a page does not
|
|
21
|
-
`npx copilotkit@4.
|
|
70
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
71
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,7 +1,14 @@
|
|
|
1
|
-
# Configure
|
|
1
|
+
# Configure MS Agent Harness for .NET
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
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.
|
|
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.
|
|
5
12
|
|
|
6
13
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
7
14
|
store, or request a secret value.
|
|
@@ -11,12 +18,45 @@ store, or request a secret value.
|
|
|
11
18
|
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/quickstart.md
|
|
12
19
|
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/inspector.md
|
|
13
20
|
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/generative-ui/a2ui/fixed-schema.md
|
|
21
|
+
- 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.
|
|
24
|
+
|
|
25
|
+
The documentation scope is `ms-agent-harness-dotnet`. Read only the `.NET` tab of the
|
|
26
|
+
quickstart. Do not use its Python tab. Use `Microsoft.Agents.AI.Harness --version 1.19.0`
|
|
27
|
+
for the stable agent package. The current AG-UI host package is
|
|
28
|
+
`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`.
|
|
32
|
+
|
|
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`.
|
|
37
|
+
|
|
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.
|
|
43
|
+
|
|
44
|
+
A bare `HarnessAgent` does not consume AG-UI app context. The published example adds a
|
|
45
|
+
custom `DelegatingAIAgent` wrapper that reads context from `ChatOptions.AdditionalProperties`
|
|
46
|
+
and injects a system message. Keep app context unsupported until that wrapper passes
|
|
47
|
+
browser proof. Do not copy the page's generic `CreateAIAgent` constructor over an existing
|
|
48
|
+
Harness agent.
|
|
49
|
+
|
|
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.
|
|
14
52
|
|
|
15
|
-
|
|
16
|
-
|
|
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.
|
|
17
57
|
|
|
18
58
|
If the pages support the selection, run
|
|
19
|
-
`npx copilotkit@4.
|
|
59
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
20
60
|
|
|
21
|
-
If a page does not
|
|
22
|
-
`npx copilotkit@4.
|
|
61
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
62
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,6 +1,16 @@
|
|
|
1
|
-
# Configure Microsoft Agent Framework Python
|
|
1
|
+
# Configure Microsoft Agent Framework for Python
|
|
2
2
|
|
|
3
|
-
Preserve an existing Microsoft Agent Framework
|
|
3
|
+
Preserve an existing Microsoft Agent Framework 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 model credential `OPENAI_API_KEY`, in `agent/.env`. This framework also accepts
|
|
8
|
+
Azure OpenAI, through `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_CHAT_DEPLOYMENT_NAME`.
|
|
9
|
+
Pick one of the two and name it. A scaffold that writes one spelling and reads the other
|
|
10
|
+
looks finished and reads no key.
|
|
11
|
+
|
|
12
|
+
This framework reads no `.env` on its own. Whatever loads the file is application code,
|
|
13
|
+
so a scaffold that writes `agent/.env` and never loads it starts with no credential.
|
|
4
14
|
|
|
5
15
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
6
16
|
store, or request a secret value.
|
|
@@ -10,12 +20,27 @@ store, or request a secret value.
|
|
|
10
20
|
- https://docs.copilotkit.ai/ms-agent-python/quickstart.md
|
|
11
21
|
- https://docs.copilotkit.ai/ms-agent-python/inspector.md
|
|
12
22
|
- https://docs.copilotkit.ai/ms-agent-python/generative-ui/a2ui/fixed-schema.md
|
|
23
|
+
- https://docs.copilotkit.ai/ms-agent-python/agent-app-context.md
|
|
24
|
+
|
|
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
|
+
The documentation scope is `ms-agent-python`. The quickstart at that scope is
|
|
29
|
+
byte-identical to the one at `ms-agent-dotnet`: one page serves both languages through
|
|
30
|
+
a `.NET` and `Python` tab group. The scope in the URL does not select the language, so
|
|
31
|
+
read the Python tab. The first code block on the page is the .NET one.
|
|
32
|
+
|
|
33
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
34
|
+
these URLs.
|
|
35
|
+
Do not use remembered CopilotKit instructions.
|
|
13
36
|
|
|
14
|
-
|
|
15
|
-
|
|
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.
|
|
16
41
|
|
|
17
42
|
If the pages support the selection, run
|
|
18
|
-
`npx copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
19
44
|
|
|
20
|
-
If a page does not
|
|
21
|
-
`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`.
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
# Configure
|
|
1
|
+
# Configure Pydantic AI
|
|
2
2
|
|
|
3
|
-
Preserve an existing
|
|
4
|
-
another vendor only after
|
|
5
|
-
|
|
3
|
+
Preserve an existing Pydantic AI 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`.
|
|
6
8
|
|
|
7
9
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
8
10
|
store, or request a secret value.
|
|
@@ -12,12 +14,35 @@ store, or request a secret value.
|
|
|
12
14
|
- https://docs.copilotkit.ai/pydantic-ai/quickstart.md
|
|
13
15
|
- https://docs.copilotkit.ai/pydantic-ai/inspector.md
|
|
14
16
|
- https://docs.copilotkit.ai/pydantic-ai/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `pydantic-ai`. For an existing agent, install the exact
|
|
22
|
+
documented backend set with
|
|
23
|
+
`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.
|
|
35
|
+
|
|
36
|
+
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.
|
|
15
38
|
|
|
16
|
-
|
|
17
|
-
|
|
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.
|
|
18
43
|
|
|
19
44
|
If the pages support the selection, run
|
|
20
|
-
`npx copilotkit@4.
|
|
45
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
21
46
|
|
|
22
|
-
If a page does not
|
|
23
|
-
`npx copilotkit@4.
|
|
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`.
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
# Configure
|
|
1
|
+
# Configure Strands Agents Python
|
|
2
2
|
|
|
3
|
-
Preserve an existing
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
Preserve an existing Strands 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`.
|
|
6
8
|
|
|
7
9
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
8
10
|
store, or request a secret value.
|
|
@@ -12,12 +14,29 @@ store, or request a secret value.
|
|
|
12
14
|
- https://docs.copilotkit.ai/strands/quickstart.md
|
|
13
15
|
- https://docs.copilotkit.ai/strands/inspector.md
|
|
14
16
|
- https://docs.copilotkit.ai/strands/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/strands/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 `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.
|
|
25
|
+
|
|
26
|
+
No Strands agent-app-context Markdown page is available. Do not invent an
|
|
27
|
+
agent-app-context setup. If the requested work needs that missing setup, run the
|
|
28
|
+
unsupported route below.
|
|
29
|
+
|
|
30
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
31
|
+
URLs, and the context documentation gap. Do not use remembered CopilotKit instructions.
|
|
15
32
|
|
|
16
|
-
|
|
17
|
-
|
|
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.
|
|
18
37
|
|
|
19
38
|
If the pages support the selection, run
|
|
20
|
-
`npx copilotkit@4.
|
|
39
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
21
40
|
|
|
22
|
-
If a page does not
|
|
23
|
-
`npx copilotkit@4.
|
|
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`.
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
# Configure
|
|
1
|
+
# Configure Strands Agents TypeScript
|
|
2
2
|
|
|
3
|
-
Preserve an existing
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
Preserve an existing Strands 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`.
|
|
6
8
|
|
|
7
9
|
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
8
10
|
store, or request a secret value.
|
|
@@ -12,12 +14,29 @@ store, or request a secret value.
|
|
|
12
14
|
- https://docs.copilotkit.ai/strands-typescript/quickstart.md
|
|
13
15
|
- https://docs.copilotkit.ai/strands-typescript/inspector.md
|
|
14
16
|
- https://docs.copilotkit.ai/strands-typescript/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/strands-typescript/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 `strands-typescript`. Use only the TypeScript examples from
|
|
22
|
+
these pages. Install `@modelcontextprotocol/sdk` as a runtime dependency.
|
|
23
|
+
`@strands-agents/sdk` loads it even when the application does not use MCP.
|
|
24
|
+
|
|
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,
|
|
28
|
+
run the unsupported route below.
|
|
29
|
+
|
|
30
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
31
|
+
URLs, and both documentation gaps. Do not use remembered CopilotKit instructions.
|
|
15
32
|
|
|
16
|
-
|
|
17
|
-
|
|
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.
|
|
18
37
|
|
|
19
38
|
If the pages support the selection, run
|
|
20
|
-
`npx copilotkit@4.
|
|
39
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
21
40
|
|
|
22
|
-
If a page does not
|
|
23
|
-
`npx copilotkit@4.
|
|
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`.
|
|
@@ -7,12 +7,27 @@ Preserve an existing Angular frontend. Use the selected page for a new frontend.
|
|
|
7
7
|
- Credentials and plan: `Not applicable`
|
|
8
8
|
- Implementation and validation: https://docs.copilotkit.ai/angular.md
|
|
9
9
|
- Proof: https://docs.copilotkit.ai/angular.md
|
|
10
|
+
- Frontend context: https://docs.copilotkit.ai/reference/angular/directives/CopilotKitAgentContext.md
|
|
10
11
|
|
|
11
|
-
Fetch
|
|
12
|
-
|
|
12
|
+
Fetch both selected documentation pages in one step rather than one after another.
|
|
13
|
+
Record Angular as the selected frontend and keep these URLs. Do not use remembered
|
|
14
|
+
CopilotKit instructions.
|
|
15
|
+
|
|
16
|
+
Take the frontend-context step from the directive page. The agent-framework page shows
|
|
17
|
+
the React hook, and Angular shares the same context through this directive instead.
|
|
18
|
+
|
|
19
|
+
Angular CLI 22 requires Node `^22.22.3 || ^24.15.0 || >=26`. Check the Node version before
|
|
20
|
+
you create or build an Angular project. If the installed version is lower, select a
|
|
21
|
+
supported version first and use it for every later command in this project.
|
|
22
|
+
|
|
23
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
24
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
25
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
26
|
+
unavailable only after a second method also fails.
|
|
13
27
|
|
|
14
28
|
If the page supports the selection, run
|
|
15
|
-
`npx copilotkit@4.
|
|
29
|
+
`npx --yes copilotkit@4.9.0 onboard read credentials/finalize-plan`.
|
|
16
30
|
|
|
17
|
-
If the page does not
|
|
18
|
-
|
|
31
|
+
If a second method also fails, or the page that loads does not support the selection,
|
|
32
|
+
run
|
|
33
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -11,8 +11,18 @@ Preserve an existing Next.js frontend. Use the selected pages for a new frontend
|
|
|
11
11
|
Fetch each selected documentation URL. Record Next.js as the selected frontend and keep
|
|
12
12
|
these URLs. Do not use remembered CopilotKit instructions.
|
|
13
13
|
|
|
14
|
+
Take the frontend scaffolding from this page. Take the runtime agent wiring from the
|
|
15
|
+
agent framework documentation instead. This page configures the CopilotKit built-in
|
|
16
|
+
agent as the default agent, which is correct only for a project that has no agent.
|
|
17
|
+
Do not replace the developer's existing agent with the built-in agent.
|
|
18
|
+
|
|
19
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
20
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
21
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
22
|
+
unavailable only after a second method also fails.
|
|
23
|
+
|
|
14
24
|
If the pages support the selection, run
|
|
15
|
-
`npx copilotkit@4.
|
|
25
|
+
`npx --yes copilotkit@4.9.0 onboard read credentials/finalize-plan`.
|
|
16
26
|
|
|
17
|
-
If a page does not
|
|
18
|
-
`npx copilotkit@4.
|
|
27
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
28
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -3,30 +3,31 @@
|
|
|
3
3
|
Use the repository findings to select the frontend. Ask the developer only for choices
|
|
4
4
|
that the repository does not show. Do not change application code in this phase.
|
|
5
5
|
|
|
6
|
-
If the project has a frontend, preserve it
|
|
7
|
-
needs a frontend, show the valid choices
|
|
6
|
+
If the project has a frontend, preserve it and use the matching route below. If the project
|
|
7
|
+
needs a frontend, show the valid choices and one recommendation based on repository
|
|
8
|
+
evidence, then ask the developer to choose.
|
|
8
9
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
| `empty` | React SPA, Next.js, Angular, Vue 3, React Native, Slack, or Teams |
|
|
12
|
-
| `agent-only` | React SPA, Next.js, Angular, Vue 3, React Native, Slack, or Teams |
|
|
13
|
-
| `frontend-only` | React SPA, Next.js, Angular, Vue 3, or React Native |
|
|
14
|
-
| `both` | React SPA, Next.js, Angular, Vue 3, or React Native |
|
|
10
|
+
The valid choices are React SPA, Next.js, Angular, Vue 3, and React Native. They are valid
|
|
11
|
+
in every starting state. Do not show the internal route.
|
|
15
12
|
|
|
16
|
-
|
|
13
|
+
Recommend the frontend the project already uses. Where there is no existing frontend,
|
|
14
|
+
recommend the one the developer names, and say what each choice implies for where the
|
|
15
|
+
CopilotKit runtime lives: Next.js hosts it in a route handler, Angular in its SSR
|
|
16
|
+
server, and Vue 3, React SPA and React Native reach a runtime that runs as its own
|
|
17
|
+
process.
|
|
17
18
|
|
|
18
|
-
|
|
19
|
-
|
|
19
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
20
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
21
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
22
|
+
unavailable only after a second method also fails.
|
|
20
23
|
|
|
21
24
|
Use exactly one matching internal route:
|
|
22
25
|
|
|
23
|
-
1. React SPA: `npx copilotkit@4.
|
|
24
|
-
2. Next.js: `npx copilotkit@4.
|
|
25
|
-
3. Angular: `npx copilotkit@4.
|
|
26
|
-
4. Vue 3: `npx copilotkit@4.
|
|
27
|
-
5. React Native: `npx copilotkit@4.
|
|
28
|
-
6. Slack: `npx copilotkit@4.8.3 onboard read frontend/slack`
|
|
29
|
-
7. Microsoft Teams: `npx copilotkit@4.8.3 onboard read frontend/teams`
|
|
26
|
+
1. React SPA: `npx --yes copilotkit@4.9.0 onboard read frontend/react-spa`
|
|
27
|
+
2. Next.js: `npx --yes copilotkit@4.9.0 onboard read frontend/nextjs`
|
|
28
|
+
3. Angular: `npx --yes copilotkit@4.9.0 onboard read frontend/angular`
|
|
29
|
+
4. Vue 3: `npx --yes copilotkit@4.9.0 onboard read frontend/vue`
|
|
30
|
+
5. React Native: `npx --yes copilotkit@4.9.0 onboard read frontend/react-native`
|
|
30
31
|
|
|
31
32
|
If no listed frontend fits, run
|
|
32
|
-
`npx copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -11,8 +11,14 @@ Preserve an existing React Native frontend. Use the selected page for a new fron
|
|
|
11
11
|
Fetch the selected documentation page. Record React Native as the selected frontend and
|
|
12
12
|
keep this URL. Do not use remembered CopilotKit instructions.
|
|
13
13
|
|
|
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.
|
|
18
|
+
|
|
14
19
|
If the page supports the selection, run
|
|
15
|
-
`npx copilotkit@4.
|
|
20
|
+
`npx --yes copilotkit@4.9.0 onboard read credentials/finalize-plan`.
|
|
16
21
|
|
|
17
|
-
If the page does not
|
|
18
|
-
|
|
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.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,12 +1,27 @@
|
|
|
1
1
|
# Configure React SPA
|
|
2
2
|
|
|
3
|
-
Preserve an existing React SPA.
|
|
4
|
-
|
|
3
|
+
Preserve an existing React SPA. Use the selected page for a new frontend.
|
|
4
|
+
|
|
5
|
+
A React SPA has no server of its own, so the CopilotKit runtime is a separate process
|
|
6
|
+
rather than a route inside the app. Do not add a runtime route to the SPA build, and do
|
|
7
|
+
not move the agent into it.
|
|
5
8
|
|
|
6
9
|
## Documentation
|
|
7
10
|
|
|
8
11
|
- Credentials and plan: `Not applicable`
|
|
9
|
-
- Implementation and validation:
|
|
10
|
-
- Proof:
|
|
12
|
+
- Implementation and validation: https://docs.copilotkit.ai/react-spa.md
|
|
13
|
+
- Proof: https://docs.copilotkit.ai/react-spa.md
|
|
14
|
+
|
|
15
|
+
Fetch the selected documentation page. Record React SPA as the selected frontend and
|
|
16
|
+
keep this URL. Do not use remembered CopilotKit instructions.
|
|
17
|
+
|
|
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.0 onboard read credentials/finalize-plan`.
|
|
11
25
|
|
|
12
|
-
|
|
26
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
27
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -11,8 +11,14 @@ Preserve an existing Vue 3 frontend. Use the selected page for a new frontend.
|
|
|
11
11
|
Fetch the selected documentation page. Record Vue 3 as the selected frontend and keep
|
|
12
12
|
this URL. Do not use remembered CopilotKit instructions.
|
|
13
13
|
|
|
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.
|
|
18
|
+
|
|
14
19
|
If the page supports the selection, run
|
|
15
|
-
`npx copilotkit@4.
|
|
20
|
+
`npx --yes copilotkit@4.9.0 onboard read credentials/finalize-plan`.
|
|
16
21
|
|
|
17
|
-
If the page does not
|
|
18
|
-
|
|
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.0 onboard read unsupported/no-validated-path`.
|