Back to Copilotkit

CopilotKit Integrations

skills/copilotkit-integrations/SKILL.md

1.58.08.9 KB
Original Source

CopilotKit Integrations

Live Documentation (MCP)

This plugin includes an MCP server (copilotkit-docs) that provides search-docs and search-code tools for querying live CopilotKit documentation and source code. Useful for looking up framework-specific integration details.

  • Claude Code: Auto-configured by the plugin's .mcp.json -- no setup needed.
  • Codex: Requires manual configuration. See the copilotkit-debug skill for setup instructions.

Overview

CopilotKit connects to external agent frameworks through the AG-UI (Agent-UI) protocol -- a streaming protocol that enables bidirectional communication between a frontend CopilotKit application and a backend agent. Every integration follows the same architectural pattern:

  1. Agent server -- your agent framework runs as an HTTP server (usually FastAPI/uvicorn for Python, or an Express/Next.js route for JS/TS)
  2. AG-UI adapter -- a framework-specific adapter translates between the agent's native interface and the AG-UI wire protocol
  3. CopilotKit runtime -- the Next.js API route creates a CopilotRuntime that connects to the agent via an AG-UI client class
  4. Frontend -- React components use useAgent, useFrontendTool, useRenderToolCall, and useHumanInTheLoop to interact with the agent

Supported Integrations

FrameworkLanguageAG-UI Client (route.ts)AG-UI Server AdapterAgent Port
LangGraph (Python, self-hosted)PythonLangGraphHttpAgent from @copilotkit/runtime/langgraphag-ui-langgraph (add_langgraph_fastapi_endpoint)8123
LangGraph (Python, LangGraph Platform)PythonLangGraphAgent from @copilotkit/runtime/langgraphLangGraph Platform (managed)varies
LangGraph (JS)TypeScriptLangGraphAgent from @copilotkit/runtime/langgraphBuilt into @copilotkit/sdk-js/langgraph8123
CrewAI FlowsPythonHttpAgent from @ag-ui/clientag-ui-crewai (add_crewai_flow_fastapi_endpoint)8000
CrewAI CrewsPythonCrewAIAgent from @ag-ui/crewaiag-ui-crewai (add_crewai_crew_fastapi_endpoint)8000
PydanticAIPythonHttpAgent from @ag-ui/clientpydantic-ai-slim[ag-ui] (agent.to_ag_ui())8000
MastraTypeScriptMastraAgent from @ag-ui/mastraBuilt into @ag-ui/mastraNext.js dev server
Google ADKPythonHttpAgent from @ag-ui/clientag-ui-adk (add_adk_fastapi_endpoint)8000
LlamaIndexPythonLlamaIndexAgent from @ag-ui/llamaindexllama-index-protocols-ag-ui (get_ag_ui_workflow_router)9000
AgnoPythonHttpAgent from @ag-ui/clientagno (built-in AgentOS with AGUI interface)8000
StrandsPythonHttpAgent from @ag-ui/clientag_ui_strands (create_strands_app)8000
Microsoft Agent Framework (Python)PythonHttpAgent from @ag-ui/clientagent-framework-ag-ui (add_agent_framework_fastapi_endpoint)8000
Microsoft Agent Framework (.NET)C#HttpAgent from @ag-ui/clientMicrosoft.Agents.AI.Hosting.AGUI.AspNetCore (MapAGUI)8000
A2A MiddlewarePython + TSA2AMiddlewareAgent from @ag-ui/a2a-middlewarePer-agent (mixed frameworks)9000-9002
MCP AppsTypeScriptBuiltInAgent with MCPAppsMiddlewareN/A (middleware on BuiltInAgent)3108

Decision Tree

Use this to pick the right integration:

Is your agent written in TypeScript/JavaScript?
  YES --> Is it a Mastra agent?
    YES --> Use Mastra integration (references/integrations/mastra.md)
    NO  --> Is it a LangGraph JS agent?
      YES --> Use LangGraph JS integration (references/integrations/langgraph.md, JS section)
      NO  --> Use BuiltInAgent with MCP Apps middleware or HttpAgent
  NO (Python or .NET) -->
    Which framework?
      LangGraph     --> references/integrations/langgraph.md
      CrewAI        --> references/integrations/crewai.md
      PydanticAI    --> references/integrations/pydantic-ai.md
      Google ADK    --> references/integrations/adk.md
      LlamaIndex    --> references/integrations/llamaindex.md
      Agno          --> references/integrations/agno.md
      Strands       --> references/integrations/strands.md
      MS Agent Fw   --> references/integrations/ms-agent-framework.md
      Multiple agents (A2A) --> references/integrations/a2a.md

Common AG-UI Protocol Patterns

Every integration shares these patterns on the frontend side.

CopilotKit Provider (layout.tsx)

tsx
import { CopilotKitProvider } from "@copilotkit/react";
import "@copilotkit/react/styles.css";

export default function RootLayout({ children }) {
  return (
    <CopilotKitProvider runtimeUrl="/api/copilotkit" agent="my_agent_name">
      {children}
    </CopilotKitProvider>
  );
}

The agent prop must match the key used in CopilotRuntime({ agents: { my_agent_name: ... } }).

API Route Pattern (route.ts)

All integrations create a Next.js API route at src/app/api/copilotkit/route.ts:

tsx
import {
  CopilotRuntime,
  ExperimentalEmptyAdapter,
  copilotRuntimeNextJSAppRouterEndpoint,
} from "@copilotkit/runtime";
import { NextRequest } from "next/server";
// Import the appropriate agent class for your framework

const runtime = new CopilotRuntime({
  agents: {
    my_agent: new SomeAgentClass({ url: "http://localhost:8000/" }),
  },
});

export const POST = async (req: NextRequest) => {
  const { handleRequest } = copilotRuntimeNextJSAppRouterEndpoint({
    runtime,
    serviceAdapter: new ExperimentalEmptyAdapter(),
    endpoint: "/api/copilotkit",
  });
  return handleRequest(req);
};

Shared State (useAgent)

tsx
const { state, setState } = useAgent<{ proverbs: string[] }>({
  name: "my_agent",
  initialState: { proverbs: [] },
});

Frontend Tools (useFrontendTool)

tsx
useFrontendTool({
  name: "setThemeColor",
  parameters: [
    { name: "themeColor", description: "Hex color value", required: true },
  ],
  handler({ themeColor }) {
    setThemeColor(themeColor);
  },
});

Generative UI (useRenderToolCall)

tsx
useRenderToolCall(
  {
    name: "get_weather",
    description: "Get weather for a location.",
    parameters: [{ name: "location", type: "string", required: true }],
    render: ({ args }) => <WeatherCard location={args.location} />,
  },
  [],
);

Human in the Loop (useHumanInTheLoop)

tsx
useHumanInTheLoop(
  {
    name: "go_to_moon",
    description: "Go to the moon on request.",
    render: ({ respond, status }) => (
      <MoonCard status={status} respond={respond} />
    ),
  },
  [],
);

Agent-Side State Management

On the agent side, shared state is managed differently per framework, but the protocol is the same -- agents emit STATE_SNAPSHOT events to update the frontend. See each integration guide for framework-specific patterns.

Key Packages

Frontend (all integrations):

  • @copilotkit/react -- hooks (useAgent, useFrontendTool, useRenderToolCall, useHumanInTheLoop) and UI components (CopilotSidebar, CopilotPopup)
  • @copilotkit/runtime -- server runtime (CopilotRuntime, ExperimentalEmptyAdapter)

AG-UI client classes (choose one per integration):

  • @copilotkit/runtime/langgraph -- LangGraphAgent, LangGraphHttpAgent
  • @ag-ui/client -- HttpAgent (generic, works with any AG-UI server)
  • @ag-ui/crewai -- CrewAIAgent
  • @ag-ui/mastra -- MastraAgent
  • @ag-ui/llamaindex -- LlamaIndexAgent
  • @ag-ui/a2a-middleware -- A2AMiddlewareAgent
  • @ag-ui/mcp-apps-middleware -- MCPAppsMiddleware