Skip to content

DB - 7 new best practices#75

Open
CATDAB wants to merge 5 commits intomainfrom
DAB-openai-rai-mcp-deterministic-adaptive-card-citations
Open

DB - 7 new best practices#75
CATDAB wants to merge 5 commits intomainfrom
DAB-openai-rai-mcp-deterministic-adaptive-card-citations

Conversation

@CATDAB
Copy link
Copy Markdown
Collaborator

@CATDAB CATDAB commented Mar 19, 2026

  • RAI Error Handling — Catch OpenAI RAI content filtering errors in the OnError topic, classify by subcode (violence, hate, sexual, self-harm, jailbreak, indirect attack), and return targeted user-friendly responses instead of generic error messages
    • Deterministic MCP Server Tool Calls — Two approaches for ensuring MCP tools fire reliably: naming them in agent instructions or wrapping them in a dedicated child agent with trigger phrases
    • Citations in Adaptive Cards for Teams — Replace default Teams citation rendering with a collapsible Adaptive Card showing numbered, clickable references using ForAll() over CitationSources

@CATDAB CATDAB requested a review from GiorgioUghini March 19, 2026 04:04
@CATDAB CATDAB marked this pull request as draft March 19, 2026 21:27
…s, and update RAI error handling

Added four new best practice files and updated existing ones:
- knowledge-hold-message: randomized hold message during knowledge search
- start-over-restart-conversation-v2: channel-aware Start Over with Adaptive Cards and Reset Conversation v2
- line-breaks-in-messages: using <br /> tags for paragraph spacing in message and question nodes
- rai-error-handling: updated with corrected full topic YAML
@CATDAB CATDAB force-pushed the DAB-openai-rai-mcp-deterministic-adaptive-card-citations branch from e714436 to 0b2f2b2 Compare March 19, 2026 21:30
@CATDAB CATDAB marked this pull request as ready for review March 19, 2026 21:30
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.

Like the approach.
But we should add a bit more information before adding it :

  1. Do we targer every channel or only Teams / Copilot ?
  2. in the Challenge / Why highlight limited support for streamind UI patterns that would diplay planner actions.
  3. in the solution share that we are actually send a message that will induce a behavior change. We've seen customers not liking multiple messages in a response.

Also I would strongly push back on Option B as OnKnowledgeRequest topics are run sequentially adding latency on top of normal processing. AI Prompt usually takes between 4 to 6 sec e2e adding too much latency. A normal knowledge search take 7s so we are adding near to 80% more.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Agree on all counts. Will update the best practice accordingly.

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.

Step one you should apply the same filtering logic to only change that for the teams channel using the channelID condition used in another BP you shared. Today CA publish in Teams are published in Copilot that might not be the same in output.
For me this one need a big change as it covers only topics with Generative answer node.
I would extend this BP to leverage this article : https://microsoft.github.io/mcscatblog/posts/remove-citations-in-copilot-studio-answer/ so we are more comprehensive in the response generated.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Pulled this one from the PR will combine with citation delete.

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.

I'm not sure the AI prompt is needed.
I believe that the RAI Subcodes is included in the System.Error.Code so just the condition approach would be good and way faster.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

100% agree subcode checking is faster. I confirmed today that they are currently not being returned for a customer of mine and in my environments with gpt5 ICM here: https://portal.microsofticm.com/imp/v5/incidents/details/763985063/summary. I can pull this one out of the pr until we get closure. If subcodes are indeed broken we'll go with the prompt method, if they start working again I'll update to subcode check condition first with a prompt as a backup.

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.

For the Knowledge-hold-message I would change that phrase :
Read this best-practice when:

  • The user specifically complains about latency or slow response times during knowledge search

It should be : "The user complains about the lack of activity or streaming UI during knowledge search"

Your BP is not helping about reducing the response time, it could be missleading :)

CATDAB added 2 commits March 20, 2026 16:50
…ling from PR

- Added channel targeting, streaming UI limitations, multiple message trade-off, and latency warning against AI prompts in OnKnowledgeRequested
- Updated SKILL.md trigger criteria for knowledge hold message pattern
- Removed RAI error handling best practice from this PR (to be published separately)
@CATDAB CATDAB requested a review from ericsche March 20, 2026 20:58
…riable, and RAI error handling

- chain-of-thought-logging: surfaces intermediate reasoning steps as messages during complex orchestration
- conversation-history-variable: captures conversation transcript into a variable for escalation, ticketing, or tool input
- rai-error-handling: classifies OpenAI RAI content filtering errors by subcode with targeted responses
- Updated SKILL.md index with new entries and search keywords
@CATDAB CATDAB changed the title This commit includes three new best practice md files DB - new best practices Mar 24, 2026
@CATDAB CATDAB changed the title DB - new best practices DB - 7 new best practices Mar 24, 2026
@CATDAB
Copy link
Copy Markdown
Collaborator Author

CATDAB commented Mar 24, 2026

PR now contains 7 best practice files plus the SKILL.md update:

  1. chain-of-thought-logging.md
  2. conversation-history-variable.md
  3. deterministic-mcp-calls.md
  4. knowledge-hold-message.md
  5. line-breaks-in-messages.md
  6. rai-error-handling.md
  7. start-over-restart-conversation-v2.md

@ChrisGarty ChrisGarty added the type/docs Documentation only label Apr 7, 2026
@microsoft-github-policy-service
Copy link
Copy Markdown

@CATDAB please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants