Skip to content

docs(mcp): link out to each IDE's hooks/MCP docs, add VS Code + Copilot tabs#2620

Merged
dlukeomalley merged 6 commits into
mainfrom
docs/mcp-plugin-hooks-links
May 12, 2026
Merged

docs(mcp): link out to each IDE's hooks/MCP docs, add VS Code + Copilot tabs#2620
dlukeomalley merged 6 commits into
mainfrom
docs/mcp-plugin-hooks-links

Conversation

@dlukeomalley
Copy link
Copy Markdown
Member

@dlukeomalley dlukeomalley commented May 12, 2026

Summary

Make the Semgrep Plugin page route developers to each IDE's native hook or MCP documentation, add tabs for two missing IDEs, and tighten the page so each tab focuses on what's IDE-specific. Every documented install method is verified against both the IDE's own docs and Semgrep's published plugin repos.

Link out to canonical upstream docs

Every supported agent's tab now ends with a one-line "Learn more" pointing to the canonical upstream documentation:

The page intro now lists all six as a bullet list so developers can jump straight to their IDE's upstream docs without scrolling.

New tabs

  • VS Code: `.vscode/mcp.json` workspace config or `MCP: Open User Configuration` for user-wide
  • GitHub Copilot: covers Copilot in Visual Studio, JetBrains, Xcode, and Eclipse (VS Code users use the VS Code tab)

Restructure for clarity

  • Lift the common brew/pipx/uv install, version check, and `semgrep login && install-semgrep-pro` steps out of every tab into a shared Install the Semgrep CLI section above the tabs. Each tab now contains only the IDE-specific wiring.
  • Alphabetize the IDE list and the tabs (Claude Code, Codex, Cursor, GitHub Copilot, VS Code, Windsurf, Other IDEs).
  • Rename Installation to Connect to your IDE since install is now factored out.
  • Add a short note next to the Python 3.10+ prerequisite explaining that the Semgrep CLI requires it at runtime regardless of how it was installed.

Method verification

Each install method was checked against the IDE's own docs and Semgrep's published plugin repos:

Editor Method Verified against
Claude Code `/plugin` then Discover, Semgrep, Install, then `/setup-semgrep-plugin` semgrep/mcp-marketplace README; Semgrep is in the official Anthropic marketplace (13,878 installs), no `marketplace add` step needed
Codex `[mcp_servers.semgrep]` with `command` + `args` in `~/.codex/config.toml` developers.openai.com/codex/mcp canonical minimal example
Cursor Marketplace install, restart, then `/setup-semgrep-plugin` skill semgrep/cursor-plugin README (added the missing skill step in this PR); actual hook events are `afterFileEdit` and `stop`
GitHub Copilot `{"servers": {...}}` JSON docs.github.com Copilot MCP guide; schema is identical across Visual Studio, JetBrains, Xcode, Eclipse
VS Code `.vscode/mcp.json` with `"servers"` code.visualstudio.com Copilot MCP docs
Windsurf `post_write_code` in `~/.codeium/windsurf/hooks.json` docs.windsurf.com Cascade hooks

Other polish from verification: renamed "plugin browser" to "plugin manager" in the Claude Code tab to match Anthropic's docs terminology.

Net: ~28 fewer lines and the page is easier to extend with new IDEs.

Test plan

  • Build the site locally and verify all 8 outbound links render and resolve
  • Click through each tab and confirm steps are coherent without the lifted install section
  • Confirm tab labels appear in alphabetical order in the rendered UI

🤖 Generated with Claude Code

dlukeomalley and others added 3 commits May 12, 2026 08:03
…ot tabs

Make the Semgrep Plugin guide explicit about how each IDE wires Semgrep
in: link out to Claude Code hooks/plugins, Cursor hooks/MCP, Windsurf
Cascade hooks, Codex MCP, VS Code MCP, and GitHub Copilot MCP. Each tab
now ends with a one-line "Learn more" pointing to the canonical upstream
doc.

Adds two new tabs:
- VS Code: install via .vscode/mcp.json or the user MCP config
- GitHub Copilot: install for Visual Studio, JetBrains, Xcode, Eclipse

The "Other IDEs" tab now also notes the post-write hook pattern for any
IDE that exposes one.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Lift the brew/pipx/uv install, version check, and login + install-pro
steps out of every tab into a shared "Install the Semgrep CLI" section
above the tabs. Each tab now contains only the IDE-specific wiring.

Other polish:
- Alphabetize the IDE list and the tabs (Claude Code, Codex, Cursor,
  GitHub Copilot, VS Code, Windsurf, Other IDEs)
- Convert the intro's inline IDE list to a bullet list for scannability
- Fix Python 3.10+ prereq wording (only applies to pipx/uv, not brew)
- Renumber Cursor/Windsurf tab steps sequentially
- Rename "Installation" -> "Connect to your IDE" since install is now
  factored out

Net: -125/+99 lines and easier to extend with new IDEs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit 95e184e
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/6a0342f262f20d0008735980
😎 Deploy Preview https://deploy-preview-2620--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 12, 2026

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit 2efed7b
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/6a0345da967c6400085ccf29
😎 Deploy Preview https://deploy-preview-2620--semgrep-docs-prod.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

dlukeomalley and others added 2 commits May 12, 2026 08:16
…inology

- Add the missing /setup-semgrep-plugin skill step to the Cursor tab.
  Verified against github.com/semgrep/cursor-plugin README, which says
  to install from the marketplace and then run the skill.
- Note the actual Cursor hook events used by the Semgrep plugin
  (afterFileEdit and stop) so readers can map to the upstream hooks docs.
- Rename "plugin browser" to "plugin manager" in the Claude Code tab to
  match Anthropic's terminology in code.claude.com/docs/en/discover-plugins.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…t runtime

The Semgrep CLI is Python-based and requires Python 3.10+ at runtime
regardless of install method, per semgrep.dev/docs/getting-started/quickstart.
The Homebrew formula bundles python@3.14 for the install itself but the
runtime requirement is independent. Restore Python 3.10+ as a universal
prerequisite with a brief note explaining why.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dlukeomalley dlukeomalley enabled auto-merge (squash) May 12, 2026 15:21
go.semgrep.dev/slack is a Slack invite vanity URL that returns 403 to
bot user-agents (anti-abuse) but works fine for humans. The link
checker now flags it whenever a file containing it is modified.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dlukeomalley dlukeomalley merged commit feb1b54 into main May 12, 2026
8 checks passed
@dlukeomalley dlukeomalley deleted the docs/mcp-plugin-hooks-links branch May 12, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants