Skip to content

AGENTS.md

Latest commit

 

History

History
162 lines (128 loc) · 7.81 KB

AGENTS.md

File metadata and controls

162 lines (128 loc) · 7.81 KB
Raw

Work IQ

Work IQ is a Copilot CLI plugin marketplace for managing AI agent plugins for GitHub Copilot CLI. It provides MCP servers, skills, and tools that connect AI assistants to Microsoft 365 data.

Repository Structure

work-iq/
├── .github/
│   └── plugin/
│       └── marketplace.json  # Plugin marketplace registry
├── plugins/                  # Plugin packages (skills + MCP servers)
│   ├── workiq/
│   ├── workiq-preview/
│   ├── microsoft-365-agents-toolkit/
│   └── workiq-productivity/
├── tests/workiq-guidance/     # Offline preview guidance and trace-contract checks
├── server.json               # MCP server manifest
├── ADMIN-INSTRUCTIONS.md     # Tenant admin consent guide
├── CONTRIBUTING.md           # Guide for adding new plugins
├── PLUGINS.md                # Plugin catalog — skills, agents, and commands
└── AGENTS.md                 # This file

Installing Plugins

This repo is a Copilot CLI plugin marketplace. Install plugins using the marketplace workflow below.

Quick install (copy-paste ready)

copilot plugin install ./plugins/workiq
copilot plugin install ./plugins/workiq-preview
copilot plugin install ./plugins/microsoft-365-agents-toolkit
copilot plugin install ./plugins/workiq-productivity

Important: After installing, restart your Copilot CLI session for new skills to become available.

Check what's installed

copilot plugin list

Removing a plugin

copilot plugin uninstall workiq
copilot plugin uninstall workiq-preview
copilot plugin uninstall microsoft-365-agents-toolkit
copilot plugin uninstall workiq-productivity

Plugins

Plugins live in plugins/<plugin-name>/ and follow this structure:

plugins/<plugin-name>/
├── .mcp.json              # MCP server config (if plugin has an MCP server)
├── README.md              # Plugin documentation
└── skills/                # Skill definitions
    └── <skill-name>/
        ├── SKILL.md       # Skill definition with YAML frontmatter
        └── references/    # Supporting docs (optional)

Available plugins

  • workiq — Full WorkIQ tool surface for Microsoft 365 (read + write). Bundles:

    • workiq skill — Guides usage of ask for semantic questions plus the entity tools for fast, structured M365 and Business Applications reads and writes
    • Hosted MCP server (workiq) with tools: ask_work_iq, fetch_work_iq, fetch_blob_work_iq, get_schema_work_iq, search_paths_work_iq, create_entity_work_iq, update_entity_work_iq, delete_entity_work_iq, do_action_work_iq, call_function_work_iq, get_debug_link
    • SharePoint library-metadata requests dispatch to references/sharepoint-library-metadata.md; read it before the workflow. Detailed procedures and safeguards live there rather than being duplicated in SKILL.md.

  • workiq-preview — Preview build with agent-host-neutral, retrieve-first guidance (read + write). Bundles:

    • workiq-preview skill — Retrieve caller-owned context with explicit Grounding when available; use ask only for intentional delegation, and entity tools for exact reads, writes, and downloads. Load the skill before using WorkIQ tools.
    • Hosted MCP server (workiq-preview): discover exact tool names and schemas in the connected host catalog. Preview retrieval is tenant-dependent; installation does not enable it, and missing retrieve never silently falls back to ask.
    • Preview-only offline checks: npm ci --prefix tests/workiq-guidance --ignore-scripts --no-audit --no-fund then npm --prefix tests/workiq-guidance test (Node 22+). CI does not run models or live M365 operations. The public workiq package retains its existing routing policy and version; its SharePoint metadata documentation is consolidated separately.
    • Observed trace validation requires nonblank package-hash provenance, including direct validator calls; authoritative state claims are compared by property presence, including falsey values.

  • microsoft-365-agents-toolkit — Toolkit for building M365 Copilot declarative agents. Bundles:

    • install-atk skill — Install or update the M365 Agents Toolkit CLI and VS Code extension
    • declarative-agent-developer skill — DA schema and capability guidance, with project lifecycle operations executed through the wiqd CLI
    • teams-app-developer skill — Build, test, and deploy code-based Teams apps: bots, CEA, tabs, message extensions, Agents Playground, Azure provision/deploy, and Slack-to-Teams migration
    • ui-widget-developer skill — Build MCP servers with OpenAI Apps SDK widget rendering for Copilot Chat
    • m365-agent-evaluator skill — Generate, run, and analyze evaluation suites for M365 Copilot declarative agents

  • workiq-productivity — Read-only WorkIQ productivity insights. Bundles:

    • action-item-extractor skill — Extract action items with owners, deadlines, and priorities
    • daily-outlook-triage skill — Quick summary of inbox and calendar for the day
    • email-analytics skill — Analyze email patterns (volume, senders, response times)
    • meeting-cost-calculator skill — Calculate time and cost spent in meetings
    • org-chart skill — Visual ASCII org chart for any person
    • multi-plan-search skill — Search tasks across all Planner plans
    • planner-status-report skill — Generate a status report for one Planner plan
    • site-explorer skill — Browse SharePoint sites, lists, and libraries
    • channel-audit skill — Audit channels for inactivity and cleanup
    • channel-digest skill — Summarize activity across multiple channels

Prerequisites

  • Node.js 18+ — Required for the workiq MCP server (npx)
  • Admin consent — The WorkIQ MCP server requires tenant admin consent on first use. See the Tenant Administrator Enablement Guide for details.

Creating a New Plugin

mkdir -p plugins/my-plugin/skills/my-skill/references

Create the required files:

README.md — Plugin documentation with installation instructions, skill table, and usage examples.

skills/<name>/SKILL.md — Skill definition with YAML frontmatter. The description field must not exceed 1024 characters — the Copilot CLI runtime silently drops skills that exceed this limit.

---
name: my-skill
description: >
  What this skill does.
  Triggers: "trigger phrase 1", "trigger phrase 2"
---

# My Skill

Skill instructions here...

.mcp.json (optional) — MCP server configuration if your plugin exposes tools:

{
  "mcpServers": {
    "my-server": {
      "command": "npx",
      "args": ["-y", "@my-org/my-package", "mcp"],
      "tools": ["*"]
    }
  }
}

After creating a plugin:

  1. Register it in .github/plugin/marketplace.json by adding an entry to the plugins array
  2. Install it with copilot plugin install ./plugins/my-plugin

Self-Maintenance Instructions

Important: When making changes to this repository — adding new plugins or modifying workflows — update this AGENTS.md file to reflect those changes. This file serves as the primary context document for AI agents working in this repo. Keep it accurate and current. Specifically:

  • Add new plugins to the "Available plugins" section when they are created
  • Register new plugins in .github/plugin/marketplace.json
  • Update "Getting Started" if new setup steps are required
  • Update "Repository Structure" if top-level directories change
  • After editing any skill or plugin content, reinstall the affected plugin so the running session picks up the changes: 
    copilot plugin uninstall <plugin-name>
copilot plugin install ./plugins/<plugin-name>