Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Get started with Teams SDK quickly using the Teams Developer CLI.
Set up a new project
Prerequisites
- .NET v8 or higher. Install or upgrade from dotnet.microsoft.com.
- Python v3.12 or higher. Install or upgrade from python.org/downloads.
- Node.js v.22.12 or higher. Install or upgrade from nodejs.org.
Instructions
Install the Teams Developer CLI
Install teams globally:
npm install -g @microsoft/teams.cli
teams --version
Note
The Teams Developer CLI is the command-line tool for scaffolding, registering, and managing Teams apps.
Creating Your First Agent
Let's begin by creating a simple echo agent that responds to messages. Run:
teams project new csharp quote-agent --template echo
teams project new python quote-agent --template echo
teams project new typescript quote-agent --template echo
This command:
- Creates a new directory called
QuoteAgent. - Bootstraps the echo agent template files into your project directory.
- Creates a new directory called
quote-agent. - Bootstraps the echo agent template files into it under
quote-agent/src.
The
echotemplate 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 QuoteAgent/QuoteAgent
- Install the dependencies:
dotnet restore
- Start the development server:
dotnet run
Navigate to your new agent's directory:
cd quote-agent
Create and activate a virtual environment, then install the dependencies:
python -m venv .venv
# Activate it: `source .venv/bin/activate` (macOS/Linux) or `.venv\Scripts\activate` (Windows)
pip install -e .
Start the development server:
python src/main.py
- 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:
info: Microsoft.Hosting.Lifetime[14]
Now listening on: http://localhost:3978
info: Microsoft.Hosting.Lifetime[0]
Application started. Press Ctrl+C to shut down.
In the console, you should see a similar output:
[INFO] @teams/app Successfully initialized all plugins
[INFO] @teams/app.HttpPlugin Starting HTTP server on port 3978
INFO: Started server process [6436]
INFO: Waiting for application startup.
[INFO] @teams/app.HttpPlugin listening on port 3978 🚀
[INFO] @teams/app Teams app started successfully
INFO: Application startup complete..
INFO: Uvicorn running on http://0.0.0.0:3978 (Press CTRL+C to quit)
- In the console, you should see a similar output:
> quote-agent@0.0.0 dev
> tsx watch -r dotenv/config src/index.ts
[WARN] @teams/app No credentials configured and dangerouslyAllowUnauthenticatedRequests is not enabled. All incoming requests will be rejected. Configure client authentication to securely receive messages, or set dangerouslyAllowUnauthenticatedRequests: true for local development.
[INFO] @teams/app listening on port 3978 🚀
The HTTP server is now listening on port 3978. To test your agent locally without sideloading it into Teams, use the Microsoft 365 Agents Playground.
The playground sends unauthenticated requests, which a default builder.AddTeams() rejects when no credentials are configured. For local testing, enable skipAuth so your agent accepts them:
builder.AddTeams(skipAuth: true);
Warning
Only use skipAuth for local development — never in production, as it disables inbound request authentication.
The playground sends unauthenticated requests, and SDK 2.1 rejects them by default. For local testing, enable DangerouslyAllowUnauthenticatedRequests in your launch settings:
{
"profiles": {
"https": {
"environmentVariables": {
"AzureAd__DangerouslyAllowUnauthenticatedRequests": "true"
}
}
}
}
Warning
Only use DangerouslyAllowUnauthenticatedRequests for local development — never in production, as it disables inbound request authentication.
Install the playground globally:
npm install -g @microsoft/m365agentsplayground
Then, with your agent still running, open a second terminal and launch the playground pointed at your agent:
agentsplayground -e http://localhost:3978/api/messages -c emulator
The playground opens at http://localhost:56150. Send a message in the compose box and your agent's reply renders inline.
The HTTP server is now listening on port 3978. To test your agent locally without sideloading it into Teams, use the Microsoft 365 Agents Playground.
The playground sends unauthenticated requests, so a default App() will reject them (you'll see the No credentials configured warning above). For local testing, enable dangerously_allow_unauthenticated_requests so your agent accepts them:
app = App(dangerously_allow_unauthenticated_requests=True)
Warning
Only use dangerously_allow_unauthenticated_requests for local development — never in production, as it disables inbound request authentication.
Install the playground globally:
npm install -g @microsoft/m365agentsplayground
Then, with your agent still running, open a second terminal and launch the playground pointed at your agent:
agentsplayground -e http://localhost:3978/api/messages -c emulator
The playground opens at http://localhost:56150. Send a message in the compose box and your agent's reply renders inline.
The HTTP server is now listening on port 3978. To test your agent locally without sideloading it into Teams, use the Microsoft 365 Agents Playground.
The playground sends unauthenticated requests, so a default new App() will reject them (you'll see the No credentials configured warning above). For local testing, enable dangerouslyAllowUnauthenticatedRequests so your agent accepts them:
const app = new App({ dangerouslyAllowUnauthenticatedRequests: true });
Warning
Only use dangerouslyAllowUnauthenticatedRequests for local development — never in production, as it disables inbound request authentication.
Install the playground globally:
npm install -g @microsoft/m365agentsplayground
Then, with your agent still running, open a second terminal and launch the playground pointed at your agent:
agentsplayground -e http://localhost:3978/api/messages -c emulator
The playground opens at http://localhost:56150. Send a message in the compose box and your agent's reply renders inline.
Add to an Existing Project
If you already have a project and want to add Teams support, install the SDK directly:
dotnet add package Microsoft.Teams.Apps
// Then register the Teams services on your existing app.
pip install microsoft-teams-apps
Then initialize the Teams app with your existing server:
npm i @microsoft/teams.apps
Then initialize the Teams app with your existing server:
using Microsoft.Teams.Apps;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddTeamsBotApplication();
var app = builder.Build();
// Maps POST /api/messages onto your existing ASP.NET Core app
TeamsBotApplication teams = app.UseTeamsBotApplication();
teams.OnMessage(async (context, cancellationToken) =>
{
await context.SendAsync($"you said: {context.Activity.Text}", cancellationToken);
});
app.Run();
app.UseTeamsBotApplication() registers the Teams endpoint onto your existing ASP.NET Core app.
import asyncio
import uvicorn
from fastapi import FastAPI
# highlight-next-line
from microsoft_teams.apps import App, FastAPIAdapter
# Your existing FastAPI app
my_fastapi = FastAPI()
# highlight-start
# Wrap your app in an adapter and create the Teams app
adapter = FastAPIAdapter(app=my_fastapi)
app = App(http_server_adapter=adapter)
@app.on_message
async def handle_message(ctx):
await ctx.send(f"You said: {ctx.activity.text}")
# highlight-end
async def main():
# highlight-next-line
await app.initialize() # Register the Teams endpoint (does not start a server)
# Start your server as usual
config = uvicorn.Config(app=my_fastapi, host="0.0.0.0", port=3978)
server = uvicorn.Server(config)
await server.serve()
asyncio.run(main())
app.initialize() registers the Teams endpoint on your server without starting a new one — you keep full control of your server lifecycle.
import http from 'http';
import express from 'express';
// highlight-next-line
import { App, ExpressAdapter } from '@microsoft/teams.apps';
// Your existing Express server
const expressApp = express();
const server = http.createServer(expressApp);
// highlight-start
// Wrap your server in an adapter and create the Teams app
const adapter = new ExpressAdapter(server);
const app = new App({ httpServerAdapter: adapter });
app.on('message', async ({ send, activity }) => {
await send(`You said: ${activity.text}`);
});
// Register the Teams endpoint on your server (does not start it)
await app.initialize();
// highlight-end
// Start your server as usual
server.listen(3978);
app.initialize() registers the Teams endpoint on your server without starting a new one — you keep full control of your server lifecycle.
See the HTTP Server guide for full details on adapters and custom server setups.
Next steps
After creating and running your first agent, read about the code basics to better understand its components and structure.
Otherwise, if you want to run your agent in Teams, you can check out the Running in Teams guide.