Skip to content

docs: MCP / Prompt install buttons in SDK quick-start#1287

Merged
jonathannorris merged 6 commits intomainfrom
docs-mcp-install-buttons
Oct 28, 2025
Merged

docs: MCP / Prompt install buttons in SDK quick-start#1287
jonathannorris merged 6 commits intomainfrom
docs-mcp-install-buttons

Conversation

@jonathannorris
Copy link
Member

This PR introduces a new interactive component that helps developers quickly install OpenFeature using AI assistants with prompts / MCP install instructions:

image image

Changes

New Component (src/partials/mcp-install.tsx)

  • Dynamic prompt fetching from open-feature/mcp repository
  • SDK-specific installation instructions cached at runtime
  • One-click copy button with loading/success/error states
  • Quick install links for Cursor and VS Code

Automated Integration (scripts/process-sdk-readmes.ts)

  • Added SDK name → MCP technology mapping
  • Automatically injects MCPInstall component after "Quick start" heading
  • Applied to all matching SDK documentation pages during build

Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
@jonathannorris jonathannorris requested review from a team as code owners October 28, 2025 15:28
@netlify
Copy link

netlify bot commented Oct 28, 2025

Deploy Preview for openfeature ready!

Name Link
🔨 Latest commit a2e401f
🔍 Latest deploy log https://app.netlify.com/projects/openfeature/deploys/6900e42dca447b0007f0ccdc
😎 Deploy Preview https://deploy-preview-1287--openfeature.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.

@jonathannorris jonathannorris requested review from beeme1mr, Copilot, openfeaturebot and toddbaert and removed request for a team October 28, 2025 15:28
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jonathannorris, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the developer experience by integrating interactive AI assistant installation prompts directly into the OpenFeature SDK documentation. It introduces a new React component that dynamically fetches SDK-specific prompts and provides one-click installation options for popular AI tools, alongside an automated process to embed these features across various SDK quick-start guides. This streamlines the setup for developers using AI assistants, making OpenFeature easier to adopt and configure.

Highlights

  • New Interactive Component: An MCPInstall component (src/partials/mcp-install.tsx) has been introduced to facilitate quick installation of OpenFeature using AI assistants.
  • Dynamic Prompt Fetching: The new component dynamically fetches SDK-specific installation prompts from the open-feature/mcp GitHub repository.
  • One-Click Install Buttons: Quick install buttons are provided for AI tools like Cursor and VS Code, along with a copy-to-clipboard functionality for prompts.
  • Automated Documentation Integration: A script (scripts/process-sdk-readmes.ts) has been updated to automatically inject the MCPInstall component into the "Quick start" sections of relevant SDK documentation pages during the build process.
  • Expanded MCP Documentation: The docs/reference/other-technologies/mcp.mdx file now includes direct install links for Cursor and VS Code, and manual setup instructions for Codex CLI and Gemini CLI.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds an interactive MCP (Model Context Protocol) installation component to SDK documentation pages, enabling developers to quickly install OpenFeature using AI assistants. The component fetches SDK-specific installation prompts from a GitHub repository and provides one-click install buttons for Cursor and VS Code.

Key changes:

  • New MCPInstall React component with dynamic prompt fetching and caching
  • Automated injection of the component into SDK documentation after "Quick start" headings
  • Updated MCP documentation with quick install buttons for multiple AI tools

Reviewed Changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/partials/mcp-install.tsx New component that fetches SDK-specific prompts and displays install options
src/css/custom.css Added styling for MCP install buttons and collapsible summary
scripts/process-sdk-readmes.ts Automated injection logic with SDK-to-MCP technology mapping
docs/reference/sdks/*/ Auto-generated documentation updates with MCPInstall component
docs/reference/other-technologies/mcp.mdx Added quick install buttons and configuration for Codex CLI and Gemini CLI

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new interactive component (src/partials/mcp-install.tsx) to help developers quickly install OpenFeature using AI assistants. It fetches dynamic prompts, caches SDK-specific installation instructions, and provides one-click copy buttons and quick install links. The changes also include automated integration in scripts/process-sdk-readmes.ts to inject the new component after the "Quick start" heading in SDK documentation pages. The code changes look good overall, but there are a few suggestions to improve the CSS styling and code readability.

Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Copy link
Contributor

@weyert weyert left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

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

Looks good, works for me with Java + vscode.

Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

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

Very cool! Thanks

@jonathannorris jonathannorris added this pull request to the merge queue Oct 28, 2025
Merged via the queue into main with commit 7bdf1c6 Oct 28, 2025
9 checks passed
@jonathannorris jonathannorris deleted the docs-mcp-install-buttons branch October 28, 2025 20:43
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.

4 participants