Back to Copilotkit

CopilotKit <> ADK Starter

examples/integrations/adk/README.md

1.57.02.9 KB
Original Source

CopilotKit <> ADK Starter

This is a starter template for building AI agents using Google's ADK and CopilotKit. It provides a modern Next.js application with an integrated investment analyst agent that can research stocks, analyze market data, and provide investment insights.

Prerequisites

Getting Started

  1. Install dependencies using your preferred package manager:
bash
# Using npm (default)
npm install

# Using pnpm
pnpm install

# Using yarn
yarn install

# Using bun
bun install

Note: This will automatically setup a .venv (virtual environment) inside the agent directory.

To activate the virtual environment manually, you can run:

bash
source agent/.venv/bin/activate
  1. Set up your Google API key:
bash
export GOOGLE_API_KEY="your-google-api-key-here"
  1. Start the development server:
bash
# Using npm (default)
npm run dev

# Using pnpm
pnpm dev

# Using yarn
yarn dev

# Using bun
bun run dev

This will start both the UI and agent servers concurrently.

Available Scripts

The following scripts can also be run using your preferred package manager:

  • dev - Starts both UI and agent servers in development mode
  • dev:debug - Starts development servers with debug logging enabled
  • dev:ui - Starts only the Next.js UI server
  • dev:agent - Starts only the ADK agent server
  • build - Builds the Next.js application for production
  • start - Starts the production server
  • install:agent - Installs Python dependencies for the agent

Documentation

The main UI component is in src/app/page.tsx. You can:

  • Modify the theme colors and styling
  • Add new frontend actions
  • Customize the CopilotKit sidebar appearance

📚 Documentation

Contributing

Feel free to submit issues and enhancement requests! This starter is designed to be easily extensible.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Troubleshooting

Agent Connection Issues

If you see "I'm having trouble connecting to my tools", make sure:

  1. The ADK agent is running on port 8000
  2. Your Google API key is set correctly
  3. Both servers started successfully

Python Dependencies

If you encounter Python import errors:

bash
cd agent
pip install -r requirements.txt