# Microsoft 365 ATK MCP Server

The Microsoft 365 ATK MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)
server that provides a seamless connection between AI agents and developers for building apps and agents for Microsoft 365 and Microsoft 365 Copilot.

## Overview

### What can you do with it?

M365 ATK MCP Server is designed to help you: 
- Build and deploy AI agents for Microsoft 365
- Create applications from templates and samples using ATK CLI
- Integrate with Microsoft 365 Copilot features
- Access comprehensive guidance for all ATK CLI options
- Preview and test applications across different environments
- Troubleshoot common issues effectively

## Currently Supported Tools

### Application Creation Tools
- **create_template**: Complete guidance for creating M365 apps from templates using `atk new` with all available options
- **create_sample**: Instructions for creating apps from existing samples using `atk sample`
- **list_templates_and_samples**: Information about available templates and samples
- **preview_app**: Comprehensive app preview and testing guidance

### Schema and Configuration Tools
- Schema Fetcher for:
    - App Manifest
    - Declarative Agent Manifest
    - API Plugin Manifest

### Supported ATK CLI Features

#### Templates (via `atk new`)
- **Agents**: declarative-agent, basic-custom-engine-agent, weather-agent, custom-copilot-*
- **Bots**: bot, notification, command-bot, workflow-bot
- **Tabs**: tab-non-sso, sso-launch-page, dashboard-tab, tab-spfx
- **Message Extensions**: search-app, collect-form-message-extension, link-unfurling
- **Office Add-ins**: wxp-json-taskpane, outlook-json-taskpane

#### Comprehensive CLI Options Support
- Programming languages: JavaScript, TypeScript, C#
- Host triggers: HTTP Express, Web API, Azure Functions
- SharePoint Framework: React, Minimal, None frameworks
- Message Extension architectures: new-api, api-spec, bot
- API plugin integration with various authentication types
- LLM service configuration: Azure OpenAI, OpenAI
- Custom folder destinations and naming

#### Sample Creation (via `atk sample`)
- Create from existing sample projects
- Interactive and non-interactive modes
- Complete customization guidance
- Microsoft 365 and Microsoft 365 Copilot Knowledge Retriever
- Apps and Agents Samples and Templates Code Snippets Retriever
- Troubleshooting Retriever

## Prerequisites

1. The Microsoft 365 ATK MCP Server requires Node.js to install and run the server. If you don't have it installed, follow the instructions [here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
2. Install either the stable or Insiders release of VS Code:
   * [💫 Stable release](https://code.visualstudio.com/download)
   * [🔮 Insiders release](https://code.visualstudio.com/insiders)
3. Install the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) and [GitHub Copilot Chat](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) extensions

#### Manual Install

For a step-by-step guide to install the Microsoft 365 ATK MCP Server, follow these instructions:

- Add `.vscode/mcp.json`:
    ```json
    {
        "servers": {
            "Microsoft 365 ATK MCP Server": {
                "command": "npx",
                "args": [
                    "-y",
                    "m365-atk-mcp-server@latest",
                    "server",
                    "start"
                ]
            }
        }
    }
    ```

#### Install From Command Palette
- [![Install with NPX in VS Code](https://img.shields.io/badge/VS_Code-Install_all-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=Microsoft%20365%20ATK%20MCP%20Server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22m365-atk-mcp-server%40latest%22%2C%22server%22%2C%22start%22%5D%7D) [![Install with NPX in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_all-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=Microsoft%20365%20ATK%20MCP%20Server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22m365-atk-mcp-server%40latest%22%2C%22server%22%2C%22start%22%5D%7D&quality=insiders)

#### List The Tools

- Open GitHub Copilot in VS Code and [switch to Agent mode](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode)

- Click `refresh` on the tools list.

#### For Visual Studio

Manual configuration required, please follow: [Visual Studio MCP Official Guide](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022)

## Feedback

We're building this in the open. Your feedback is much appreciated, and will help us shape the future of the Microsoft 365 ATK MCP Server.

- [Open an issue in the public repository](https://github.com/OfficeDev/microsoft-365-agents-toolkit/issues/new/choose).
- Send an email to [tcsupport@microsoft.com](mailto:tcsupport@microsoft.com) to chat with the product team.

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## License
Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the [MIT](LICENSE) license.