Skip to content

docs(claude-code): add install-first plugin guide - #646

Merged
eshwar-sundar-glean merged 1 commit into
mainfrom
eshwar/claude-code-plugin-page-v2
Aug 17, 2026
Merged

docs(claude-code): add install-first plugin guide#646
eshwar-sundar-glean merged 1 commit into
mainfrom
eshwar/claude-code-plugin-page-v2

Conversation

@eshwar-sundar-glean

@eshwar-sundar-glean eshwar-sundar-glean commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates /guides/mcp/claude-code with an install-first experience for the Glean Claude Code plugin, gated behind the existing claude-code-plugin-v2 feature flag.

The previous page is preserved as the fallback and remains visible while the flag is off. The new page can be enabled through the existing runtime feature-flag configuration when the plugin is ready to launch.

New page

  • What's included — explains that the plugin brings Glean's expert skills, custom skills authored by teams in Glean, and centrally configured Glean tools with security and permission guardrails enforced.
  • Links to the claude-plugins README for more detail about the plugin contents.
  • Installation — add the Glean marketplace, install the plugin, then set up the connection with /glean_run setup my Glean.
  • Includes OAuth/API-token authentication guidance.
  • Optional: fewer permission prompts — documents USE_CLAUDE_PROJECT_DIR=1, Claude Code settings.json scopes, and the .claude/tmp/ .gitignore entry.

Implementation

  • Adds optional whatsIncluded and afterSteps slots to PluginPage; existing plugin pages are unaffected.
  • Keeps claude-code-plugin-v2 off when absent; no new default-flag mechanism is introduced.
  • Preserves the current page in the FeatureFlag fallback.
  • Does not modify generated API Reference content.

Rollout

After this PR is deployed, enable the page for everyone by adding this entry to the existing feature-flags item in the glean-developer-feature-flags Edge Config:

{
  "claude-code-plugin-v2": {
    "enabled": true
  }
}

For local or preview testing, use:

/guides/mcp/claude-code?ff_claude-code-plugin-v2=true

To force the fallback page:

/guides/mcp/claude-code?ff_claude-code-plugin-v2=false

Validation

  • pnpm prettier --check .
  • pnpm test ✅ — 169 passed, 2 skipped
  • pnpm build ✅ — fallback page renders when the flag is absent
  • FF_CLAUDE_CODE_PLUGIN_V2=true pnpm build ✅ — new page renders with the install flow and optional configuration guidance

@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
glean-developer-site Ready Ready Preview Aug 17, 2026 6:47pm

Request Review

@eshwar-sundar-glean

Copy link
Copy Markdown
Contributor Author

Hold merge until Plugin launch

Comment thread docs/guides/mcp/claude-code.mdx Outdated
Comment thread src/utils/buildTimeFlags.ts Outdated
Comment thread src/theme/Root.tsx
Comment thread src/lib/defaultFlags.ts Outdated
Comment thread docs/guides/mcp/claude-code.mdx Outdated
Comment thread docs/guides/mcp/claude-code.mdx Outdated
Comment thread docs/guides/mcp/claude-code.mdx Outdated
Comment thread docs/guides/mcp/claude-code.mdx Outdated
@eshwar-sundar-glean
eshwar-sundar-glean force-pushed the eshwar/claude-code-plugin-page-v2 branch from 0e2ac56 to 40bcfd7 Compare August 13, 2026 05:38
@eshwar-sundar-glean
eshwar-sundar-glean marked this pull request as ready for review August 13, 2026 05:44
@eshwar-sundar-glean
eshwar-sundar-glean requested a review from a team as a code owner August 13, 2026 05:44
Comment thread docs/guides/mcp/claude-code.mdx Outdated
@eshwar-sundar-glean eshwar-sundar-glean changed the title docs(claude-code): install-first plugin page behind default-on flag docs(claude-code): add install-first plugin guide Aug 13, 2026

@david-hamilton-glean david-hamilton-glean left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One rendering issue to resolve but otherwise LGTM

Comment thread docs/guides/mcp/claude-code.mdx Outdated
description:
"Connect the plugin to your Glean instance. Authentication uses Glean's OAuth server where enabled, or a Glean API token as a fallback. You only need to do this once per machine.",
items: [
'In Claude Code, run: `/glean_run setup my Glean`',

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2/5 (minor preference, non-blocking)

This doesn't actually render correctly.

Image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. The list-step renderer now accepts React nodes, and the setup command is rendered with a real <code> element instead of literal backticks. Verified in the flag-on SSR build: the command renders as <code>/glean_run setup my Glean</code>, with no literal-backtick text. — sent via Glean Pi

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

@david-hamilton-glean
david-hamilton-glean dismissed steve-calvert-glean’s stale review August 13, 2026 22:44

Steve's comments were addressed.

Add an install-first Claude Code plugin guide behind the existing
`claude-code-plugin-v2` feature flag. The previous page remains the
fallback, so the new page can be enabled through the existing runtime flag
configuration when the plugin is ready to launch.

- Add a product-facing What's included section with the claude-plugins README
  link
- Add marketplace installation and `/glean_run setup my Glean` instructions
- Render the setup command as inline code in the rich list-step renderer
- Document OAuth/API-token authentication and optional USE_CLAUDE_PROJECT_DIR
  settings for fewer skill-file permission prompts
- Add optional whatsIncluded and afterSteps slots to PluginPage
@eshwar-sundar-glean
eshwar-sundar-glean force-pushed the eshwar/claude-code-plugin-page-v2 branch from 40bcfd7 to b070cd0 Compare August 17, 2026 18:46
@eshwar-sundar-glean
eshwar-sundar-glean merged commit 055a103 into main Aug 17, 2026
4 checks passed
@eshwar-sundar-glean
eshwar-sundar-glean deleted the eshwar/claude-code-plugin-page-v2 branch August 17, 2026 19:06
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.

3 participants