This is a starter template for building AI agents using Microsoft Agent Framework and CopilotKit. It provides a modern Next.js application with an integrated proverbs management agent that demonstrates AG-UI protocol features including shared state, generative UI, and human-in-the-loop workflows.

Prerequisites

OpenAI API key from the API key page
.NET 9.0 SDK
- Download directly
- macOS/Linux
  - Install via Homebrew (brew install dotnet@9) or
  - Install via curl install script
    curl -sSL https://dot.net/v1/dotnet-install.sh | bash /dev/stdin --channel 9.0 export PATH="$HOME/.dotnet:$PATH"
- Windows
  - Install via WinGet (winget install --id=Microsoft.DotNet.SDK.9 -e)

Node.js 20+

Download directly

macOS/Linux

Install via Homebrew (brew install node@24) or

Install via curl install script

# Download and install nvm:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash

# in lieu of restarting the shell
\. "$HOME/.nvm/nvm.sh"

# Download and install Node.js:
nvm install 24

Windows
- Install via WinGet (winget install --id=OpenJS.NodeJS -v "24.11.0" -e)

Any of the following package managers:
- npm (default) (usually installed with Node.js)
- pnpm
- yarn
- bun

Getting Started

Install dependencies using your preferred package manager:
```
# Using npm (default)
npm install

# Using pnpm
pnpm install

# Using yarn
yarn install

# Using bun
bun install
```
Note: This will automatically setup the C# agent as well (restore NuGet packages).

If you have manual issues, you can run:
```
npm run install:agent
```

Save your OpenAI API key as a .NET user secret:

cd agent
dotnet user-secrets set OPENAI_API_KEY "<your-openai-api-key>"
cd ..

Start the development server:
```
# Using npm (default)
npm run dev

# Using pnpm
pnpm dev

# Using yarn
yarn dev

# Using bun
bun run dev
```
This will start both the Next.js UI (port 3000) and C# agent server (port 8000) concurrently.

Running a Channel

channel-host.mts mounts the same agent as an Intelligence Channel (Slack, Teams). It requires CPK_INTELLIGENCE_API_KEY and a declared Channel in .copilotkit/channels.json — set both up with copilotkit init or copilotkit channels add, which write that file and the credentials your .env needs, then:

npm run channel

The host reads which Channel to hold from .copilotkit/channels.json. If a project declares more than one, set INTELLIGENCE_CHANNEL_NAME to pick one.

The host holds no provider credentials and exposes no provider endpoint — Intelligence owns the provider edge — so the same file works for every provider.

The Channel itself is declared in channels.mts — that is where to add commands, reactions, or an onMention handler. channel-host.mts only owns the process lifetime, and is byte-identical in every starter.

Once startup finishes, the log reports the truth per Channel:

Channel "<name>" is online. — the session is up and can send.
Channel "<name>" is declared but no provider is attached yet. — a normal waiting state, not a failure. Run copilotkit channels status to see what setup remains.

Neither message proves the provider app is installed, reachable, or that anyone can message it — verify that separately (invite the bot, then message it) before treating the Channel as working.

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 C# agent server
build - Builds the Next.js application for production
start - Starts the production server
lint - Runs ESLint for code linting
install:agent - Restores NuGet packages for the C# agent
channel - Holds an Intelligence Channel open (see "Running a Channel" above)
typecheck:channel - Type-checks the channel host on its own tsconfig.channel.json

Project Structure

├── agent/                  # C# Agent (Microsoft Agent Framework)
│   ├── Program.cs         # Main agent implementation with tools
│   ├── ProverbsAgent.csproj  # .NET project file
│   └── Properties/        # Configuration (launch settings)
├── src/
│   ├── app/
│   │   ├── page.tsx      # Main UI with CopilotKit sidebar
│   │   ├── layout.tsx    # CopilotKit provider setup
│   │   └── api/
│   │       └── copilotkit/
│   │           └── route.ts  # AG-UI integration endpoint
│   ├── components/       # UI components (weather, proverbs, moon)
│   └── lib/             # Types and utilities
└── scripts/             # Helper scripts for agent setup/run

Features Demonstrated

This starter showcases key AG-UI protocol features:

🔄 Shared State: Proverbs list synchronized between frontend and agent
🎨 Generative UI: Weather card rendered from backend tool
👤 Human-in-the-Loop: Moon card with approval workflow
🛠️ Frontend Actions: Theme color changes from agent
💬 Agentic Chat: Natural language interface with tool calling

📚 Documentation

Microsoft Agent Framework - Learn about Microsoft's agent framework
Microsoft Agent Framework model providers - Choose another model provider
AG-UI Protocol - AG-UI protocol specification
CopilotKit Documentation - CopilotKit features and API
Next.js Documentation - Next.js features and API

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:

The C# agent is running on port 8000
Your OpenAI API key is set via .NET user secrets
Both servers started successfully (check terminal output)

.NET SDK Not Installed

If you don't have .NET 9.0 installed:

macOS/Linux (Homebrew):

brew install dotnet@9
dotnet --version

macOS/Linux (Install Script):

curl -sSL https://dot.net/v1/dotnet-install.sh | bash /dev/stdin --channel 9.0
export PATH="$HOME/.dotnet:$PATH"

Windows (WinGet):

winget install --id=Microsoft.DotNet.SDK.9 -e

Windows/macOS (Direct Download):

Visit https://dotnet.microsoft.com/download/dotnet/9.0
Download and run the installer

.NET SDK Issues

If you encounter .NET-related errors:

# Verify .NET SDK is installed
dotnet --version  # Should be 9.0.x or higher

# Restore packages manually
cd agent
dotnet restore
dotnet run

OpenAI API Key Issues

If the agent fails to start with "OPENAI_API_KEY not found":

cd agent
dotnet user-secrets set OPENAI_API_KEY "<your-openai-api-key>"

Port Conflicts

If port 8000 is already in use, you can change it in:

agent/Properties/launchSettings.json - Update applicationUrl
src/app/api/copilotkit/route.ts - Update the HttpAgent URL