copilotkit 4.8.4 → 4.9.1
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 +46 -5
- package/cli-build-info.json +7 -7
- package/index.js +647 -124
- package/onboarding/index.json +140 -1
- package/onboarding/prompts/authenticate/start.md +47 -10
- package/onboarding/prompts/credentials/finalize-plan.md +64 -14
- package/onboarding/prompts/credentials/plan.md +54 -16
- package/onboarding/prompts/fallback/best-effort.md +36 -0
- package/onboarding/prompts/framework/ag2.md +48 -0
- package/onboarding/prompts/framework/agno.md +48 -0
- package/onboarding/prompts/framework/built-in.md +43 -0
- package/onboarding/prompts/framework/claude-sdk-python.md +49 -0
- package/onboarding/prompts/framework/claude-sdk-typescript.md +53 -0
- package/onboarding/prompts/framework/crewai-flows.md +56 -0
- package/onboarding/prompts/framework/deep-agents.md +45 -0
- package/onboarding/prompts/framework/google-adk.md +8 -3
- package/onboarding/prompts/framework/langgraph-fastapi.md +42 -0
- package/onboarding/prompts/framework/langgraph-python.md +8 -3
- package/onboarding/prompts/framework/langgraph-typescript.md +8 -3
- package/onboarding/prompts/framework/llamaindex.md +51 -0
- package/onboarding/prompts/framework/mastra.md +8 -3
- package/onboarding/prompts/framework/ms-agent-dotnet.md +8 -3
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +62 -0
- package/onboarding/prompts/framework/ms-agent-python.md +8 -3
- package/onboarding/prompts/framework/pydantic-ai.md +48 -0
- package/onboarding/prompts/framework/strands-python.md +42 -0
- package/onboarding/prompts/framework/strands-typescript.md +42 -0
- package/onboarding/prompts/frontend/angular.md +9 -3
- package/onboarding/prompts/frontend/nextjs.md +8 -3
- package/onboarding/prompts/frontend/plan.md +22 -10
- package/onboarding/prompts/frontend/react-native.md +9 -3
- package/onboarding/prompts/frontend/react-spa.md +20 -5
- package/onboarding/prompts/frontend/vue.md +9 -3
- package/onboarding/prompts/implementation/build-and-validate.md +12 -2
- package/onboarding/prompts/proof/complete.md +51 -16
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +51 -24
- package/onboarding/prompts/subagent/create-plan.md +14 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +10 -0
- package/onboarding/prompts/subagent/inspect-repository.md +6 -1
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +46 -21
- package/onboarding/prompts/unsupported/no-validated-path.md +23 -9
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Configure Agno
|
|
2
|
+
|
|
3
|
+
Preserve an existing Agno model setup. Start with OpenAI for a new agent. Offer another
|
|
4
|
+
vendor only after an exact CopilotKit Markdown page names it. The page must name its
|
|
5
|
+
credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/agno/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/agno/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/agno/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/agno/shared-state/agent-readonly.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `agno`. Use only the Python agent examples from these pages.
|
|
22
|
+
When the repository already has an Agno agent, use the quickstart's
|
|
23
|
+
`Use an existing agent` path. Use `Start from scratch` only when the repository needs a
|
|
24
|
+
new agent. For a new agent, install the documented Python dependencies
|
|
25
|
+
`agno fastapi uvicorn openai ag-ui-protocol`. Preserve an existing `AgentOS` with the
|
|
26
|
+
`AGUI` interface and its endpoint. In the documented runtime, `AgnoAgent` from
|
|
27
|
+
`@ag-ui/agno` targets `/agui`. Do not replace that adapter with a generic agent or change
|
|
28
|
+
the endpoint without repository evidence.
|
|
29
|
+
|
|
30
|
+
The fixed-schema page has no Agno backend schema-loading, render-operations, or runtime
|
|
31
|
+
setup snippet. The agent-readonly page does not bundle its Agno backend context setup.
|
|
32
|
+
Do not invent either missing backend setup. If the requested work needs one of those
|
|
33
|
+
setups and the project does not already have it, run the unsupported route below.
|
|
34
|
+
|
|
35
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
36
|
+
URLs, the documented dependencies and adapter, and both documentation gaps. Do not use
|
|
37
|
+
remembered CopilotKit instructions.
|
|
38
|
+
|
|
39
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
40
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
41
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
42
|
+
unavailable only after a second method also fails.
|
|
43
|
+
|
|
44
|
+
If the pages support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
46
|
+
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Configure the built-in CopilotKit agent
|
|
2
|
+
|
|
3
|
+
Preserve an existing built-in agent model setup. Start with OpenAI for a new agent. Offer
|
|
4
|
+
another vendor only after an exact CopilotKit Markdown page names it. The page must name
|
|
5
|
+
its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
The built-in agent runs in the CopilotKit Runtime process.
|
|
13
|
+
Do not create or start a separate agent server.
|
|
14
|
+
Keep the agent, model choice, tools, and runtime endpoint in the project's existing
|
|
15
|
+
runtime setup.
|
|
16
|
+
|
|
17
|
+
## Documentation
|
|
18
|
+
|
|
19
|
+
- https://docs.copilotkit.ai/built-in-agent.md
|
|
20
|
+
- https://docs.copilotkit.ai/quickstart.md
|
|
21
|
+
- https://docs.copilotkit.ai/inspector.md
|
|
22
|
+
- https://docs.copilotkit.ai/agent-app-context.md
|
|
23
|
+
- https://docs.copilotkit.ai/model-selection.md
|
|
24
|
+
- https://docs.copilotkit.ai/generative-ui/tool-based.md
|
|
25
|
+
|
|
26
|
+
Fetch all six pages in one step rather than one after another.
|
|
27
|
+
|
|
28
|
+
These pages use the root documentation scope. Do not add a framework path segment to
|
|
29
|
+
their URLs. Use the tool-based generative UI page for this built-in route.
|
|
30
|
+
|
|
31
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
32
|
+
these URLs. Do not use remembered CopilotKit instructions.
|
|
33
|
+
|
|
34
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
35
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
36
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
37
|
+
unavailable only after a second method also fails.
|
|
38
|
+
|
|
39
|
+
If the pages support the selection, run
|
|
40
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
41
|
+
|
|
42
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
43
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Configure Claude Agent SDK for Python
|
|
2
|
+
|
|
3
|
+
Preserve an existing Claude Agent SDK model setup. Start with Anthropic for a new agent.
|
|
4
|
+
Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
|
|
5
|
+
name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
|
|
8
|
+
`ANTHROPIC_MODEL`.
|
|
9
|
+
|
|
10
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
11
|
+
store, or request a secret value.
|
|
12
|
+
|
|
13
|
+
## Documentation
|
|
14
|
+
|
|
15
|
+
- https://docs.copilotkit.ai/claude-sdk-python/quickstart.md
|
|
16
|
+
- https://docs.copilotkit.ai/claude-sdk-python/inspector.md
|
|
17
|
+
- https://docs.copilotkit.ai/claude-sdk-python/generative-ui/a2ui/fixed-schema.md
|
|
18
|
+
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
19
|
+
|
|
20
|
+
Fetch all four pages in one step rather than one after another.
|
|
21
|
+
|
|
22
|
+
The documentation scope is `claude-sdk-python`. For an existing agent, install the exact
|
|
23
|
+
documented backend set with
|
|
24
|
+
`uv add claude-agent-sdk ag-ui-claude-sdk ag-ui-protocol anthropic fastapi uvicorn python-dotenv`.
|
|
25
|
+
Expose the agent through FastAPI and use `ClaudeAgentAdapter` from `ag_ui_claude_sdk`.
|
|
26
|
+
Keep one long-lived adapter at module scope. Register the remote endpoint in Copilot Runtime
|
|
27
|
+
with `HttpAgent`. Do not replace this transport with a different Claude or AG-UI adapter.
|
|
28
|
+
|
|
29
|
+
For fixed-schema A2UI, keep the tool in the agent. Set `injectA2UITool` to `false` in the
|
|
30
|
+
runtime. The documented Python setup does not support `action_handlers` on
|
|
31
|
+
`a2ui.render`. Do not add them or claim that the fixed-schema button callback works.
|
|
32
|
+
|
|
33
|
+
No Claude Agent SDK Python agent-app-context Markdown page is available. The reference
|
|
34
|
+
page above documents the frontend hook only. Do not invent the missing agent-side context
|
|
35
|
+
setup. If the requested work needs that setup, run the unsupported route below.
|
|
36
|
+
|
|
37
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
38
|
+
URLs, and the context and A2UI limits. Do not use remembered CopilotKit instructions.
|
|
39
|
+
|
|
40
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
41
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
42
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
43
|
+
unavailable only after a second method also fails.
|
|
44
|
+
|
|
45
|
+
If the pages support the selection, run
|
|
46
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
47
|
+
|
|
48
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
49
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Configure Claude Agent SDK for TypeScript
|
|
2
|
+
|
|
3
|
+
Preserve an existing Claude Agent SDK model setup. Start with Anthropic for a new agent.
|
|
4
|
+
Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
|
|
5
|
+
name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
|
|
8
|
+
`CLAUDE_MODEL`.
|
|
9
|
+
|
|
10
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
11
|
+
store, or request a secret value.
|
|
12
|
+
|
|
13
|
+
## Documentation
|
|
14
|
+
|
|
15
|
+
- https://docs.copilotkit.ai/claude-sdk-typescript/quickstart.md
|
|
16
|
+
- https://docs.copilotkit.ai/claude-sdk-typescript/inspector.md
|
|
17
|
+
- https://docs.copilotkit.ai/claude-sdk-typescript/generative-ui/a2ui/fixed-schema.md
|
|
18
|
+
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
19
|
+
|
|
20
|
+
Fetch all four pages in one step rather than one after another.
|
|
21
|
+
|
|
22
|
+
The documentation scope is `claude-sdk-typescript`. For an existing agent, install the
|
|
23
|
+
documented packages, including `@anthropic-ai/claude-agent-sdk@^0.2.58`,
|
|
24
|
+
`@anthropic-ai/sdk`, `@ag-ui/claude-agent-sdk`, `@ag-ui/core`, `@ag-ui/encoder`,
|
|
25
|
+
`express`, `dotenv`, and `zod`. Keep the Express AG-UI endpoint. Use
|
|
26
|
+
`ClaudeAgentAdapter` from `@ag-ui/claude-agent-sdk` in that endpoint and `HttpAgent` in
|
|
27
|
+
Copilot Runtime. Do not replace either adapter.
|
|
28
|
+
|
|
29
|
+
For fixed-schema A2UI, expose the backend tool through the in-process Claude SDK MCP
|
|
30
|
+
server. Set `injectA2UITool` to `false` so the agent-owned tool is the only A2UI tool.
|
|
31
|
+
The Claude Agent SDK adapter does not bridge CopilotKit frontend or runtime tools through
|
|
32
|
+
AG-UI. If the requested path needs those tools, run the unsupported route below. Do not
|
|
33
|
+
replace the Claude Agent SDK with the direct Anthropic Messages API fallback.
|
|
34
|
+
|
|
35
|
+
The adapter appends AG-UI `input.context` entries to the Claude system prompt. Pair that
|
|
36
|
+
backend path with the frontend hook from the reference page. Treat this as read-only app
|
|
37
|
+
context. It does not provide an agent-to-frontend write-back path. Inspect the installed,
|
|
38
|
+
pinned adapter source before using this path. If the package no longer handles
|
|
39
|
+
`input.context`, run the unsupported route below.
|
|
40
|
+
|
|
41
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
42
|
+
URLs, and the adapter and context limits. Do not use remembered CopilotKit instructions.
|
|
43
|
+
|
|
44
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
45
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
46
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
47
|
+
unavailable only after a second method also fails.
|
|
48
|
+
|
|
49
|
+
If the pages support the selection, run
|
|
50
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
51
|
+
|
|
52
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
53
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Configure CrewAI Flows
|
|
2
|
+
|
|
3
|
+
Preserve the project's existing CrewAI Flow, model, and deployment. The selected pages do
|
|
4
|
+
not name a default model vendor or model credential variable. Do not choose a vendor or
|
|
5
|
+
credential name for the developer. Ask only for a choice that the repository does not
|
|
6
|
+
show and the documentation supports.
|
|
7
|
+
|
|
8
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
9
|
+
store, or request a secret value.
|
|
10
|
+
|
|
11
|
+
## Documentation
|
|
12
|
+
|
|
13
|
+
- https://docs.copilotkit.ai/crewai-crews/quickstart.md
|
|
14
|
+
- https://docs.copilotkit.ai/crewai-crews/inspector.md
|
|
15
|
+
- https://docs.copilotkit.ai/crewai-crews/generative-ui/a2ui/fixed-schema.md
|
|
16
|
+
- https://docs.copilotkit.ai/crewai-crews/shared-state/in-app-agent-read.md
|
|
17
|
+
|
|
18
|
+
Fetch all four pages in one step rather than one after another.
|
|
19
|
+
|
|
20
|
+
The public onboarding route ID is `crewai-flows`. The canonical documentation scope is
|
|
21
|
+
`crewai-crews`. The quickstart and feature pages also contain older `/crewai-flows/`
|
|
22
|
+
links. Use the canonical Markdown URLs above and keep the project's CrewAI Flow name.
|
|
23
|
+
|
|
24
|
+
The quickstart offers `Use the CopilotKit CLI (NextJS only)` and `Code along`. It assumes
|
|
25
|
+
an existing Flow. Preserve the vendor, model, and credential variable that the project
|
|
26
|
+
already uses. The new quickstart example uses GitHub Models. An existing OpenAI Flow can
|
|
27
|
+
keep OpenAI and `OPENAI_API_KEY`. Do not change vendors to match the example.
|
|
28
|
+
|
|
29
|
+
The current Python base adapter is `ag-ui-crewai==0.3.0`. Add the endpoint to the
|
|
30
|
+
project's FastAPI app with
|
|
31
|
+
`add_crewai_flow_fastapi_endpoint(app, ExistingFlow(), "/chat")`. Keep the existing Flow
|
|
32
|
+
and its regular, non-conversational mode. Use the generic `HttpAgent` for the `/chat`
|
|
33
|
+
endpoint. Do not invent a `CrewAIAgent` runtime class.
|
|
34
|
+
|
|
35
|
+
The fixed-schema page extends this base adapter. Keep the fixed-schema tool on the CrewAI
|
|
36
|
+
Flow path, call `copilotkit_emit_tool_result`, and set `injectA2UITool: false` in the
|
|
37
|
+
runtime catalog. Do not replace the existing Flow with a Crew, Agent, or Task graph.
|
|
38
|
+
|
|
39
|
+
The shared-state page is not an agent-app-context guide. Do not use it to invent a
|
|
40
|
+
`useAgentContext` backend setup. If the requested work needs app context rather than the
|
|
41
|
+
documented shared-state path, run the unsupported route below.
|
|
42
|
+
|
|
43
|
+
Record the selected framework, project-defined vendor and model, repository-proven
|
|
44
|
+
credential variable names, these URLs, the adapter, and both documentation limits. Do not
|
|
45
|
+
use remembered CopilotKit instructions.
|
|
46
|
+
|
|
47
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
48
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
49
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
50
|
+
unavailable only after a second method also fails.
|
|
51
|
+
|
|
52
|
+
If the pages support the selection, run
|
|
53
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
54
|
+
|
|
55
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
56
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Configure Deep Agents
|
|
2
|
+
|
|
3
|
+
Preserve an existing Deep Agents language and model setup. Start with OpenAI for a new
|
|
4
|
+
agent. Offer another vendor only after an exact CopilotKit Markdown page names it. The
|
|
5
|
+
page must name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/deepagents/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/deepagents/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/deepagents/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/deepagents/shared-state/agent-readonly.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `deepagents`. Do not use `deep-agents` in a documentation URL.
|
|
22
|
+
The quickstart has Python and TypeScript tabs. Preserve the project's current language.
|
|
23
|
+
Preserve the project's existing deployment path. Choose the same `Deep Agent` or
|
|
24
|
+
`FastAPI` tab in both the quickstart and runtime setup. Do not change a Deep Agent
|
|
25
|
+
deployment to FastAPI or a FastAPI deployment to Deep Agent.
|
|
26
|
+
|
|
27
|
+
The fixed-schema A2UI backend example is Python-only. No Deep Agents agent-app-context
|
|
28
|
+
Markdown page is available. Do not invent a TypeScript A2UI backend or an
|
|
29
|
+
agent-app-context setup. If the requested work needs either missing setup, run the
|
|
30
|
+
unsupported route below.
|
|
31
|
+
|
|
32
|
+
Record the selected framework, language, vendor, model, required credential variable
|
|
33
|
+
names, these URLs, and each documentation gap. Do not use remembered CopilotKit
|
|
34
|
+
instructions.
|
|
35
|
+
|
|
36
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
37
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
38
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
39
|
+
unavailable only after a second method also fails.
|
|
40
|
+
|
|
41
|
+
If the pages support the selection, run
|
|
42
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
43
|
+
|
|
44
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -34,8 +34,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
these URLs.
|
|
35
35
|
Do not use remembered CopilotKit instructions.
|
|
36
36
|
|
|
37
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
38
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
39
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
40
|
+
unavailable only after a second method also fails.
|
|
41
|
+
|
|
37
42
|
If the pages support the selection, run
|
|
38
|
-
`npx copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
39
44
|
|
|
40
|
-
If a page does not
|
|
41
|
-
`npx copilotkit@4.
|
|
45
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
46
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Configure LangGraph FastAPI
|
|
2
|
+
|
|
3
|
+
Preserve an existing LangGraph FastAPI model setup. Start with OpenAI for a new agent.
|
|
4
|
+
Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
|
|
5
|
+
name its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
8
|
+
store, or request a secret value.
|
|
9
|
+
|
|
10
|
+
## Documentation
|
|
11
|
+
|
|
12
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/quickstart.md
|
|
13
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/inspector.md
|
|
14
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/generative-ui/a2ui/fixed-schema.md
|
|
15
|
+
- https://docs.copilotkit.ai/langgraph-fastapi/agent-app-context.md
|
|
16
|
+
|
|
17
|
+
Fetch all four pages in one step rather than one after another. Sequential fetching
|
|
18
|
+
cost about nine minutes of the first proven journey.
|
|
19
|
+
|
|
20
|
+
Read the FastAPI tab of the quickstart.
|
|
21
|
+
Preserve an existing FastAPI transport and its persistence.
|
|
22
|
+
The FastAPI graph must have a checkpointer.
|
|
23
|
+
Keep the existing checkpointer. For a new local agent, use `MemorySaver` only for
|
|
24
|
+
development.
|
|
25
|
+
Use `add_langgraph_fastapi_endpoint` for the FastAPI agent endpoint.
|
|
26
|
+
Use `LangGraphHttpAgent` in the Copilot Runtime.
|
|
27
|
+
Do not copy the LangSmith path, its no-checkpointer rule, or its `LangGraphAgent` adapter.
|
|
28
|
+
|
|
29
|
+
Record the selected framework, vendor, model, required credential variable names, and
|
|
30
|
+
these URLs.
|
|
31
|
+
Do not use remembered CopilotKit instructions.
|
|
32
|
+
|
|
33
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
34
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
35
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
36
|
+
unavailable only after a second method also fails.
|
|
37
|
+
|
|
38
|
+
If the pages support the selection, run
|
|
39
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
40
|
+
|
|
41
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
42
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -21,8 +21,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
21
21
|
these URLs.
|
|
22
22
|
Do not use remembered CopilotKit instructions.
|
|
23
23
|
|
|
24
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
25
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
26
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
27
|
+
unavailable only after a second method also fails.
|
|
28
|
+
|
|
24
29
|
If the pages support the selection, run
|
|
25
|
-
`npx copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
26
31
|
|
|
27
|
-
If a page does not
|
|
28
|
-
`npx copilotkit@4.
|
|
32
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
33
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -21,8 +21,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
21
21
|
these URLs.
|
|
22
22
|
Do not use remembered CopilotKit instructions.
|
|
23
23
|
|
|
24
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
25
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
26
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
27
|
+
unavailable only after a second method also fails.
|
|
28
|
+
|
|
24
29
|
If the pages support the selection, run
|
|
25
|
-
`npx copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
26
31
|
|
|
27
|
-
If a page does not
|
|
28
|
-
`npx copilotkit@4.
|
|
32
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
33
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Configure LlamaIndex
|
|
2
|
+
|
|
3
|
+
Preserve an existing LlamaIndex model setup. Start with OpenAI for a new agent. Offer
|
|
4
|
+
another vendor only after an exact CopilotKit Markdown page names it. The page must name
|
|
5
|
+
its credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/llamaindex/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/llamaindex/inspector.md
|
|
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.
|
|
41
|
+
|
|
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.
|
|
46
|
+
|
|
47
|
+
If the pages support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
49
|
+
|
|
50
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
51
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -51,8 +51,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
51
51
|
these URLs.
|
|
52
52
|
Do not use remembered CopilotKit instructions.
|
|
53
53
|
|
|
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.
|
|
58
|
+
|
|
54
59
|
If the pages support the selection, run
|
|
55
|
-
`npx copilotkit@4.
|
|
60
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
56
61
|
|
|
57
|
-
If a page does not
|
|
58
|
-
`npx copilotkit@4.
|
|
62
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
63
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -59,8 +59,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
59
59
|
these URLs.
|
|
60
60
|
Do not use remembered CopilotKit instructions.
|
|
61
61
|
|
|
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.
|
|
66
|
+
|
|
62
67
|
If the pages support the selection, run
|
|
63
|
-
`npx copilotkit@4.
|
|
68
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
64
69
|
|
|
65
|
-
If a page does not
|
|
66
|
-
`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.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Configure MS Agent Harness for .NET
|
|
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.
|
|
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.
|
|
15
|
+
|
|
16
|
+
## Documentation
|
|
17
|
+
|
|
18
|
+
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/quickstart.md
|
|
19
|
+
- 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
|
|
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.
|
|
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.
|
|
57
|
+
|
|
58
|
+
If the pages support the selection, run
|
|
59
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
60
|
+
|
|
61
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
62
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -34,8 +34,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
these URLs.
|
|
35
35
|
Do not use remembered CopilotKit instructions.
|
|
36
36
|
|
|
37
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
38
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
39
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
40
|
+
unavailable only after a second method also fails.
|
|
41
|
+
|
|
37
42
|
If the pages support the selection, run
|
|
38
|
-
`npx copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
39
44
|
|
|
40
|
-
If a page does not
|
|
41
|
-
`npx copilotkit@4.
|
|
45
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
46
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Configure Pydantic AI
|
|
2
|
+
|
|
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`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/pydantic-ai/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/pydantic-ai/inspector.md
|
|
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.
|
|
38
|
+
|
|
39
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
40
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
41
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
42
|
+
unavailable only after a second method also fails.
|
|
43
|
+
|
|
44
|
+
If the pages support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
46
|
+
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|