diff --git a/docs/embedded/build/create-container-type.md b/docs/embedded/build/create-container-type.md index 6a521785d6..83a7715069 100644 --- a/docs/embedded/build/create-container-type.md +++ b/docs/embedded/build/create-container-type.md @@ -77,6 +77,10 @@ You can create one with the SharePoint Embedded Visual Studio Code extension or The Visual Studio Code path is fastest for a first app. See [Quickstart: Build your first app with VS Code](quickstart-vscode.md). +To create and configure a container type through a coding agent, install the SharePoint Embedded Model Context Protocol (MCP) server. + +[!INCLUDE [Install the SharePoint Embedded MCP server](../includes/mcp-install-buttons-create-container-type.md)] + For Microsoft Graph, create the container type with the `trial` billing classification. The following restrictions are applied to trial container types: diff --git a/docs/embedded/build/create-manage-containers.md b/docs/embedded/build/create-manage-containers.md index 9c35aecfac..760e9d8bfd 100644 --- a/docs/embedded/build/create-manage-containers.md +++ b/docs/embedded/build/create-manage-containers.md @@ -23,6 +23,10 @@ Create and manage containers after your container type is created, registered, a Complete [Configure authentication and authorization](configure-authentication-authorization.md) before you call container APIs. +To manage the container lifecycle through a coding agent, install the SharePoint Embedded Model Context Protocol (MCP) server. + +[!INCLUDE [Install the SharePoint Embedded MCP server](../includes/mcp-install-buttons-create-manage-containers.md)] + ## Understand containers All SharePoint Embedded files and documents are stored in containers. diff --git a/docs/embedded/build/quickstart-vscode.md b/docs/embedded/build/quickstart-vscode.md index 759b0ea7ee..44f97b2726 100644 --- a/docs/embedded/build/quickstart-vscode.md +++ b/docs/embedded/build/quickstart-vscode.md @@ -23,6 +23,11 @@ Use the [SharePoint Embedded Visual Studio Code extension](https://marketplace.v This article starts the build journey. For more billing guidance, see [Create and configure a container type](create-container-type.md). +> [!TIP] +> To build through a coding agent, install the SharePoint Embedded Model Context Protocol (MCP) server. + +[!INCLUDE [Install the SharePoint Embedded MCP server](../includes/mcp-install-buttons-quickstart-vscode.md)] + ## Prerequisites Before you start, make sure you have: diff --git a/docs/embedded/build/sharepoint-embedded-mcp-server.md b/docs/embedded/build/sharepoint-embedded-mcp-server.md index 831e130c71..4bedc645ae 100644 --- a/docs/embedded/build/sharepoint-embedded-mcp-server.md +++ b/docs/embedded/build/sharepoint-embedded-mcp-server.md @@ -42,6 +42,8 @@ For the complete, versioned list of tools, CLI flags, and environment variables, ## Install and configure +[!INCLUDE [Install the SharePoint Embedded MCP server](../includes/mcp-install-buttons.md)] + MCP clients launch the server with `npx`, so there's no separate global install. Add a server entry to your client's MCP configuration. ### Visual Studio Code @@ -77,6 +79,15 @@ Add the server to `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/ } ``` +### Claude Code and Codex CLI + +Add the server from a terminal: + +```console +claude mcp add spe -- npx -y @microsoft/spe-mcp start --install-source microsoft-learn --install-content sharepoint-embedded-mcp-server --install-campaign docs-install-buttons +codex mcp add spe -- npx -y @microsoft/spe-mcp start --install-source microsoft-learn --install-content sharepoint-embedded-mcp-server --install-campaign docs-install-buttons +``` + ### Cursor and other MCP clients Any client that supports MCP servers over the stdio transport can run the server with the same `npx -y @microsoft/spe-mcp` command. See your client's documentation for where to register MCP servers. diff --git a/docs/embedded/includes/mcp-install-buttons-create-container-type.md b/docs/embedded/includes/mcp-install-buttons-create-container-type.md new file mode 100644 index 0000000000..8170267636 --- /dev/null +++ b/docs/embedded/includes/mcp-install-buttons-create-container-type.md @@ -0,0 +1,13 @@ + + +> [!div class="nextstepaction"] +> [Install in Visual Studio Code](https://vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22create-container-type%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) + +Other clients: + +- [Install in Visual Studio Code Insiders](https://vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22create-container-type%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Visual Studio](https://aka.ms/vs/mcp-install?%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22create-container-type%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Cursor](https://cursor.com/install-mcp?name=spe&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtaWNyb3NvZnQvc3BlLW1jcCIsInN0YXJ0IiwiLS1pbnN0YWxsLXNvdXJjZSIsIm1pY3Jvc29mdC1sZWFybiIsIi0taW5zdGFsbC1jb250ZW50IiwiY3JlYXRlLWNvbnRhaW5lci10eXBlIiwiLS1pbnN0YWxsLWNhbXBhaWduIiwiZG9jcy1pbnN0YWxsLWJ1dHRvbnMiXX0=) +- [Configure Claude Code](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) +- [Configure the Codex CLI](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) diff --git a/docs/embedded/includes/mcp-install-buttons-create-manage-containers.md b/docs/embedded/includes/mcp-install-buttons-create-manage-containers.md new file mode 100644 index 0000000000..095444811a --- /dev/null +++ b/docs/embedded/includes/mcp-install-buttons-create-manage-containers.md @@ -0,0 +1,13 @@ + + +> [!div class="nextstepaction"] +> [Install in Visual Studio Code](https://vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22create-manage-containers%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) + +Other clients: + +- [Install in Visual Studio Code Insiders](https://vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22create-manage-containers%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Visual Studio](https://aka.ms/vs/mcp-install?%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22create-manage-containers%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Cursor](https://cursor.com/install-mcp?name=spe&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtaWNyb3NvZnQvc3BlLW1jcCIsInN0YXJ0IiwiLS1pbnN0YWxsLXNvdXJjZSIsIm1pY3Jvc29mdC1sZWFybiIsIi0taW5zdGFsbC1jb250ZW50IiwiY3JlYXRlLW1hbmFnZS1jb250YWluZXJzIiwiLS1pbnN0YWxsLWNhbXBhaWduIiwiZG9jcy1pbnN0YWxsLWJ1dHRvbnMiXX0=) +- [Configure Claude Code](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) +- [Configure the Codex CLI](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) diff --git a/docs/embedded/includes/mcp-install-buttons-quickstart-vscode.md b/docs/embedded/includes/mcp-install-buttons-quickstart-vscode.md new file mode 100644 index 0000000000..452511097d --- /dev/null +++ b/docs/embedded/includes/mcp-install-buttons-quickstart-vscode.md @@ -0,0 +1,13 @@ + + +> [!div class="nextstepaction"] +> [Install in Visual Studio Code](https://vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22quickstart-vscode%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) + +Other clients: + +- [Install in Visual Studio Code Insiders](https://vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22quickstart-vscode%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Visual Studio](https://aka.ms/vs/mcp-install?%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22quickstart-vscode%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Cursor](https://cursor.com/install-mcp?name=spe&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtaWNyb3NvZnQvc3BlLW1jcCIsInN0YXJ0IiwiLS1pbnN0YWxsLXNvdXJjZSIsIm1pY3Jvc29mdC1sZWFybiIsIi0taW5zdGFsbC1jb250ZW50IiwicXVpY2tzdGFydC12c2NvZGUiLCItLWluc3RhbGwtY2FtcGFpZ24iLCJkb2NzLWluc3RhbGwtYnV0dG9ucyJdfQ==) +- [Configure Claude Code](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) +- [Configure the Codex CLI](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) diff --git a/docs/embedded/includes/mcp-install-buttons.md b/docs/embedded/includes/mcp-install-buttons.md new file mode 100644 index 0000000000..dac08e51b1 --- /dev/null +++ b/docs/embedded/includes/mcp-install-buttons.md @@ -0,0 +1,13 @@ + + +> [!div class="nextstepaction"] +> [Install in Visual Studio Code](https://vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22sharepoint-embedded-mcp-server%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) + +Other clients: + +- [Install in Visual Studio Code Insiders](https://vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22sharepoint-embedded-mcp-server%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Visual Studio](https://aka.ms/vs/mcp-install?%7B%22name%22%3A%22spe%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40microsoft%2Fspe-mcp%22%2C%22start%22%2C%22--install-source%22%2C%22microsoft-learn%22%2C%22--install-content%22%2C%22sharepoint-embedded-mcp-server%22%2C%22--install-campaign%22%2C%22docs-install-buttons%22%5D%7D) +- [Install in Cursor](https://cursor.com/install-mcp?name=spe&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtaWNyb3NvZnQvc3BlLW1jcCIsInN0YXJ0IiwiLS1pbnN0YWxsLXNvdXJjZSIsIm1pY3Jvc29mdC1sZWFybiIsIi0taW5zdGFsbC1jb250ZW50Iiwic2hhcmVwb2ludC1lbWJlZGRlZC1tY3Atc2VydmVyIiwiLS1pbnN0YWxsLWNhbXBhaWduIiwiZG9jcy1pbnN0YWxsLWJ1dHRvbnMiXX0=) +- [Configure Claude Code](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli) +- [Configure the Codex CLI](../build/sharepoint-embedded-mcp-server.md#claude-code-and-codex-cli)