Populate empty package READMEs with usage examples #196

Copilot · 2025-10-31T00:53:24Z

Populate empty package READMEs with usage examples.

Completed Tasks ✓

Summary

Updated 5 package READMEs based on review feedback:

Updated Packages

microsoft-teams-ai (37 → 59 lines)
- Now showcases ChatPrompt instead of Agent
- Added function calling example with handler
- Added docs link
microsoft-teams-mcpplugin (39 → 74 lines)
- Added MCP Client example with use_mcp_server()
- Added MCP Server example with use_tool()
- Both examples match actual test implementation patterns
- Added docs link
microsoft-teams-a2a (42 → 75 lines)
- Removed "Protocol" from title
- Updated to match test implementation with proper AgentCard
- Added A2A Server example with complete AgentCard setup
- Added A2A Client example using A2AClientPlugin
- Uses correct card_url from tests
microsoft-teams-openai (32 lines)
- Now uses ChatPrompt instead of Agent
microsoft-teams-devtools (38 → 36 lines)
- Added docs link
- Removed port specification (uses default)

Each README now shows realistic usage patterns verified against test applications.

Validation

✓ All linting checks pass (ruff)
✓ All formatting checks pass
✓ Documentation-only changes
✓ Examples match test implementation patterns
✓ All examples use ChatPrompt consistently
✓ A2A examples grounded in actual test code

Original prompt

We have a lot of our READMEs for packages that are currently basically empty. Can you populate them? Avoid being too verbose.
Try

Try

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

heyitsaamir · 2025-10-31T01:09:36Z

@copilot

if you’re including snippets, they should be grounded with example from the tests folder

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

heyitsaamir · 2025-10-31T01:17:16Z

@copilot

too many details. If showing snippets just show basic use case

heyitsaamir · 2025-10-31T07:13:55Z

@copilot too many details. If showing snippets just show basic use case

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot · 2025-10-31T07:20:33Z

@copilot too many details. If showing snippets just show basic use case

Simplified all 5 READMEs to show only basic use cases. Removed detailed sections, multiple examples, and feature lists. Each now has just Installation and Usage sections with one simple example. (5c21554)

heyitsaamir

@copilot work on the fixes i suggested

packages/mcpplugin/README.md

packages/a2aprotocol/README.md

packages/ai/README.md

packages/mcpplugin/README.md

packages/devtools/README.md

…erver/client examples and docs links Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot · 2025-10-31T15:59:15Z

@copilot work on the fixes i suggested

Addressed all suggested fixes in commit f146a68:

AI: Now showcases ChatPrompt + function calling with docs link
MCP: Shows both client and server examples with docs link
A2A: Shows both server and client examples
DevTools: Added docs link

…valid constructor params Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

heyitsaamir

@copilot fix

packages/a2aprotocol/README.md

packages/openai/README.md

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot · 2025-10-31T16:32:54Z

@copilot fix

Fixed both issues in commit c5599a4:

A2A: Removed "Protocol" from title
OpenAI: Changed to use ChatPrompt instead of Agent

Copilot

Pull Request Overview

This PR enhances the README documentation for five Microsoft Teams AI Library packages by adding comprehensive installation and usage examples. The goal is to provide clearer onboarding documentation for developers using these packages.

Replaced generic documentation links with specific installation instructions using uv add
Added practical code examples showing how to instantiate and use core classes from each package
Standardized README format across packages with Installation and Usage sections

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/openai/README.md	Added installation instructions and basic usage example for OpenAICompletionsAIModel with ChatPrompt
packages/mcpplugin/README.md	Created complete README with MCP client and server usage examples, including tool registration
packages/devtools/README.md	Added installation and usage example showing DevToolsPlugin integration with App
packages/ai/README.md	Added comprehensive examples for ChatPrompt and Function calling patterns
packages/a2aprotocol/README.md	Added A2A server and client usage examples with agent configuration

packages/mcpplugin/README.md

packages/a2aprotocol/README.md

packages/devtools/README.md

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

…d setup Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

- Remove support for 3.14 (#207) - Add Federated Identity Credentials support (#203) - Add User Managed Identity support via MSAL (#192) - Introduce msal (#191) - Populate empty package READMEs with usage examples (#196) - Rename Teams AI to Teams SDK 🎉 (#201) - HTTPPlugin : Add a builder option to provide custom server (enables providing options like ssl etc) (#185) - get type hint of class, not object (#202) - Temporary: skip streaming tests (#200) - Fix workflow

Initial plan

1bde601

Copilot AI assigned Copilot and heyitsaamir Oct 31, 2025

Copilot started work on behalf of heyitsaamir October 31, 2025 00:53 View session

Copilot AI and others added 3 commits October 31, 2025 00:59

Populate package READMEs with documentation

85509b7

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Fix class names in README examples to match actual API

efc82c8

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Fix API method calls in README examples

5051e92

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Fix remaining API details in README examples

19e1e5e

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add content to empty README files~~ Populate empty package READMEs with API documentation Oct 31, 2025

Copilot AI requested a review from heyitsaamir October 31, 2025 01:13

Copilot finished work on behalf of heyitsaamir October 31, 2025 01:13

Copilot started work on behalf of heyitsaamir October 31, 2025 01:14 View session

Copilot finished work on behalf of heyitsaamir October 31, 2025 01:15

Copilot started work on behalf of heyitsaamir October 31, 2025 01:17 View session

Copilot finished work on behalf of heyitsaamir October 31, 2025 01:18

Copilot started work on behalf of heyitsaamir October 31, 2025 07:14 View session

Simplify READMEs to show only basic use cases

5c21554

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot AI changed the title ~~Populate empty package READMEs with API documentation~~ Populate empty package READMEs with basic usage examples Oct 31, 2025

Copilot finished work on behalf of heyitsaamir October 31, 2025 07:21

heyitsaamir reviewed Oct 31, 2025

View reviewed changes

Copilot started work on behalf of heyitsaamir October 31, 2025 15:53 View session

Address feedback: Add ChatPrompt, functions, MCP server/client, A2A s…

f146a68

…erver/client examples and docs links Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot AI changed the title ~~Populate empty package READMEs with basic usage examples~~ Populate empty package READMEs with usage examples Oct 31, 2025

Copilot AI requested a review from heyitsaamir October 31, 2025 16:00

Copilot finished work on behalf of heyitsaamir October 31, 2025 16:00

Copilot started work on behalf of heyitsaamir October 31, 2025 16:23 View session

Fix MCP Client example to use use_mcp_server() with URL instead of in…

0adb7ef

…valid constructor params Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot finished work on behalf of heyitsaamir October 31, 2025 16:28

heyitsaamir reviewed Oct 31, 2025

View reviewed changes

packages/a2aprotocol/README.md Outdated Show resolved Hide resolved

packages/openai/README.md Outdated Show resolved Hide resolved

Copilot started work on behalf of heyitsaamir October 31, 2025 16:30 View session

Fix A2A title and OpenAI example to use ChatPrompt

c5599a4

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

heyitsaamir marked this pull request as ready for review October 31, 2025 16:34

Copilot AI review requested due to automatic review settings October 31, 2025 16:34

heyitsaamir approved these changes Oct 31, 2025

View reviewed changes

Copilot AI requested a review from heyitsaamir October 31, 2025 16:36

Copilot finished work on behalf of heyitsaamir October 31, 2025 16:36

Copilot AI reviewed Oct 31, 2025

View reviewed changes

packages/mcpplugin/README.md Show resolved Hide resolved

packages/a2aprotocol/README.md Show resolved Hide resolved

lilyydu reviewed Oct 31, 2025

View reviewed changes

packages/a2aprotocol/README.md Outdated Show resolved Hide resolved

packages/devtools/README.md Outdated Show resolved Hide resolved

Copilot started work on behalf of heyitsaamir October 31, 2025 17:03 View session

Remove port specification from DevTools example

235f340

Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot finished work on behalf of heyitsaamir October 31, 2025 17:07

Copilot started work on behalf of heyitsaamir October 31, 2025 17:07 View session

Update A2A examples to match test implementation with proper AgentCar…

80baf09

…d setup Co-authored-by: heyitsaamir <48929123+heyitsaamir@users.noreply.github.com>

Copilot finished work on behalf of heyitsaamir October 31, 2025 17:12

heyitsaamir approved these changes Nov 5, 2025

View reviewed changes

lilyydu approved these changes Nov 5, 2025

View reviewed changes

heyitsaamir added 4 commits November 5, 2025 16:30

Update documentation link for Teams SDK

a67178f

Update README.md

16ff31b

Update documentation link for MCP integration

6fa2d3e

Merge branch 'main' into copilot/populate-empty-readmes

ed82309

heyitsaamir merged commit e9bb4b4 into main Nov 6, 2025
7 checks passed

heyitsaamir deleted the copilot/populate-empty-readmes branch November 6, 2025 00:56

heyitsaamir mentioned this pull request Nov 10, 2025

Release version 2.0.0a5 #208

Merged

Populate empty package READMEs with usage examples #196

Populate empty package READMEs with usage examples #196

Uh oh!

Conversation

Copilot AI commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Completed Tasks ✓

Summary

Updated Packages

Validation

Uh oh!

heyitsaamir commented Oct 31, 2025

Uh oh!

heyitsaamir commented Oct 31, 2025

Uh oh!

heyitsaamir commented Oct 31, 2025

Uh oh!

Copilot AI commented Oct 31, 2025

Uh oh!

heyitsaamir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Oct 31, 2025

Uh oh!

heyitsaamir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Oct 31, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Oct 31, 2025 •

edited

Loading