-
Notifications
You must be signed in to change notification settings - Fork 221
Add documentation for Agentic Identity concepts and common errors #339
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces comprehensive documentation for Agentic Identity in the M365 Agents SDK. The document explains key concepts, configuration settings, and common error scenarios for working with autonomous agents that behave like user accounts.
- Defines core concepts: Agentic Users, Agent ID Blueprint, Agent Identity, and related terms
- Provides placeholder sections for language-specific configuration (Python, C#, JavaScript) and error troubleshooting
- Establishes deep-linking infrastructure using aka.ms URLs for error documentation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Introduce the error handling / documentation framework for covering Agentic Identity concepts, configuration settings, and common errors encountered when using the M365 Agents SDK. This addition aims to enhance understanding and troubleshooting for developers working with autonomous agents.
Although I'm only starting with the Agentic Identity configuration & errors, this approach is extensible across other forms of errors generated by the Agents SDK.
Related to #284
Related to #294
This PR defines a document outline, with each of the headers suitable for deep-linking from the C#, Python, and JS SDKs.
The general format for these is found in the document, but looks like:
The AKA allows us to retarget the location of the document (either across GitHub repos, learn SDK documentation, or whatever) while the hashtag (#) following the standard GitHub convention allows the link to be durable. Once this Pr is merged into main the AKA link will be updated to point to the main branch.
The AKA is currently targeting this branch (not main) as it's link resolution:

For example:
Next steps: