Skip to content

Commit 944b6d8

Browse files
authored
Merge pull request #27 from github/add-plugin-readmes
Add READMEs for spark and workiq plugins
2 parents ee72ce6 + 70f391a commit 944b6d8

2 files changed

Lines changed: 73 additions & 0 deletions

File tree

plugins/spark/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Spark
2+
3+
Comprehensive guidance for building modern web applications with opinionated defaults for tech stack, design system, and code standards.
4+
5+
## What it does
6+
7+
Spark helps you quickly bootstrap high-quality web applications by providing:
8+
9+
- Pre-vetted technology stack choices with multiple complexity-based variations
10+
- An opinionated design philosophy and system
11+
- Step-by-step setup workflows
12+
- Design and performance optimization guidance
13+
14+
## Skills
15+
16+
### `spark-app-template`
17+
18+
Activated when a user wants to create a new web application, dashboard, or interactive interface. Provides guidance on:
19+
20+
- **Tech stack** — Vite, React 19+, TypeScript, Tailwind CSS v4+, shadcn/ui, TanStack Router & Query
21+
- **Design system** — Typography pairings, OKLCH color palettes, spatial composition, micro-interactions
22+
- **Stack variations** — Pre-configured stacks tailored to app complexity (default web app, content showcase, data dashboard, complex application)
23+
- **Performance** — Core Web Vitals targets, React Compiler setup, optimization checklists
24+
- **Component patterns** — Common shadcn compositions and usage patterns
25+
26+
## Stack variations
27+
28+
| Stack | Use case |
29+
| --- | --- |
30+
| **Default Web App** | General-purpose tools, utilities, simple CRUD, MVPs, prototypes |
31+
| **Content Showcase** | Marketing sites, portfolios, blogs, documentation |
32+
| **Data Dashboard** | Analytics dashboards, admin panels, BI tools, monitoring |
33+
| **Complex Application** | SaaS platforms, enterprise tools, multi-view apps |

plugins/workiq/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# WorkIQ
2+
3+
Workplace intelligence plugin that connects AI agents to Microsoft 365 Copilot, providing access to organizational data from Outlook, Teams, SharePoint, OneDrive, and Calendar.
4+
5+
Powered by the [`@microsoft/workiq`](https://github.com/microsoft/work-iq-mcp) MCP server.
6+
7+
> ⚠️ **Public Preview:** Features and APIs may change.
8+
9+
## What it does
10+
11+
WorkIQ grounds AI assistance in real workplace context by querying Microsoft 365 data sources. It enables agents to answer questions about:
12+
13+
| Data type | Example questions |
14+
| --- | --- |
15+
| **Emails** | "What did John say about the proposal?" |
16+
| **Meetings** | "What's on my calendar tomorrow?" |
17+
| **Documents** | "Find my recent PowerPoint presentations" |
18+
| **Teams** | "Summarize today's messages in the Engineering channel" |
19+
| **People** | "Who is working on Project Alpha?" |
20+
21+
## Skills
22+
23+
### `workiq`
24+
25+
Activated when a user asks about workplace context — what someone said, meeting outcomes, document locations, team priorities, or organizational knowledge. Uses the `ask_work_iq` MCP tool to query Microsoft 365 Copilot with natural language questions.
26+
27+
## MCP server
28+
29+
WorkIQ includes an MCP server configuration (`.mcp.json`) that runs the [`@microsoft/workiq`](https://www.npmjs.com/package/@microsoft/workiq) package. Authentication is automatic using the connected user's existing Microsoft 365 credentials.
30+
31+
## Prerequisites
32+
33+
- **Node.js 18+**[Download from nodejs.org](https://nodejs.org/)
34+
- **Microsoft 365 account** with Copilot access
35+
36+
## Admin consent
37+
38+
To access Microsoft 365 tenant data, the WorkIQ MCP server needs 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.
39+
40+
For more information, see Microsoft's [User and Admin Consent Overview](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/user-admin-consent-overview).

0 commit comments

Comments
 (0)