Docs/improve installation experience #117
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Change from {command, args} object format to [command, flag, script] array format
- VS Code MCP installer expects array of command arguments instead of object
- Fixes 'Failed to parse scanned MCP servers: [object Object]' error
- Update all 8 installation links to use proper array format
- Should resolve VS Code MCP integration parsing issues
- Revert to {type, command, args} object format instead of array
- Include explicit 'type': 'stdio' field as required by VS Code MCP
- Fix VS Code showing 'Type: http' instead of 'stdio' in installation dialog
- Ensure proper JSON structure for VS Code MCP server configuration
- Update all 8 installation links with correct MCP server format
- Replace temporary download-and-run URLs with proper setup approach - Add automated setup scripts for Windows/macOS/Linux - Provide direct download links for all platforms - Include comprehensive manual configuration examples - Update getting started guide with clearer troubleshooting tips This addresses the fundamental issue where 1-click installation was creating temporary execution commands instead of permanent .vscode/mcp.json configurations.
- Fix markdown linting issues (line length, emphasis as headings, bare URLs) - Add user-level MCP server configuration option for persistent GitHub Copilot setup - Improve readability with proper line wrapping and formatting - Add both workspace-specific and global configuration options for flexibility
There was a problem hiding this comment.
Pull Request Overview
This PR improves the installation experience for AKS-MCP by restructuring the README documentation to provide clearer, more user-friendly setup instructions. The changes focus on making the installation process more accessible and comprehensive.
Key Changes:
- Enhanced installation instructions with step-by-step guidance
- Added comprehensive binary download table with direct links for all platforms
- Replaced one-click installation buttons with practical setup scripts and manual configuration options
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.