Skip to content

docs: add Work IQ MCP guided setup instructions and wire routing#381

Open
biswapm wants to merge 4 commits intomainfrom
pmohapatra-WokIQ-Aiguided
Open

docs: add Work IQ MCP guided setup instructions and wire routing#381
biswapm wants to merge 4 commits intomainfrom
pmohapatra-WokIQ-Aiguided

Conversation

@biswapm
Copy link
Copy Markdown
Contributor

@biswapm biswapm commented Apr 22, 2026

Summary

  • Adds a365-workiq-tools-instructions.md — a new AI agent instruction file for enabling Work IQ MCP tool integrations on an already-provisioned Agent 365 agent. Covers the full flow: a365 develop list-availableadd-mcp-serverssetup permissions mcp, V1-to-V2 migration guidance, Dataverse MCP server management, and SDK wiring for all supported platforms.
  • Adds Task E (SDK wiring) — covers package installation, startup DI registration, and per-turn add_tool_servers_to_agent / addToolServersToAgent / GetMcpToolsAsync code for Python, Node.js, and .NET Agent Framework. M365 custom engine agents (agentType=1) require no code changes. Patterns sourced from Agent365-Samples.
  • Updates README.md with a Work IQ entry and a three-option disambiguation question so coding agents route to the correct file.
  • Updates a365-setup-instructions.md Step 4 and Step 5 completion blocks to route to the new Work IQ instructions when capabilities include Work IQ (standalone and post-observability).
  • Updates a365-observability-instructions.md Task A completion to continue to Work IQ instructions when Work IQ was part of the originally selected capabilities.

Changes

File Change
a365-workiq-tools-instructions.md New file — Tasks A–E covering CLI + SDK wiring
README.md Added Work IQ entry; updated disambiguation question to 3 options
a365-setup-instructions.md Step 4 completion: added Work IQ routing (standalone + post-observability); Step 5 completion: added Work IQ routing after observability for AI Teammate path
a365-observability-instructions.md Task A completion: carve-out to continue to Work IQ when it was part of selected capabilities

Test plan

  • Verify AI agent following a365-setup-instructions.md with "Observability and Work IQ" capability routes to observability then Work IQ instructions in sequence
  • Verify AI agent following a365-setup-instructions.md with "Work IQ only" routes directly to Work IQ instructions
  • Verify AI agent following a365-observability-instructions.md standalone does NOT continue to Work IQ (no capabilities context)
  • Verify README correctly disambiguates between setup, observability, and Work IQ intents
  • Verify a365 develop list-availableadd-mcp-serverssetup permissions mcp flow described in the new file matches CLI behavior
  • Verify Task E Python snippet matches python/openai/sample-agent/agent.py wiring pattern
  • Verify Task E Node.js snippet matches nodejs/openai/sample-agent/src/client.ts wiring pattern
  • Verify Task E .NET snippet matches dotnet/agent-framework/sample-agent/Agent/MyAgent.cs wiring pattern

- Add a365-workiq-tools-instructions.md covering a365 develop
  list-available, add-mcp-servers, list-configured, setup permissions
  mcp, and V1-to-V2 migration guidance
- Update README with Work IQ entry and clarified disambiguation question
- Update a365-setup-instructions.md Step 4 and Step 5 completion to
  route to workiq instructions when capabilities include Work IQ
- Update a365-observability-instructions.md Task A completion to
  continue to workiq instructions when Work IQ is part of capabilities

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 22, 2026 07:26
@biswapm biswapm requested review from a team as code owners April 22, 2026 07:26
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 22, 2026

⚠️ Deprecation Warning: The deny-licenses option is deprecated for possible removal in the next major release. For more information, see issue 997.

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds guided documentation to enable Work IQ MCP tool integrations for an already-provisioned Agent 365 agent, and wires the existing guided-setup flow to route users/agents into the new Work IQ instructions when applicable.

Changes:

  • Added a new guided instruction file for discovering MCP servers, updating ToolingManifest.json, and applying MCP permissions (including V1→V2 guidance and Dataverse server management).
  • Updated guided setup and observability instruction completion routing to continue into Work IQ steps when capabilities includes Work IQ.
  • Updated the guided-setup README index to include a Work IQ intent entry and a 3-way intent disambiguation prompt.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
docs/agent365-guided-setup/a365-workiq-tools-instructions.md New end-to-end Work IQ MCP integration guide (catalog → manifest → permissions → verification), plus migration and advanced Dataverse management.
docs/agent365-guided-setup/a365-setup-instructions.md Routes post-setup flow to observability and/or Work IQ instruction files based on selected capabilities.
docs/agent365-guided-setup/a365-observability-instructions.md Allows an explicit follow-on route to Work IQ instructions when capabilities context includes Work IQ.
docs/agent365-guided-setup/README.md Adds Work IQ entry and expands intent disambiguation prompt; updates “What NOT to do” guidance.

Comment thread docs/agent365-guided-setup/a365-workiq-tools-instructions.md Outdated
Comment thread docs/agent365-guided-setup/README.md
Comment thread docs/agent365-guided-setup/a365-workiq-tools-instructions.md
biswapm and others added 2 commits April 22, 2026 14:31
Adds Task E covering agent code changes required for non-M365 agents
(agentType=2) to consume Work IQ MCP tools at runtime. Covers package
installation, startup DI registration, and per-turn tool wiring for
Python (microsoft_agents_a365_tooling), Node.js
(@microsoft/agents-a365-tooling-extensions-openai), and .NET
(Microsoft.Agents.A365.Tooling.Extensions.AgentFramework), plus
environment variable reference for auth configuration. M365 custom
engine agents (agentType=1) are noted as not needing code changes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 22, 2026 09:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Comment on lines +257 to +259
from microsoft_agents_a365.tooling.services.mcp_tool_server_configuration_service import (
McpToolServerConfigurationService,
)
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

In the Python example, McpToolServerConfigurationService is imported but never used. Either remove this import or show how it’s used, otherwise copy/paste will produce linting errors and confusion.

Suggested change
from microsoft_agents_a365.tooling.services.mcp_tool_server_configuration_service import (
McpToolServerConfigurationService,
)

Copilot uses AI. Check for mistakes.
Use this file when the user asks to:
- Add Work IQ tools or MCP (Model Context Protocol) integrations to their agent
- Enable Microsoft 365 tool servers (Mail, Calendar, Teams, SharePoint, OneDrive, etc.)
- Configure `ToolingManifest.json` or run `a365 setup permissions mcp`
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

There is an extra trailing backtick in the inline code span for a365 setup permissions mcp, which breaks Markdown formatting. Remove the extra backtick so the command renders correctly.

Copilot uses AI. Check for mistakes.

| Error | Cause | Fix |
|-------|-------|-----|
| `Blueprint ID not found` | `a365 setup all` not run, or blueprint deleted | Run `a365 setup all` first |
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

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

The troubleshooting row for Blueprint ID not found suggests running a365 setup all, but the CLI error message and intended remediation for missing blueprint ID is to run a365 setup blueprint (or a365 setup all if you truly want the full flow). Updating this row to match the CLI guidance will prevent users from re-running unnecessary infrastructure steps.

Suggested change
| `Blueprint ID not found` | `a365 setup all` not run, or blueprint deleted | Run `a365 setup all` first |
| `Blueprint ID not found` | `a365 setup all` not run, or blueprint deleted | Run `a365 setup blueprint` first, or `a365 setup all` if you want the full setup flow |

Copilot uses AI. Check for mistakes.
…ention

Adds BEARER_TOKEN_<SERVER_NAME_UPPER> to the Task E environment variable
table with the uppercasing rule, concrete examples (MCP_MAILTOOLS,
MCP_CALENDARTOOLS), and a note that entries must match servers present
in ToolingManifest.json — unused vars have no effect.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

3 participants