Skip to content

Add MCP server and VS Code extension affordances to SharePoint Embedded build docs - #11019

Open
ShreyasSar26 wants to merge 7 commits into
SharePoint:mainfrom
ShreyasSar26:spe-mcp-vscode-affordances
Open

Add MCP server and VS Code extension affordances to SharePoint Embedded build docs#11019
ShreyasSar26 wants to merge 7 commits into
SharePoint:mainfrom
ShreyasSar26:spe-mcp-vscode-affordances

Conversation

@ShreyasSar26

Copy link
Copy Markdown
Contributor

What this does

Adds one-click "open in agent / tool" affordances to the SharePoint Embedded build docs so developers can start building from a coding agent or the Visual Studio Code extension, instead of only stepping through manual portal/API instructions. Inspired by the one-click Open in ... patterns other developer doc sets ship.

Changes

New reusable includes (docs/embedded/includes/):

  • spe-mcp-install.md — one-click Add to VS Code / VS Code Insiders buttons for the @microsoft/spe-mcp MCP server, plus Claude Code and OpenAI Codex CLI one-liners. The encoded config matches the npx -y @microsoft/spe-mcp start command already documented on the MCP page.
  • spe-vscode-extension.md — Marketplace install button for the SharePoint Embedded VS Code extension.

Wired into existing pages:

  • build/sharepoint-embedded-mcp-server.md — one-click install buttons at the top of Install and configure (manual steps retained).
  • build/quickstart-vscode.md — extension install button under Install the extension, plus a tip pointing to the MCP server.
  • build/create-container-type.md — new section offering the MCP server and the VS Code extension as alternatives to the API flow.
  • build/create-manage-containers.md — MCP server option for managing containers.
  • build/agent-experiences.md — tip linking to the MCP server.
  • sharepoint-embedded-documentation.md (hub) — note that you can build with the extension or a coding agent.

Notes

  • Uses only Learn-supported markdown: nextstepaction buttons and INCLUDE files. No raw HTML, scripts, or external image badges.
  • All install commands mirror what the live MCP server page already documents; no new package names introduced.
  • Existing manual instructions are kept — the affordances are framed as an alternative path.

Co-authored-by: Copilot App 223556219+Copilot@users.noreply.github.com

Add one-click "open in agent/tool" affordances so developers can start
building from a coding agent or the VS Code extension:

- New reusable includes: includes/spe-mcp-install.md (VS Code / Insiders
  one-click MCP install buttons + Claude Code/Codex CLI one-liners) and
  includes/spe-vscode-extension.md (Marketplace install button).
- Wire includes into build/sharepoint-embedded-mcp-server.md,
  build/quickstart-vscode.md, build/create-container-type.md, and
  build/create-manage-containers.md.
- Add coding-agent pointers on build/agent-experiences.md and the
  documentation hub.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 5f9d903:

💡 Validation status: suggestions

File Status Preview URL Details
docs/embedded/includes/spe-mcp-install.md 💡Suggestion View Details
docs/embedded/includes/spe-vscode-extension.md 💡Suggestion View Details
docs/embedded/build/agent-experiences.md ✅Succeeded View
docs/embedded/build/create-container-type.md ✅Succeeded View
docs/embedded/build/create-manage-containers.md ✅Succeeded View
docs/embedded/build/quickstart-vscode.md ✅Succeeded View
docs/embedded/build/sharepoint-embedded-mcp-server.md ✅Succeeded View
docs/embedded/sharepoint-embedded-documentation.md ✅Succeeded View

docs/embedded/includes/spe-mcp-install.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

docs/embedded/includes/spe-vscode-extension.md

  • Line 0, Column 0: [Suggestion: filename-incomplete - See documentation] The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

The Learn build flagged filename-incomplete on spe-*.md includes because
'spe' is a disallowed abbreviation in filenames. Rename to spell out
'sharepoint-embedded' (matching the build page naming) and update all
INCLUDE references.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Comment thread docs/embedded/build/sharepoint-embedded-mcp-server.md Outdated
Comment thread docs/embedded/includes/sharepoint-embedded-mcp-install.md Outdated
… non-primary link

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

…anage-containers

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit a76294e:

💡 Validation status: suggestions

File Status Preview URL Details
docs/embedded/includes/sharepoint-embedded-mcp-install.md 💡Suggestion View Details
docs/embedded/build/agent-experiences.md ✅Succeeded View
docs/embedded/build/create-container-type.md ✅Succeeded View
docs/embedded/build/create-manage-containers.md ✅Succeeded View
docs/embedded/build/quickstart-vscode.md ✅Succeeded View
docs/embedded/build/sharepoint-embedded-mcp-server.md ✅Succeeded View
docs/embedded/includes/sharepoint-embedded-vscode-extension.md ✅Succeeded View
docs/embedded/sharepoint-embedded-documentation.md ✅Succeeded View

docs/embedded/includes/sharepoint-embedded-mcp-install.md

  • Line 0, Column 0: [Suggestion: disallowed-domain - See documentation] Url 'cursor://anysphere.cursor-deeplink/mcp/install' references a disallowed domain 'cursor://anysphere.cursor-deeplink'. This poses a security risk.
  • Line 0, Column 0: [Suggestion: disallowed-domain - See documentation] Url 'lmstudio://add_mcp' references a disallowed domain 'lmstudio://add_mcp'. This poses a security risk.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

…sallowed-domain by Learn)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 022e6c80-2ba9-480e-9d52-4826b8a04d26
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

@andrewconnell Andrew Connell (andrewconnell) added the pr:in-review Actively reviewing pull request label Sep 4, 2026
@andrewconnell Andrew Connell (andrewconnell) added pr:awaiting-peer-reviews Awaiting the requested reviewers to complete their review. and removed pr:in-review Actively reviewing pull request labels Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:awaiting-peer-reviews Awaiting the requested reviewers to complete their review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants