Skip to content

Add AGENTS.md to TypeScript AI template#446

Merged
corinagum merged 6 commits into
microsoft:mainfrom
SidU:add-agents-md-to-ai-template
Feb 17, 2026
Merged

Add AGENTS.md to TypeScript AI template#446
corinagum merged 6 commits into
microsoft:mainfrom
SidU:add-agents-md-to-ai-template

Conversation

@SidU

@SidU SidU commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds comprehensive AGENTS.md guidance file to the TypeScript AI template
  • Enables AI coding assistants (Claude Code, Copilot, Cursor, etc.) to help developers more effectively
  • Includes critical setup requirements, Azure Bot registration workflow, and troubleshooting guide

What's in the AGENTS.md

  • Critical Setup Requirements: Common gotchas that cause bots to fail silently (service principal, credential names, etc.)
  • Azure Bot Registration: Step-by-step CLI commands for registering a bot in Azure
  • Teams App Package: Instructions for creating and sideloading the app manifest
  • SDK Patterns: TypeScript code examples for events, ChatPrompt, streaming, tools, cards, and auth
  • Troubleshooting: Detailed solutions for common issues like 401 errors, missing service principal, etc.
  • Quick Start: Instructions for getting the bot running after provisioning

Test plan

  • Generate a new project with npx @microsoft/teams.cli new typescript test-bot --template ai
  • Verify AGENTS.md is included in the generated project
  • Verify the content is accurate and helpful for AI assistants

🤖 Generated with Claude Code

CG: skip-test-verification

Adds comprehensive guidance for AI coding assistants working on Teams SDK
projects generated from the AI template. The file includes:

- Critical setup requirements and common gotchas
- Azure Bot registration workflow with CLI commands
- Teams app package creation instructions
- SDK patterns and TypeScript code examples
- Detailed troubleshooting guide
- Quick start instructions after provisioning

This enables AI assistants like Claude Code, Copilot, and Cursor to help
developers create, deploy, and extend Teams bots more effectively.

Co-Authored-By: Claude Opus 4.5 <[email protected]>

@rido-min rido-min left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of adding all the content to our template, I'd like to suggest to keep this doc in the repo and reference it from the AGENTS.md we can add to the template.

There are some required changes:

  • App ctor does not need to override credentials (so it will work without secrets)
  • Rethink if we want to keep using our chatprompt instead of vercel/foundry
  • avoid ngrok references

Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Comment thread packages/cli/templates/typescript/ai/AGENTS.md Outdated
Co-Authored-By: Claude Opus 4.5 <[email protected]>
@SidU

SidU commented Feb 11, 2026

Copy link
Copy Markdown
Contributor Author

Instead of adding all the content to our template, I'd like to suggest to keep this doc in the repo and reference it from the AGENTS.md we can add to the template.

There are some required changes:

  • App ctor does not need to override credentials (so it will work without secrets)
  • Rethink if we want to keep using our chatprompt instead of vercel/foundry
  • avoid ngrok references

All great suggestions. Incorporated.

siduppal and others added 2 commits February 10, 2026 18:10
Make it clearer that the agent needs to fetch and follow the linked
instructions to actually run the bot in Teams.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Avoids confusion with a future AGENTS.md for SDK contributors.
The template file is specifically for generated bot projects to fetch.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Comment thread AGENTS_TEMPLATE.md Outdated
Comment thread AGENTS_TEMPLATE.md Outdated
- Change sign-in-audience from AzureADMultipleOrgs to AzureADMyOrg to
  align with SingleTenant bot registration
- Update Node.js requirement from 18+ to >= 20 (LTS) since teams.ts
  doesn't support Node 18

Co-Authored-By: Claude Opus 4.6 <[email protected]>

@corinagum corinagum left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@corinagum
corinagum merged commit 6ca623f into microsoft:main Feb 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants