# CopilotKit Guide

Answers CopilotKit questions with pointers to current docs and source.

- Repository: https://github.com/CopilotKit/CopilotKit (38452 stars)
- Category: AI and agents
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add CopilotKit/CopilotKit --skill copilotkit -g -a claude-code -y`
Codex: `npx skills add CopilotKit/CopilotKit --skill copilotkit -g -a codex -y`
Cursor: `npx skills add CopilotKit/CopilotKit --skill copilotkit -g -a cursor -y`
Gemini CLI: `npx skills add CopilotKit/CopilotKit --skill copilotkit -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add CopilotKit/CopilotKit`

## Description

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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# CopilotKit

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.

## Reading the docs

There are two ways to read the current docs. Check which one this session has.

### Without the MCP server: fetch the Markdown pages

This path always works. It needs only a way to fetch a URL.

- **Any docs page as Markdown.** Add `.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`.
- **To find a path.** Start with `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.
- **Links in this skill.** A link such as [quickstart](/quickstart) is a docs path.
  Fetch it as `https://docs.copilotkit.ai/quickstart.md`.
- **Library source.** Read the installed package in `node_modules/@copilotkit/`, or the
  source at `https://github.com/CopilotKit/CopilotKit` under `packages/`.
- **AG-UI protocol.** The protocol has its own docs at `https://docs.ag-ui.com`. Its index
  is `https://docs.ag-ui.com/llms.txt`, and its pages also take `.md`.

### With the MCP server: search tools

The rest: https://github.com/CopilotKit/CopilotKit/blob/HEAD/skills/copilotkit/SKILL.md