Skip to content

docs(integrations): add CopilotKit integration page - #2203

Open
mme wants to merge 1 commit into
google:mainfrom
mme:copilotkit-integration
Open

docs(integrations): add CopilotKit integration page#2203
mme wants to merge 1 commit into
google:mainfrom
mme:copilotkit-integration

Conversation

@mme

@mme mme commented Sep 4, 2026

Copy link
Copy Markdown

Summary

Adds an integration page for CopilotKit to the catalog at docs/integrations/copilotkit.md, with its icon in docs/integrations/assets/.

CopilotKit is an open source set of frontend libraries and a runtime that connect applications to agents over AG-UI. With ADK, the ag-ui-adk package exposes an agent as an AG-UI endpoint, and CopilotKit gives that endpoint a chat surface, frontend tools, generative UI, and human-in-the-loop controls in React, Angular, Vue, React Native, or Slack.

What the page covers

  • Use cases: chat, frontend tools, generative UI, human-in-the-loop, and messaging channels
  • Prerequisites and installation: Python and npm packages
  • Use with agent: a four-step walkthrough that exposes an ADK agent over AG-UI, registers it with CopilotKit Runtime, renders chat in React, and adds a browser-side tool the agent can call
  • Available hooks: a table of the React hooks and what each one does
  • Other clients: Angular, Vue, and React Native, which share the same runtime route and endpoint
  • Messaging channels: connecting a Slack workspace to the same endpoint with the open source Channels SDK
  • Additional resources

The existing AG-UI page covers the protocol and a create quickstart for new projects. This page links to it and focuses on adding CopilotKit to an existing ADK project, so the two do not overlap.

Notes for reviewers

  • catalog_tags is left out because none of the existing tags describe a frontend integration, and the AG-UI and A2UI cards carry none either. Happy to add one if you have a preference.
  • Model strings use the gemini-flash-latest alias, the agent variable is root_agent, and internal links are site-relative.

Verification

  • mkdocs build --strict passes and the card renders in the catalog
  • The Python sample was run against the published google-adk and ag-ui-adk packages; the endpoint starts and streams RUN_STARTED for the documented request
  • Every TypeScript import and option was checked against the type declarations of the published CopilotKit packages
  • All external links resolve

@netlify

netlify Bot commented Sep 4, 2026

Copy link
Copy Markdown

Deploy Preview for adk-docs-preview ready!

Name Link
🔨 Latest commit f59ce53
🔍 Latest deploy log https://app.netlify.com/projects/adk-docs-preview/deploys/6a9aed1e1ceafe00087bbd12
😎 Deploy Preview https://deploy-preview-2203--adk-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant