docs: MCP / Prompt install buttons in SDK quick-start#1287
docs: MCP / Prompt install buttons in SDK quick-start#1287jonathannorris merged 6 commits intomainfrom
Conversation
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>
✅ Deploy Preview for openfeature ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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
MCPInstallReact 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.
There was a problem hiding this comment.
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>
toddbaert
left a comment
There was a problem hiding this comment.
Looks good, works for me with Java + vscode.
This PR introduces a new interactive component that helps developers quickly install OpenFeature using AI assistants with prompts / MCP install instructions:
Changes
New Component (
src/partials/mcp-install.tsx)Automated Integration (
scripts/process-sdk-readmes.ts)