Add underscore variant #581
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds an underscore variant (read_only) alongside the existing read-only flag and updates the server configuration to respect both.
- Combines
viper.GetBool("read-only")andviper.GetBool("read_only")when setting theReadOnlyfield - Registers two CLI flags (
--read-onlyand--read_only) bound to the samereadOnlyFlagvariable
Comments suppressed due to low confidence (1)
cmd/github-mcp-server/main.go:74
- The new
read_onlyalias isn’t covered by any existing tests. Consider adding unit tests to verify that both--read-onlyand--read_onlycorrectly enable read-only mode.
rootCmd.PersistentFlags().BoolVar(&readOnlyFlag, "read_only", false, "Restrict the server to read-only operations")
| @@ -69,6 +68,7 @@ func init() { | |||
| rootCmd.PersistentFlags().StringSlice("toolsets", github.DefaultTools, "An optional comma separated list of groups of tools to allow, defaults to enabling all") | |||
| rootCmd.PersistentFlags().Bool("dynamic-toolsets", false, "Enable dynamic toolsets") | |||
| rootCmd.PersistentFlags().Bool("read-only", false, "Restrict the server to read-only operations") | |||
| rootCmd.PersistentFlags().Bool("read_only", false, "Restrict the server to read-only operations") | |||
There was a problem hiding this comment.
I don't think we need the flag here, we can just allow viper env parser to fix the env version.
| @@ -78,6 +78,7 @@ func init() { | |||
| _ = viper.BindPFlag("toolsets", rootCmd.PersistentFlags().Lookup("toolsets")) | |||
| _ = viper.BindPFlag("dynamic_toolsets", rootCmd.PersistentFlags().Lookup("dynamic-toolsets")) | |||
| _ = viper.BindPFlag("read-only", rootCmd.PersistentFlags().Lookup("read-only")) | |||
| _ = viper.BindPFlag("read_only", rootCmd.PersistentFlags().Lookup("read_only")) | |||
There was a problem hiding this comment.
Suggested change
| _ = viper.BindPFlag("read_only", rootCmd.PersistentFlags().Lookup("read_only")) |
| @@ -69,6 +68,7 @@ func init() { | |||
| rootCmd.PersistentFlags().StringSlice("toolsets", github.DefaultTools, "An optional comma separated list of groups of tools to allow, defaults to enabling all") | |||
| rootCmd.PersistentFlags().Bool("dynamic-toolsets", false, "Enable dynamic toolsets") | |||
| rootCmd.PersistentFlags().Bool("read-only", false, "Restrict the server to read-only operations") | |||
| rootCmd.PersistentFlags().Bool("read_only", false, "Restrict the server to read-only operations") | |||
There was a problem hiding this comment.
Suggested change
| rootCmd.PersistentFlags().Bool("read_only", false, "Restrict the server to read-only operations") |
| @@ -91,6 +92,7 @@ func initConfig() { | |||
| // Initialize Viper configuration | |||
| viper.SetEnvPrefix("github") | |||
| viper.AutomaticEnv() | |||
There was a problem hiding this comment.
This line gets the env vars, so the viper values will be set already.
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.
Adds an underscore read_only flag.
Addresses: #577