Quickstart

Turn your Microsoft Agent Framework agent into an agent-native application in 10 minutes.

Start with your coding agent

Use this prompt to connect your Microsoft Agent Framework agent to CopilotKit and verify a working conversation. Your coding agent will follow this guide in your project, or you can work through the manual steps below.

Open your coding agent in your project's folder, or in an empty folder for a new app.

Prerequisites

Before you begin, you'll need the following:

  • An OpenAI API key for the .NET starter
  • .NET 9.0 SDK or later, for a .NET agent
  • Python 3.12 or later and uv, for a Python agent
  • Node.js 20+
  • Your favorite package manager (npm, pnpm, yarn, or bun)

Getting started

Set up CopilotKit Intelligence

Sign in to cloud-hosted Intelligence. You will connect the app after you create it below.

Choose your starting point

You can either start fresh with our starter template or integrate CopilotKit into your existing Microsoft Agent Framework agent.

Run our CLI

npx copilotkit@latest create

The CLI walks you through:

  • Project name
  • CopilotKit Intelligence: persistent threads and the Inspector. Choose Yes for a project that is wired to Intelligence. Choose No for a standard Microsoft Agent Framework setup.
  • Framework: pick Microsoft Agent Framework (.NET) or Microsoft Agent Framework (Python).

Install dependencies

The starter includes a postinstall script that automatically installs both your npm and agent dependencies.

npm install
Manual setup

If you have issues with automatic .NET package installation, you can manually restore them:

npm run install:agent

Configure your environment

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

cd agent
dotnet user-secrets set OPENAI_API_KEY "<your-openai-api-key>"
cd ..
Want to use a different model provider?

Edit agent/Program.cs to use Azure OpenAI or another Microsoft Agent Framework model provider.

Start the development server

npm run dev

This will start both the Next.js UI (port 3000) and agent server (port 8000) concurrently.

Start chatting

Open http://localhost:3000 and open the sidebar. Send one of these messages, and the agent replies in the sidebar:

  • Can you tell me a joke?
  • Can you help me understand AI?
  • What do you think about .NET?

Open Inspector and confirm setup

On localhost, click the Inspector button in the corner of the app.

  1. Open Inspect, then Agent. Your agent is listed.
  2. Send a chat message. Open Inspect, then AG-UI Events. Events are moving.
  3. Open Rich Threads. The list is unlocked (Intelligence is on), or locked with Copy setup prompt (Intelligence is off).

More detail: Inspector.

What's next?

Now that you have your basic agent setup, explore these advanced features:

How is this guide?