Helps integrate CopilotKit into an app by consulting current documentation and source code. Covers chat interfaces, agent connections, shared state, and troubleshooting, with guidance on checking configuration and avoiding incompatible API versions.
Use for any CopilotKit question — adding it to an app, chat UI, frontend or server tools, generative UI, shared state, human-in-the-loop, agent frameworks (LangGraph, CrewAI, Mastra, ADK, PydanticAI, and others), the runtime, Intelligence, threads, voice, or diagnosing something that is not working. Do not answer from memory: this skill exists to point you at the current documentation and source, both of which you can read.
Review the instructions the agent will receive before you install.
CopilotKit's APIs move. Anything written down in a skill file is a copy that starts drifting the day it is written, so this skill carries almost no API detail on purpose. It tells you where the current answer lives and how to get it.
Look it up before you write code. Not because the docs are more convenient, but because they are regenerated from the source and a recollection is not.
There are two ways to read the current docs. Check which one this session has.
This path always works. It needs only a way to fetch a URL.
.md to the page path:
https://docs.copilotkit.ai/<path>.md. For example,
https://docs.copilotkit.ai/quickstart.md and
https://docs.copilotkit.ai/backend/copilot-runtime.md. The response is
text/markdown. A path that does not exist returns 404 with the body Not found.https://docs.copilotkit.ai/llms.txt. It is a short,
curated index with links to the main pages. For a page it does not list, read
https://docs.copilotkit.ai/sitemap.xml, which lists every page URL. Both indexes list
HTML page URLs. Add .md to a URL before you fetch it. The site root has no .md form.
Do not fetch llms-full.txt in one read. It holds every page and is several megabytes.https://docs.copilotkit.ai/quickstart.md.node_modules/@copilotkit/, or the
source at https://github.com/CopilotKit/CopilotKit under packages/.https://docs.ag-ui.com. Its index
is https://docs.ag-ui.com/llms.txt, and its pages also take .md.The CopilotKit Claude Code plugin also declares an MCP server, copilotkit-docs, in its
.mcp.json. When that server is loaded, it adds search tools over four separate corpora.
It is a faster way to search. It is not required. If these tools are not in this session,
use the Markdown pages above.
| Tool | Corpus | Use it for |
|---|---|---|
search-docs | docs.copilotkit.ai | Usage, configuration, guides, quickstarts, the generated API reference |
search-code | CopilotKit library source | How something is implemented, and exact signatures. Library packages only, not examples or showcases |
search-ag-ui-docs | AG-UI protocol docs | The protocol itself: event types, transports, the SDKs |
search-ag-ui-code | AG-UI protocol SDK source | Protocol implementation detail |
explore-docs / explore-code | either tree | Browsing structure when you do not yet know what to search for |
CopilotKit questions go to the first two. AG-UI protocol questions go to the second two.
They are a different repository, and search-docs will not find them.
These are semantic searches. Several short queries with different words beat one long query. If a result is off-target, rephrase the query. Do not make it wider. If a page looks right but does not contain the term you need, say so. Do not reason from the title.
A user who wants the search tools outside the plugin can add the server themselves. The
endpoints are https://mcp.copilotkit.ai/mcp (streamable HTTP) and
https://mcp.copilotkit.ai/sse (SSE). Keep the path, because the bare host returns 404.
Build with agents has the steps for each coding tool. Do not add the
server on your own as a setup step. The Markdown pages give the same content.
Worth knowing so a search or a fetch has somewhere to land. Each link is a docs path:
https://docs.copilotkit.ai/<framework>/quickstart.md. The framework slugs are in
llms.txt, for example langgraph-python, mastra, and crewai-crews.CopilotKitCoreErrorCode for a code the
app actually reportedRun the CLI's wiring check first. It settles up to eleven things in one command and is almost always faster than reading the project. Pick the form that matches the app:
CopilotKitIntelligence where the runtime is built,
and there is no .copilotkit/project.json):
npx copilotkit@latest verify --expect-runtime oss --round-trip --agent <id> --json --via skill:copilotkitnpx copilotkit@latest verify --json --via skill:copilotkit--via skill:copilotkit only tells CopilotKit's telemetry that the call came from this skill.
If the CLI reports Unknown option '--via', npx ran an old cached version: run the command
again without the flag.
Do not run login or project select only to make verify pass. Those commands set up
hosted Intelligence and do not fix an open-source app. See the copilotkit-cli skill.
v2 is current. Import from the /v2 subpath — @copilotkit/react-core/v2,
@copilotkit/runtime/v2. The package root is the deprecated v1 surface and still resolves,
so mixing the two raises nothing at import time and surfaces later as a runtime mismatch.
Check which subpath a project imports before trusting anything else about it. v1 is
deprecated but supported; the migration guide covers moving off it.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Set up an agent that replies in Slack or Microsoft Teams using CopilotKit's guided CLI workflow. It covers project preparation, agent creation, channel configuration, a persistent host process, and verification with a real message.
Guides development of ChatGPT apps with interactive widgets using mcp-use and OpenAI Apps SDK, covering server tools, React interfaces, and shared state. This skill is deprecated and directs users to mcp-app-builder.
Implement and customize managed CopilotKit Channels so agents can reply in Slack or Microsoft Teams. It covers channel handlers, persistent runtime connections, Teams setup, and checks for silent failures such as missing permissions or incompatible package versions.
Use the CopilotKit CLI to check app connections, credentials, and agent responses before investigating code. It also guides project creation, integration into existing apps, hosted project selection, typed agent identifier generation, and thread history imports.
Keeps CopilotKit documentation aligned with released Inspector panels, the views shown in its local web overlay. It updates reader guidance and panel mappings when panels change, and checks quickstart instructions against supported platforms.
Develop and debug CopilotKit Inspector interfaces in a dedicated local workbench. It guides baseline screenshots, visual checks after each change, and additional narrow-screen or theme checks when layout or contrast is involved.