-
Notifications
You must be signed in to change notification settings - Fork 8
Update Readme's #44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mrunalhirve128
merged 20 commits into
main
from
users/mrunalhirve/AddReadMeForProjectsJs
Nov 13, 2025
Merged
Update Readme's #44
Changes from 4 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
38d9144
initial
mrunalhirve128 4184119
Fix
mrunalhirve128 c1b0b04
Update Readme
mrunalhirve128 10333c9
edits
JimDaly 82d08e7
resolving comment
abdulanu0 4298bdc
resolved comment
abdulanu0 3579da5
Merge branch 'main' into users/mrunalhirve/AddReadMeForProjectsJs
mrunalhirve128 922c585
Update packages/agents-a365-observability/README.md
JimDaly 910ebca
Update packages/agents-a365-tooling-extensions-claude/README.md
JimDaly 6344171
adding telemetry and trademark messages
abdulanu0 d1d07aa
update branch
mrunalhirve128 4b552ed
push readme changes
mrunalhirve128 bc9b904
fix space
mrunalhirve128 20d1b25
Merge branch 'main' into users/mrunalhirve/AddReadMeForProjectsJs
mrunalhirve128 dfa5085
fix link
mrunalhirve128 77ab9ac
Merge branch 'users/mrunalhirve/AddReadMeForProjectsJs' of https://gi…
mrunalhirve128 bc9804a
fix
mrunalhirve128 7e8e996
Pr comments
mrunalhirve128 a1b348e
fix
mrunalhirve128 17fe32d
fix
mrunalhirve128 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,51 +1,129 @@ | ||
| # Microsoft Agent365 SDK for TypeScript | ||
| # Microsoft Agents 365 SDK - Node.js | ||
|
|
||
| The Microsoft Agent365 SDK provides comprehensive observability, tooling, and runtime capabilities for AI agents and tools built with TypeScript/Node.js. | ||
| [](https://www.npmjs.com/search?q=%40microsoft%2Fagents-a365) | ||
| [](https://www.npmjs.com/search?q=%40microsoft%2Fagents-a365) | ||
|
mrunalhirve128 marked this conversation as resolved.
|
||
| [](https://github.com/microsoft/Agent365-nodejs/actions) | ||
| [](LICENSE.md) | ||
| [](https://nodejs.org/) | ||
| [](https://github.com/microsoft/Agent365-nodejs/graphs/contributors) | ||
|
|
||
| ## 📦 Packages | ||
| > #### Note: | ||
| > Use the information in this README to contribute to this open-source project. To learn about using this SDK in your projects, refer to the [Microsoft Agents 365 developer documentation](https://learn.microsoft.com/microsoft-agent-365/developer/). | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| This monorepo contains several specialized packages: | ||
| The Microsoft Agents 365 SDK extends the Microsoft 365 Agents SDK with enterprise-grade capabilities for building sophisticated agents. This SDK provides comprehensive tooling for observability, notifications, runtime utilities, and development tools that help developers create production-ready agents for platforms including M365, Teams, Copilot Studio, and Webchat. | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### 🔍 **Observability** | ||
| - **[@microsoft/agents-a365-observability](./packages/agents-a365-observability/README.md)** - OpenTelemetry-based tracing and monitoring for AI agents | ||
| - Agent invocation tracking with caller context | ||
| - Tool execution monitoring with endpoint support | ||
| - LLM inference telemetry with granular token tracking | ||
| - Baggage propagation for distributed agent systems | ||
| The Microsoft Agents 365 SDK focuses on four core areas: | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### 🛠️ **Tooling & Extensions** | ||
| - **[@microsoft/agents-a365-tooling](./packages/agents-a365-tooling/README.md)** - Core MCP (Model Context Protocol) tooling infrastructure | ||
| - **[@microsoft/agents-a365-tooling-extensions-claude](./packages/agents-a365-tooling-extensions-claude/README.md)** - Claude/Anthropic integration | ||
| - **[@microsoft/agents-a365-tooling-extensions-langchain](./packages/agents-a365-tooling-extensions-langchain/README.md)** - LangChain integration | ||
| - **[@microsoft/agents-a365-tooling-extensions-openai](./packages/agents-a365-tooling-extensions-openai/README.md)** - OpenAI integration | ||
| - **Observability**: Comprehensive tracing, caching, and monitoring capabilities for agent applications | ||
| - **Notifications**: Agent notification services and models for handling user notifications | ||
| - **Runtime**: Core utilities and extensions for agent runtime operations | ||
| - **Tooling**: Developer tools and utilities for building sophisticated agent applications | ||
|
|
||
| ### 🚀 **Runtime & Infrastructure** | ||
| - **[@microsoft/agents-a365-runtime](./packages/agents-a365-runtime/README.md)** - Authentication, authorization, and Power Platform integration | ||
| - **[@microsoft/agents-a365-notifications](./packages/agents-a365-notifications/README.md)** - Agent notification and messaging system | ||
| ## Current Project State | ||
|
|
||
| This project is currently in active development. Packages are published to npm as they become available. | ||
|
|
||
| ## 📋 **Package Overview** | ||
| ### Public npm feed | ||
|
|
||
| | Package | Purpose | Key Features | | ||
| |---------|---------|--------------| | ||
| | **Observability** | Monitoring & Tracing | OpenTelemetry, Azure Monitor, Agent/Tool/Inference tracking | | ||
| | **Tooling** | MCP Infrastructure | Tool registration, configuration, server management | | ||
| | **Runtime** | Auth & Platform | Microsoft identity, Power Platform APIs, token management | | ||
| | **Notifications** | Messaging | Agent notifications, email integration, activity tracking | | ||
| | **Extensions** | LLM Integrations | OpenAI, Claude, LangChain tool registration | | ||
| The best way to consume this SDK is via our npm packages found here: [npmjs.com](https://www.npmjs.com/search?q=%40microsoft%2Fagents-a365). All packages begin with **@microsoft/agents-a365**. | ||
|
|
||
| ## Working with this codebase | ||
|
|
||
| ## 📋 **Telemetry** | ||
| ### Prerequisites | ||
|
|
||
| Data Collection. The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. | ||
| - Node.js 18 or later | ||
| - pnpm package manager | ||
| - Git | ||
|
|
||
| ### Building the project | ||
|
|
||
| 1. Clone the repository: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/microsoft/Agent365-nodejs.git | ||
| cd Agent365-nodejs | ||
| ``` | ||
|
|
||
| 2. Install dependencies: | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| 3. Build the packages: | ||
|
|
||
| ```bash | ||
| # Build all packages | ||
| pnpm build | ||
| ``` | ||
|
|
||
| 4. Run tests: | ||
|
|
||
| ```bash | ||
| pnpm test | ||
| ``` | ||
|
|
||
| For more detailed build instructions, see the [HOW_TO_BUILD.md](HOW_TO_BUILD.md). | ||
|
|
||
| ## Project Structure | ||
|
|
||
| - **packages/agents-a365-notifications**: Microsoft Agents 365 Notifications - Agent notification services and models | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
| - **packages/agents-a365-observability**: Microsoft Agents 365 Observability Core - Core observability functionality | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
| - **packages/agents-a365-observability-extensions-openai**: OpenAI observability extensions | ||
| - **packages/agents-a365-runtime**: Microsoft Agents 365 Runtime - Core runtime utilities and extensions | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
| - **packages/agents-a365-tooling**: Microsoft Agents 365 Tooling - Agent tooling and MCP integration | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
| - **packages/agents-a365-tooling-extensions-claude**: Claude/Anthropic tooling extensions | ||
| - **packages/agents-a365-tooling-extensions-langchain**: LangChain tooling extensions | ||
| - **packages/agents-a365-tooling-extensions-openai**: OpenAI tooling extensions | ||
| - **samples/**: For sample applications, see the [Agent365-Samples repository](https://github.com/microsoft/Agent365-Samples/tree/main/nodejs) | ||
|
mrunalhirve128 marked this conversation as resolved.
Outdated
|
||
| - **tests/**: Unit and integration tests | ||
|
|
||
| ## Support | ||
|
|
||
| For issues, questions, or feedback: | ||
|
|
||
| - **Issues**: Please file issues in the [GitHub Issues](https://github.com/microsoft/Agent365-nodejs/issues) section | ||
| - **Documentation**: See the [Microsoft Agents 365 developer documentation](https://learn.microsoft.com/microsoft-agent-365/developer/) | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
| - **Security**: For security issues, please see [SECURITY.md](SECURITY.md) | ||
|
|
||
| ## Contributing | ||
|
|
||
| This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>. | ||
|
|
||
| When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
|
|
||
| ## Trademarks | ||
|
|
||
| *Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.* | ||
| This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. | ||
|
|
||
| ## Useful Links | ||
|
|
||
| ### Microsoft 365 Agents SDK | ||
|
|
||
| The core SDK for building conversational AI agents for Microsoft 365 platforms. | ||
|
|
||
| - [Microsoft 365 Agents SDK](https://aka.ms/agents) | ||
| - [Agents-for-net repository](https://github.com/Microsoft/Agents-for-net) | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
| - [Agents-for-js repository](https://github.com/Microsoft/Agents-for-js) | ||
|
mrunalhirve128 marked this conversation as resolved.
Outdated
|
||
| - [Agents-for-python repository](https://github.com/Microsoft/Agents-for-python) | ||
| - [Official Agents Documentation](https://learn.microsoft.com/microsoft-365/agents-sdk/) | ||
|
|
||
| ### Microsoft Agents 365 SDK | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| Enterprise-grade extensions for observability, notifications, runtime utilities, and developer tools. | ||
|
|
||
| - [Agent365-dotnet repository](https://github.com/microsoft/Agent365-dotnet) | ||
| - [Agent365-python repository](https://github.com/microsoft/Agent365-python) | ||
| - [Agent365-nodejs repository](https://github.com/microsoft/Agent365-nodejs) - You are here | ||
| - [Agent365-Samples repository](https://github.com/microsoft/Agent365-Samples) | ||
|
mrunalhirve128 marked this conversation as resolved.
Outdated
|
||
| - [Microsoft Agents 365 developer documentation](https://learn.microsoft.com/microsoft-agent-365/developer/) | ||
|
abdulanu0 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Additional Resources | ||
|
|
||
| - [Node.js documentation](https://learn.microsoft.com/javascript/api/?view=m365-agents-sdk&preserve-view=true) | ||
|
|
||
| ## 📄 **License** | ||
| ## Data Collection Notice | ||
|
|
||
| This project is licensed under the MIT License - see the LICENSE file for details. | ||
| The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.