Get started with Teams AI library v2 (preview)

[This article is prerelease documentation and is subject to change.]

Get started with Teams AI Library (v2) quickly using the Teams CLI.

Set up a new project

Prerequisites

• Node.js v.20 or higher. Install or upgrade from nodejs.org.

Instructions

Install the Teams CLI

Use your terminal to install the Teams CLI globally using npm:

npm install -g @microsoft/teams.cli@preview

Creating Your First Agent

Let's create a simple echo agent that responds to messages. Run:

teams new quote-agent --template echo

This command:

1. Creates a new directory called quote-agent.
2. Bootstraps the echo agent template files into it under quote-agent/src.
3. Creates your agent's manifest files, including a manifest.json file and placeholder icons in the quote-agent/appPackage directory. The Teams app manifest is required for sideloading the app into Teams.

The echo template creates a basic agent that repeats back any message it receives - perfect for learning the fundamentals.

Running your agent

Navigate to your new agent's directory:

cd quote-agent

Install the dependencies:

npm install

Start the development server:

npm run dev

In the console, you should see a similar output:

> [email protected] dev
> npx nodemon -w "./src/**" -e ts --exec "node -r ts-node/register -r dotenv/config ./src/index.ts"

[nodemon] 3.1.9
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): src/**
[nodemon] watching extensions: ts
[nodemon] starting `node -r ts-node/register -r dotenv/config ./src/index.ts`
[WARN] @teams/app/devtools ⚠️  Devtools are not secure and should not be used production environments ⚠️
[INFO] @teams/app/http listening on port 3000 🚀
[INFO] @teams/app/devtools available at http://localhost:3001/devtools

When the application starts, you'll see:

1. An http server starting up (on port 3000). This is the main server which handles incoming requests and serves the agent application.
2. A devtools server starting up (on port 3001). This is a developer server that provides a web interface for debugging and testing your agent quickly, without having to deploy it to Teams.

Let's navigate to the devtools server. Open your browser and head to http://localhost:3001/devtools. You should see a simple interface where you can interact with your agent. Send it a message!

Next steps

Now that you have your first agent running, learn about the code basics to understand its components and structure.

Otherwise, if you want to run your agent in Teams, check out the Running in Teams guide.

Resources

• Teams CLI documentation
• Teams DevTools documentation
• Teams manifest schema
• Teams sideloading