Microsoft Work IQ (Public Preview)

Query your Microsoft 365 data with natural language — emails, meetings, documents, Teams messages, and more.

The WorkIQ CLI and MCP (Model Context Protocol) server connects AI assistants to your Microsoft 365 Copilot data. Ask questions like "What did my manager say about the project deadline?" or "Find my recent documents about Q4 planning."

To access Microsoft 365 tenant data, the WorkIQ CLI and MCP Server need to be consented to permissions that require administrative rights on the tenant. On first access, a consent dialog appears. If you are not an administrator, contact your tenant administrator to grant access.

For Tenant Administrators: See the Tenant Administrator Enablement Guide for detailed instructions on granting admin consent, including a quick one-click consent URL.

For more information, see Microsoft's User and Admin Consent Overview.

⚠️ Public Preview: Features and APIs may change.

---

🚀 Quick Start with GitHub Copilot CLI

The fastest way to get started is with GitHub Copilot CLI:

# 1. Open GitHub Copilot CLI
copilot

# 2. Add the plugins marketplace (one-time setup)
/plugin marketplace add github/copilot-plugins

# 3. Install WorkIQ
/plugin install workiq@copilot-plugins

That's it! Restart Copilot CLI and start querying your M365 data:

You: What are my upcoming meetings this week?
You: Summarize emails from Sarah about the budget
You: Find documents I worked on yesterday

---

📦 Alternative: Standalone Installation

If you prefer to run WorkIQ as a standalone MCP server:

# Install globally
npm install -g @microsoft/workiq

# Run the MCP server
workiq mcp

Or use npx without installing:

npx -y @microsoft/workiq mcp

Or add it as an MCP server in your coding agent or IDE:

{
  "workiq": {
    "command": "npx",
    "args": [
      "-y",
      "@microsoft/workiq",
      "mcp"
    ],
    "tools": [
      "*"
    ]
  }
}

Note: please refer to use MCP servers in VS Code for the configuration instructions relative to Visual Studio Code.

---

🎯 What You Can Query

Data Type	Example Questions
Emails	"What did John say about the proposal?"
Meetings	"What's on my calendar tomorrow?"
Documents	"Find my recent PowerPoint presentations"
Teams	"Summarize today's messages in the Engineering channel"
People	"Who is working on Project Alpha?"

---

📖 CLI Reference

Commands

Command	Description
workiq accept-eula	Accept the End User License Agreement (EULA)
workiq ask	Ask a question to a specific agent or run in interactive mode
workiq mcp	Start MCP stdio server for agent communication
workiq version	Show version information

Global Options

Option	Description	Default
-t, --tenant-id <tenant-id>	The Entra tenant ID to use for authentication	common
--version	Show version information
-?, -h, --help	Show help and usage information

workiq ask Options

Option	Description
-q, --question <question>	The question to ask the agent

Examples

# Accept the EULA (required on first use)
workiq accept-eula

# Interactive mode
workiq ask

# Ask a specific question
workiq ask -q "What meetings do I have tomorrow?"

# Use a specific tenant
workiq ask -t "your-tenant-id" -q "Show my emails"

# Start MCP server
workiq mcp

---

Platform Support

The WorkIQ CLI and MCP Server are supported on win_x64, win_arm64, linux_x64, linux_arm64, osx_x64 and osx_arm64. It is also supported in WSL as long as WSL is able to launch a browser to enable sign-in.

One way to install browser support on WSL is with the following commands:

sudo apt install xdg-utils
sudo apt install wslu

Contributing

The command-line tool and MCP server documented in this repository are not open source.
Their implementations are maintained internally, and source code contributions are not accepted.

This repository is intentionally public to support documentation, transparency, and feedback.
We encourage the community to use this repo to:

• Provide feedback on the documented behavior and APIs
• Suggest features or product improvements
• Share insights on developer experience or integration scenarios

Please use GitHub Issues to engage. While the runtime implementation is proprietary, community input here directly informs the product’s direction.

📄 License

By using this package, you accept the license agreement. See NOTICES.TXT and EULA within the package for legal terms.

Trademarks

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. 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 is subject to those third-party's policies.