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.
Files changed (47) hide show
  1. package/README.md +183 -2
  2. package/cli-build-info.json +7 -7
  3. package/index.js +5645 -3567
  4. package/onboarding/index.json +33 -33
  5. package/onboarding/prompts/authenticate/start.md +63 -10
  6. package/onboarding/prompts/credentials/finalize-plan.md +168 -15
  7. package/onboarding/prompts/credentials/plan.md +55 -49
  8. package/onboarding/prompts/fallback/best-effort.md +29 -0
  9. package/onboarding/prompts/framework/ag2.md +33 -7
  10. package/onboarding/prompts/framework/agno.md +32 -7
  11. package/onboarding/prompts/framework/built-in.md +30 -8
  12. package/onboarding/prompts/framework/claude-sdk-python.md +35 -7
  13. package/onboarding/prompts/framework/claude-sdk-typescript.md +39 -7
  14. package/onboarding/prompts/framework/crewai-flows.md +41 -7
  15. package/onboarding/prompts/framework/deep-agents.md +30 -6
  16. package/onboarding/prompts/framework/google-adk.md +32 -8
  17. package/onboarding/prompts/framework/langgraph-fastapi.md +24 -5
  18. package/onboarding/prompts/framework/langgraph-python.md +15 -5
  19. package/onboarding/prompts/framework/langgraph-typescript.md +15 -5
  20. package/onboarding/prompts/framework/llamaindex.md +35 -7
  21. package/onboarding/prompts/framework/mastra.md +48 -6
  22. package/onboarding/prompts/framework/ms-agent-dotnet.md +57 -7
  23. package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +48 -8
  24. package/onboarding/prompts/framework/ms-agent-python.md +32 -7
  25. package/onboarding/prompts/framework/pydantic-ai.md +34 -9
  26. package/onboarding/prompts/framework/strands-python.md +28 -9
  27. package/onboarding/prompts/framework/strands-typescript.md +28 -9
  28. package/onboarding/prompts/frontend/angular.md +20 -5
  29. package/onboarding/prompts/frontend/nextjs.md +13 -3
  30. package/onboarding/prompts/frontend/plan.md +20 -19
  31. package/onboarding/prompts/frontend/react-native.md +9 -3
  32. package/onboarding/prompts/frontend/react-spa.md +20 -5
  33. package/onboarding/prompts/frontend/vue.md +9 -3
  34. package/onboarding/prompts/implementation/build-and-validate.md +82 -7
  35. package/onboarding/prompts/proof/complete.md +63 -2
  36. package/onboarding/prompts/proof/oss-baseline.md +59 -0
  37. package/onboarding/prompts/proof/round-trip.md +150 -8
  38. package/onboarding/prompts/subagent/create-plan.md +69 -2
  39. package/onboarding/prompts/subagent/implement-and-validate.md +48 -3
  40. package/onboarding/prompts/subagent/inspect-repository.md +13 -3
  41. package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
  42. package/onboarding/prompts/subagent/prove-round-trip.md +118 -11
  43. package/onboarding/prompts/unsupported/no-validated-path.md +27 -9
  44. package/package.json +1 -1
  45. package/release/release-tool.js +32 -4
  46. package/onboarding/prompts/frontend/slack.md +0 -20
  47. package/onboarding/prompts/frontend/teams.md +0 -20
@@ -1,8 +1,10 @@
1
1
  # Configure Agno
2
2
 
3
3
  Preserve an existing Agno model setup. Start with OpenAI for a new agent. Offer another
4
- vendor only after the selected CopilotKit Markdown pages document it. The pages must name
5
- its credential variables and setup steps.
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,35 @@ store, or request a secret value.
12
14
  - https://docs.copilotkit.ai/agno/quickstart.md
13
15
  - https://docs.copilotkit.ai/agno/inspector.md
14
16
  - https://docs.copilotkit.ai/agno/generative-ui/a2ui/fixed-schema.md
17
+ - https://docs.copilotkit.ai/agno/shared-state/agent-readonly.md
18
+
19
+ Fetch all four pages in one step rather than one after another.
20
+
21
+ The documentation scope is `agno`. Use only the Python agent examples from these pages.
22
+ When the repository already has an Agno agent, use the quickstart's
23
+ `Use an existing agent` path. Use `Start from scratch` only when the repository needs a
24
+ new agent. For a new agent, install the documented Python dependencies
25
+ `agno fastapi uvicorn openai ag-ui-protocol`. Preserve an existing `AgentOS` with the
26
+ `AGUI` interface and its endpoint. In the documented runtime, `AgnoAgent` from
27
+ `@ag-ui/agno` targets `/agui`. Do not replace that adapter with a generic agent or change
28
+ the endpoint without repository evidence.
29
+
30
+ The fixed-schema page has no Agno backend schema-loading, render-operations, or runtime
31
+ setup snippet. The agent-readonly page does not bundle its Agno backend context setup.
32
+ Do not invent either missing backend setup. If the requested work needs one of those
33
+ setups and the project does not already have it, run the unsupported route below.
34
+
35
+ Record the selected framework, vendor, model, required credential variable names, these
36
+ URLs, the documented dependencies and adapter, and both documentation gaps. Do not use
37
+ remembered CopilotKit instructions.
15
38
 
16
- Fetch all three pages. Record the selected framework, vendor, model, required credential
17
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
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.8.3 onboard read frontend/plan`.
45
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
21
46
 
22
- If a page does not load or support the selection, run
23
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
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,21 +1,43 @@
1
- # Configure CopilotKit built-in agent
1
+ # Configure the built-in CopilotKit agent
2
2
 
3
- Preserve an existing built-in agent and its model setup. For a new agent, follow the setup page. Ask the developer to choose the documented model vendor and model. Record the required credential variable names.
3
+ Preserve an existing built-in agent model setup. Start with OpenAI for a new agent. Offer
4
+ another vendor only after an exact CopilotKit Markdown page names it. The page must name
5
+ its credential variables and setup steps.
6
+
7
+ Name the default model credential `OPENAI_API_KEY`.
4
8
 
5
9
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
6
10
  store, or request a secret value.
7
11
 
12
+ The built-in agent runs in the CopilotKit Runtime process.
13
+ Do not create or start a separate agent server.
14
+ Keep the agent, model choice, tools, and runtime endpoint in the project's existing
15
+ runtime setup.
16
+
8
17
  ## Documentation
9
18
 
19
+ - https://docs.copilotkit.ai/built-in-agent.md
10
20
  - https://docs.copilotkit.ai/quickstart.md
11
21
  - https://docs.copilotkit.ai/inspector.md
12
- - https://docs.copilotkit.ai/generative-ui/a2ui/fixed-schema.md
22
+ - https://docs.copilotkit.ai/agent-app-context.md
23
+ - https://docs.copilotkit.ai/model-selection.md
24
+ - https://docs.copilotkit.ai/generative-ui/tool-based.md
25
+
26
+ Fetch all six pages in one step rather than one after another.
27
+
28
+ These pages use the root documentation scope. Do not add a framework path segment to
29
+ their URLs. Use the tool-based generative UI page for this built-in route.
30
+
31
+ Record the selected framework, vendor, model, required credential variable names, and
32
+ these URLs. Do not use remembered CopilotKit instructions.
13
33
 
14
- Fetch all three pages. Record the selected framework, vendor, model, required credential
15
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
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.
16
38
 
17
39
  If the pages support the selection, run
18
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
40
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
19
41
 
20
- If a page does not load or support the selection, run
21
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
42
+ If a second method also fails, or a page that loads does not support the selection, run
43
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,6 +1,11 @@
1
- # Configure Claude Agent SDK Python
1
+ # Configure Claude Agent SDK for Python
2
2
 
3
- Preserve an existing Claude Agent SDK Python setup. This onboarding path supports Anthropic only. Ask the developer to choose the Anthropic model. Record the required credential variable names.
3
+ Preserve an existing Claude Agent SDK model setup. Start with Anthropic for a new agent.
4
+ Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
5
+ name its credential variables and setup steps.
6
+
7
+ Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
8
+ `ANTHROPIC_MODEL`.
4
9
 
5
10
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
6
11
  store, or request a secret value.
@@ -10,12 +15,35 @@ store, or request a secret value.
10
15
  - https://docs.copilotkit.ai/claude-sdk-python/quickstart.md
11
16
  - https://docs.copilotkit.ai/claude-sdk-python/inspector.md
12
17
  - https://docs.copilotkit.ai/claude-sdk-python/generative-ui/a2ui/fixed-schema.md
18
+ - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
19
+
20
+ Fetch all four pages in one step rather than one after another.
21
+
22
+ The documentation scope is `claude-sdk-python`. For an existing agent, install the exact
23
+ documented backend set with
24
+ `uv add claude-agent-sdk ag-ui-claude-sdk ag-ui-protocol anthropic fastapi uvicorn python-dotenv`.
25
+ Expose the agent through FastAPI and use `ClaudeAgentAdapter` from `ag_ui_claude_sdk`.
26
+ Keep one long-lived adapter at module scope. Register the remote endpoint in Copilot Runtime
27
+ with `HttpAgent`. Do not replace this transport with a different Claude or AG-UI adapter.
28
+
29
+ For fixed-schema A2UI, keep the tool in the agent. Set `injectA2UITool` to `false` in the
30
+ runtime. The documented Python setup does not support `action_handlers` on
31
+ `a2ui.render`. Do not add them or claim that the fixed-schema button callback works.
32
+
33
+ No Claude Agent SDK Python agent-app-context Markdown page is available. The reference
34
+ page above documents the frontend hook only. Do not invent the missing agent-side context
35
+ setup. If the requested work needs that setup, run the unsupported route below.
36
+
37
+ Record the selected framework, vendor, model, required credential variable names, these
38
+ URLs, and the context and A2UI limits. Do not use remembered CopilotKit instructions.
13
39
 
14
- Fetch all three pages. Record the selected framework, vendor, model, required credential
15
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
40
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
41
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
42
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
43
+ unavailable only after a second method also fails.
16
44
 
17
45
  If the pages support the selection, run
18
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
46
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
19
47
 
20
- If a page does not load or support the selection, run
21
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
48
+ If a second method also fails, or a page that loads does not support the selection, run
49
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,6 +1,11 @@
1
- # Configure Claude Agent SDK TypeScript
1
+ # Configure Claude Agent SDK for TypeScript
2
2
 
3
- Preserve an existing Claude Agent SDK TypeScript setup. This onboarding path supports Anthropic only. Ask the developer to choose the Anthropic model. Record the required credential variable names.
3
+ Preserve an existing Claude Agent SDK model setup. Start with Anthropic for a new agent.
4
+ Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
5
+ name its credential variables and setup steps.
6
+
7
+ Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
8
+ `CLAUDE_MODEL`.
4
9
 
5
10
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
6
11
  store, or request a secret value.
@@ -10,12 +15,39 @@ store, or request a secret value.
10
15
  - https://docs.copilotkit.ai/claude-sdk-typescript/quickstart.md
11
16
  - https://docs.copilotkit.ai/claude-sdk-typescript/inspector.md
12
17
  - https://docs.copilotkit.ai/claude-sdk-typescript/generative-ui/a2ui/fixed-schema.md
18
+ - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
19
+
20
+ Fetch all four pages in one step rather than one after another.
21
+
22
+ The documentation scope is `claude-sdk-typescript`. For an existing agent, install the
23
+ documented packages, including `@anthropic-ai/claude-agent-sdk@^0.2.58`,
24
+ `@anthropic-ai/sdk`, `@ag-ui/claude-agent-sdk`, `@ag-ui/core`, `@ag-ui/encoder`,
25
+ `express`, `dotenv`, and `zod`. Keep the Express AG-UI endpoint. Use
26
+ `ClaudeAgentAdapter` from `@ag-ui/claude-agent-sdk` in that endpoint and `HttpAgent` in
27
+ Copilot Runtime. Do not replace either adapter.
28
+
29
+ For fixed-schema A2UI, expose the backend tool through the in-process Claude SDK MCP
30
+ server. Set `injectA2UITool` to `false` so the agent-owned tool is the only A2UI tool.
31
+ The Claude Agent SDK adapter does not bridge CopilotKit frontend or runtime tools through
32
+ AG-UI. If the requested path needs those tools, run the unsupported route below. Do not
33
+ replace the Claude Agent SDK with the direct Anthropic Messages API fallback.
34
+
35
+ The adapter appends AG-UI `input.context` entries to the Claude system prompt. Pair that
36
+ backend path with the frontend hook from the reference page. Treat this as read-only app
37
+ context. It does not provide an agent-to-frontend write-back path. Inspect the installed,
38
+ pinned adapter source before using this path. If the package no longer handles
39
+ `input.context`, run the unsupported route below.
40
+
41
+ Record the selected framework, vendor, model, required credential variable names, these
42
+ URLs, and the adapter and context limits. Do not use remembered CopilotKit instructions.
13
43
 
14
- Fetch all three pages. Record the selected framework, vendor, model, required credential
15
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
44
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
45
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
46
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
47
+ unavailable only after a second method also fails.
16
48
 
17
49
  If the pages support the selection, run
18
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
50
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
19
51
 
20
- If a page does not load or support the selection, run
21
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
52
+ If a second method also fails, or a page that loads does not support the selection, run
53
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,7 +1,9 @@
1
1
  # Configure CrewAI Flows
2
2
 
3
- If the repository uses a CrewAI Enterprise agent, preserve CrewAI Flows. Do not recommend
4
- it for a new agent. Preserve its remote model setup. Record its credential variable names.
3
+ Preserve the project's existing CrewAI Flow, model, and deployment. The selected pages do
4
+ not name a default model vendor or model credential variable. Do not choose a vendor or
5
+ credential name for the developer. Ask only for a choice that the repository does not
6
+ show and the documentation supports.
5
7
 
6
8
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
7
9
  store, or request a secret value.
@@ -11,12 +13,44 @@ store, or request a secret value.
11
13
  - https://docs.copilotkit.ai/crewai-crews/quickstart.md
12
14
  - https://docs.copilotkit.ai/crewai-crews/inspector.md
13
15
  - https://docs.copilotkit.ai/crewai-crews/generative-ui/a2ui/fixed-schema.md
16
+ - https://docs.copilotkit.ai/crewai-crews/shared-state/in-app-agent-read.md
14
17
 
15
- Fetch all three pages. Record the selected framework, vendor, model, required credential
16
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
18
+ Fetch all four pages in one step rather than one after another.
19
+
20
+ The public onboarding route ID is `crewai-flows`. The canonical documentation scope is
21
+ `crewai-crews`. The quickstart and feature pages also contain older `/crewai-flows/`
22
+ links. Use the canonical Markdown URLs above and keep the project's CrewAI Flow name.
23
+
24
+ The quickstart offers `Use the CopilotKit CLI (NextJS only)` and `Code along`. It assumes
25
+ an existing Flow. Preserve the vendor, model, and credential variable that the project
26
+ already uses. The new quickstart example uses GitHub Models. An existing OpenAI Flow can
27
+ keep OpenAI and `OPENAI_API_KEY`. Do not change vendors to match the example.
28
+
29
+ The current Python base adapter is `ag-ui-crewai==0.3.0`. Add the endpoint to the
30
+ project's FastAPI app with
31
+ `add_crewai_flow_fastapi_endpoint(app, ExistingFlow(), "/chat")`. Keep the existing Flow
32
+ and its regular, non-conversational mode. Use the generic `HttpAgent` for the `/chat`
33
+ endpoint. Do not invent a `CrewAIAgent` runtime class.
34
+
35
+ The fixed-schema page extends this base adapter. Keep the fixed-schema tool on the CrewAI
36
+ Flow path, call `copilotkit_emit_tool_result`, and set `injectA2UITool: false` in the
37
+ runtime catalog. Do not replace the existing Flow with a Crew, Agent, or Task graph.
38
+
39
+ The shared-state page is not an agent-app-context guide. Do not use it to invent a
40
+ `useAgentContext` backend setup. If the requested work needs app context rather than the
41
+ documented shared-state path, run the unsupported route below.
42
+
43
+ Record the selected framework, project-defined vendor and model, repository-proven
44
+ credential variable names, these URLs, the adapter, and both documentation limits. Do not
45
+ use remembered CopilotKit instructions.
46
+
47
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
48
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
49
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
50
+ unavailable only after a second method also fails.
17
51
 
18
52
  If the pages support the selection, run
19
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
53
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
20
54
 
21
- If a page does not load or support the selection, run
22
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
55
+ If a second method also fails, or a page that loads does not support the selection, run
56
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,6 +1,10 @@
1
1
  # Configure Deep Agents
2
2
 
3
- Preserve an existing Deep Agents setup. Ask the developer to confirm its model vendor and model. Use the documented default for a new setup. Record the required credential variable names.
3
+ Preserve an existing Deep Agents language and model setup. Start with OpenAI for a new
4
+ agent. Offer another vendor only after an exact CopilotKit Markdown page names it. The
5
+ page must name its credential variables and setup steps.
6
+
7
+ Name the default model credential `OPENAI_API_KEY`.
4
8
 
5
9
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
6
10
  store, or request a secret value.
@@ -10,12 +14,32 @@ store, or request a secret value.
10
14
  - https://docs.copilotkit.ai/deepagents/quickstart.md
11
15
  - https://docs.copilotkit.ai/deepagents/inspector.md
12
16
  - https://docs.copilotkit.ai/deepagents/generative-ui/a2ui/fixed-schema.md
17
+ - https://docs.copilotkit.ai/deepagents/shared-state/agent-readonly.md
18
+
19
+ Fetch all four pages in one step rather than one after another.
20
+
21
+ The documentation scope is `deepagents`. Do not use `deep-agents` in a documentation URL.
22
+ The quickstart has Python and TypeScript tabs. Preserve the project's current language.
23
+ Preserve the project's existing deployment path. Choose the same `Deep Agent` or
24
+ `FastAPI` tab in both the quickstart and runtime setup. Do not change a Deep Agent
25
+ deployment to FastAPI or a FastAPI deployment to Deep Agent.
26
+
27
+ The fixed-schema A2UI backend example is Python-only. No Deep Agents agent-app-context
28
+ Markdown page is available. Do not invent a TypeScript A2UI backend or an
29
+ agent-app-context setup. If the requested work needs either missing setup, run the
30
+ unsupported route below.
31
+
32
+ Record the selected framework, language, vendor, model, required credential variable
33
+ names, these URLs, and each documentation gap. Do not use remembered CopilotKit
34
+ instructions.
13
35
 
14
- Fetch all three pages. Record the selected framework, vendor, model, required credential
15
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
36
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
37
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
38
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
39
+ unavailable only after a second method also fails.
16
40
 
17
41
  If the pages support the selection, run
18
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
42
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
19
43
 
20
- If a page does not load or support the selection, run
21
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
44
+ If a second method also fails, or a page that loads does not support the selection, run
45
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,7 +1,12 @@
1
- # Configure Google ADK
1
+ # Configure ADK
2
2
 
3
- Preserve an existing Google ADK model setup. Start with Google Gemini for a new agent.
4
- Offer another model only after the selected CopilotKit Markdown pages document its setup.
3
+ Preserve an existing ADK model setup. Start with Google 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 model credential `GOOGLE_API_KEY`. This framework accepts more than one
8
+ spelling, and a scaffold that reaches for a different one looks finished and reads no
9
+ key.
5
10
 
6
11
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
7
12
  store, or request a secret value.
@@ -11,12 +16,31 @@ store, or request a secret value.
11
16
  - https://docs.copilotkit.ai/google-adk/quickstart.md
12
17
  - https://docs.copilotkit.ai/google-adk/inspector.md
13
18
  - https://docs.copilotkit.ai/google-adk/generative-ui/a2ui/fixed-schema.md
19
+ - https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
20
+
21
+ Fetch all four pages in one step rather than one after another. Sequential fetching
22
+ cost about nine minutes of the first proven journey.
23
+
24
+ The documentation scope is `google-adk`. A `/adk/` URL answers with a redirect stub
25
+ whose body is the canonical path, so fetch the `google-adk` form.
26
+
27
+ No page documents the Google ADK side of frontend context. The reference page above
28
+ names the frontend hook, and the agent side of the step is undocumented here. Record
29
+ that missing page as a documentation gap. Do not read the built-in-agent context page
30
+ in its place: that page states no backend work is needed, which holds for the built-in
31
+ agent and not for ADK.
32
+
33
+ Record the selected framework, vendor, model, required credential variable names, and
34
+ these URLs.
35
+ Do not use remembered CopilotKit instructions.
14
36
 
15
- Fetch all three pages. Record the selected framework, vendor, model, required credential
16
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
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.
17
41
 
18
42
  If the pages support the selection, run
19
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
43
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
20
44
 
21
- If a page does not load or support the selection, run
22
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
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`.
@@ -12,12 +12,31 @@ store, or request a secret value.
12
12
  - https://docs.copilotkit.ai/langgraph-fastapi/quickstart.md
13
13
  - https://docs.copilotkit.ai/langgraph-fastapi/inspector.md
14
14
  - https://docs.copilotkit.ai/langgraph-fastapi/generative-ui/a2ui/fixed-schema.md
15
+ - https://docs.copilotkit.ai/langgraph-fastapi/agent-app-context.md
15
16
 
16
- Fetch all three pages. Record the selected framework, vendor, model, required credential
17
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
17
+ Fetch all four pages in one step rather than one after another. Sequential fetching
18
+ cost about nine minutes of the first proven journey.
19
+
20
+ Read the FastAPI tab of the quickstart.
21
+ Preserve an existing FastAPI transport and its persistence.
22
+ The FastAPI graph must have a checkpointer.
23
+ Keep the existing checkpointer. For a new local agent, use `MemorySaver` only for
24
+ development.
25
+ Use `add_langgraph_fastapi_endpoint` for the FastAPI agent endpoint.
26
+ Use `LangGraphHttpAgent` in the Copilot Runtime.
27
+ Do not copy the LangSmith path, its no-checkpointer rule, or its `LangGraphAgent` adapter.
28
+
29
+ Record the selected framework, vendor, model, required credential variable names, and
30
+ these URLs.
31
+ Do not use remembered CopilotKit instructions.
32
+
33
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
34
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
35
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
36
+ unavailable only after a second method also fails.
18
37
 
19
38
  If the pages support the selection, run
20
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
39
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
21
40
 
22
- If a page does not load or support the selection, run
23
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
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`.
@@ -12,12 +12,22 @@ store, or request a secret value.
12
12
  - https://docs.copilotkit.ai/langgraph-python/quickstart.md
13
13
  - https://docs.copilotkit.ai/langgraph-python/inspector.md
14
14
  - https://docs.copilotkit.ai/langgraph-python/generative-ui/a2ui/fixed-schema.md
15
+ - https://docs.copilotkit.ai/langgraph-python/agent-app-context.md
15
16
 
16
- Fetch all three pages. Record the selected framework, vendor, model, required credential
17
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
17
+ Fetch all four pages in one step rather than one after another. Sequential fetching
18
+ cost about nine minutes of the first proven journey.
19
+
20
+ Record the selected framework, vendor, model, required credential variable names, and
21
+ these URLs.
22
+ Do not use remembered CopilotKit instructions.
23
+
24
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
25
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
26
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
27
+ unavailable only after a second method also fails.
18
28
 
19
29
  If the pages support the selection, run
20
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
30
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
21
31
 
22
- If a page does not load or support the selection, run
23
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
32
+ If a second method also fails, or a page that loads does not support the selection, run
33
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -12,12 +12,22 @@ store, or request a secret value.
12
12
  - https://docs.copilotkit.ai/langgraph-typescript/quickstart.md
13
13
  - https://docs.copilotkit.ai/langgraph-typescript/inspector.md
14
14
  - https://docs.copilotkit.ai/langgraph-typescript/generative-ui/a2ui/fixed-schema.md
15
+ - https://docs.copilotkit.ai/langgraph-typescript/agent-app-context.md
15
16
 
16
- Fetch all three pages. Record the selected framework, vendor, model, required credential
17
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
17
+ Fetch all four pages in one step rather than one after another. Sequential fetching
18
+ cost about nine minutes of the first proven journey.
19
+
20
+ Record the selected framework, vendor, model, required credential variable names, and
21
+ these URLs.
22
+ Do not use remembered CopilotKit instructions.
23
+
24
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
25
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
26
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
27
+ unavailable only after a second method also fails.
18
28
 
19
29
  If the pages support the selection, run
20
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
30
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
21
31
 
22
- If a page does not load or support the selection, run
23
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
32
+ If a second method also fails, or a page that loads does not support the selection, run
33
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,10 @@
1
1
  # Configure LlamaIndex
2
2
 
3
3
  Preserve an existing LlamaIndex model setup. Start with OpenAI for a new agent. Offer
4
- another vendor only after the selected CopilotKit Markdown pages document it. The pages must
5
- name its credential variables and setup steps.
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,38 @@ store, or request a secret value.
12
14
  - https://docs.copilotkit.ai/llamaindex/quickstart.md
13
15
  - https://docs.copilotkit.ai/llamaindex/inspector.md
14
16
  - https://docs.copilotkit.ai/llamaindex/generative-ui/a2ui/fixed-schema.md
17
+ - https://docs.copilotkit.ai/llamaindex/shared-state/in-app-agent-read.md
18
+
19
+ Fetch all four pages in one step rather than one after another.
20
+
21
+ The documentation scope is `llamaindex`. Use only the Python agent examples from these
22
+ pages. When the repository already has a LlamaIndex agent, use the quickstart's
23
+ `Use an existing agent` path. Use `Start from scratch` only when the repository needs a
24
+ new agent. For a new agent, install the documented Python dependencies
25
+ `llama-index llama-index-llms-openai llama-index-protocols-ag-ui fastapi uvicorn`.
26
+ Preserve the existing `get_ag_ui_workflow_router` and its FastAPI router. In the
27
+ documented runtime, `LlamaIndexAgent` from `@ag-ui/llamaindex` targets `/run`. Do not
28
+ replace that adapter or change its route without repository evidence.
29
+
30
+ The fixed-schema page includes LlamaIndex backend code but does not bundle its runtime
31
+ setup. Use it only when the project already has the working quickstart runtime that the
32
+ page extends. Do not invent a replacement runtime setup.
33
+
34
+ The shared-state page is not an agent-app-context guide. Do not use it to invent a
35
+ `useAgentContext` backend setup. If the requested work needs app context rather than the
36
+ documented shared-state path, run the unsupported route below.
37
+
38
+ Record the selected framework, vendor, model, required credential variable names, these
39
+ URLs, the documented dependencies and adapter, and both documentation limits. Do not use
40
+ remembered CopilotKit instructions.
15
41
 
16
- Fetch all three pages. Record the selected framework, vendor, model, required credential
17
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
42
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
43
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
44
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
45
+ unavailable only after a second method also fails.
18
46
 
19
47
  If the pages support the selection, run
20
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
48
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
21
49
 
22
- If a page does not load or support the selection, run
23
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
50
+ If a second method also fails, or a page that loads does not support the selection, run
51
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
@@ -1,21 +1,63 @@
1
1
  # Configure Mastra
2
2
 
3
- Preserve an existing Mastra model setup. Start with OpenAI for a new agent. Before offering another vendor, an exact CopilotKit Markdown page must name the vendor, credential variables, and setup steps.
3
+ Preserve an existing Mastra 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 model credential `OPENAI_API_KEY`.
4
8
 
5
9
  Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
6
10
  store, or request a secret value.
7
11
 
12
+ `mastra dev` loads the `.env` beside the project it serves and does not look in a
13
+ parent directory. When one credential file serves more than one part of the repository,
14
+ name the path in the dev script as `mastra dev --env <path>` rather than relying on a
15
+ search.
16
+
17
+ The dev server serves port 4111 and puts a web console at `/` on that same port. A
18
+ request to `/` answers 200 with HTML whether or not an agent exists, so read
19
+ `/api/agents` to confirm which agent is served.
20
+
21
+ That console runs any agent the Mastra instance registers, with that agent's full
22
+ tool set, and the API behind it takes
23
+ `POST /api/agents/{agentId}/tools/{toolId}/execute`, which invokes one tool with no
24
+ model and no credential. Neither surface asks for authentication. Tool gating done
25
+ at the CopilotKit runtime governs the runtime's route and does not reach this port.
26
+ Where the project restricts which tools reach a browser, say in the summary that
27
+ the agent port is a second, ungated entrance to the same tools.
28
+
29
+ The dev server binds every interface unless it is told not to, while the banner it
30
+ prints, the `.mastra/dev.lock` it writes and the framework's own documentation all
31
+ say `localhost`. Bind it to loopback: `MASTRA_HOST=127.0.0.1` on the dev command
32
+ when the agent is the developer's existing code, or `server: { host: '127.0.0.1' }`
33
+ on a Mastra instance this run creates. Declare a `server.port` beside it only if
34
+ the run does not also rely on `PORT`, which it overrides.
35
+
36
+ If the project already runs the agent as its own service, reach it where it runs. The
37
+ quickstart shows the agent inside the frontend, and moving a running agent there deletes
38
+ what the developer had.
39
+
8
40
  ## Documentation
9
41
 
10
42
  - https://docs.copilotkit.ai/mastra/quickstart.md
11
43
  - https://docs.copilotkit.ai/mastra/inspector.md
12
44
  - https://docs.copilotkit.ai/mastra/generative-ui/a2ui/fixed-schema.md
45
+ - https://docs.copilotkit.ai/mastra/agent-app-context.md
46
+
47
+ Fetch all four pages in one step rather than one after another. Sequential fetching
48
+ cost about nine minutes of the first proven journey.
49
+
50
+ Record the selected framework, vendor, model, required credential variable names, and
51
+ these URLs.
52
+ Do not use remembered CopilotKit instructions.
13
53
 
14
- Fetch all three pages. Record the selected framework, vendor, model, required credential
15
- variable names, and these URLs. Do not use remembered CopilotKit instructions.
54
+ A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
55
+ not a fact about the page. Retrieve the same URL a second way before you judge it. Run
56
+ `curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
57
+ unavailable only after a second method also fails.
16
58
 
17
59
  If the pages support the selection, run
18
- `npx copilotkit@4.8.3 onboard read frontend/plan`.
60
+ `npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
19
61
 
20
- If a page does not load or support the selection, run
21
- `npx copilotkit@4.8.3 onboard read unsupported/no-validated-path`.
62
+ If a second method also fails, or a page that loads does not support the selection, run
63
+ `npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.