Skip to content

feat: tool prefix name #657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cmd/github-mcp-server/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ var (
EnabledToolsets: enabledToolsets,
DynamicToolsets: viper.GetBool("dynamic_toolsets"),
ReadOnly: viper.GetBool("read-only"),
ToolPrefix: viper.GetString("tool-prefix"),
ExportTranslations: viper.GetBool("export-translations"),
EnableCommandLogging: viper.GetBool("enable-command-logging"),
LogFilePath: viper.GetString("log-file"),
Expand All @@ -71,6 +72,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().String("tool-prefix", "", "Optional prefix to add to all tool names (e.g. 'github_')")
rootCmd.PersistentFlags().String("log-file", "", "Path to log file")
rootCmd.PersistentFlags().Bool("enable-command-logging", false, "When enabled, the server will log all command requests and responses to the log file")
rootCmd.PersistentFlags().Bool("export-translations", false, "Save translations to a JSON file")
Expand All @@ -80,6 +82,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("tool-prefix", rootCmd.PersistentFlags().Lookup("tool-prefix"))
_ = viper.BindPFlag("log-file", rootCmd.PersistentFlags().Lookup("log-file"))
_ = viper.BindPFlag("enable-command-logging", rootCmd.PersistentFlags().Lookup("enable-command-logging"))
_ = viper.BindPFlag("export-translations", rootCmd.PersistentFlags().Lookup("export-translations"))
Expand Down
11 changes: 9 additions & 2 deletions internal/ghmcp/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ type MCPServerConfig struct {
// ReadOnly indicates if we should only offer read-only tools
ReadOnly bool

// ToolPrefix is an optional prefix to add to all tool names (e.g. "github_")
ToolPrefix string

// Translator provides translated text for the server tooling
Translator translations.TranslationHelperFunc
}
Expand Down Expand Up @@ -138,11 +141,11 @@ func NewMCPServer(cfg MCPServerConfig) (*server.MCPServer, error) {
}

// Register all mcp functionality with the server
tsg.RegisterAll(ghServer)
tsg.RegisterAll(ghServer, cfg.ToolPrefix)

if cfg.DynamicToolsets {
dynamic := github.InitDynamicToolset(ghServer, tsg, cfg.Translator)
dynamic.RegisterTools(ghServer)
dynamic.RegisterTools(ghServer, cfg.ToolPrefix)
}

return ghServer, nil
Expand All @@ -169,6 +172,9 @@ type StdioServerConfig struct {
// ReadOnly indicates if we should only register read-only tools
ReadOnly bool

// ToolPrefix is an optional prefix to add to all tool names (e.g. "github_")
ToolPrefix string

// ExportTranslations indicates if we should export translations
// See: https://github.com/github/github-mcp-server?tab=readme-ov-file#i18n--overriding-descriptions
ExportTranslations bool
Expand All @@ -195,6 +201,7 @@ func RunStdioServer(cfg StdioServerConfig) error {
EnabledToolsets: cfg.EnabledToolsets,
DynamicToolsets: cfg.DynamicToolsets,
ReadOnly: cfg.ReadOnly,
ToolPrefix: cfg.ToolPrefix,
Translator: t,
})
if err != nil {
Expand Down
18 changes: 13 additions & 5 deletions pkg/toolsets/toolsets.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,16 +91,24 @@ func (t *Toolset) GetAvailableTools() []server.ServerTool {
return append(t.readTools, t.writeTools...)
}

func (t *Toolset) RegisterTools(s *server.MCPServer) {
func (t *Toolset) RegisterTools(s *server.MCPServer, prefix string) {
if !t.Enabled {
return
}
for _, tool := range t.readTools {
registerToolWithPrefix := func(tool server.ServerTool) {
if prefix != "" {
// Create a new tool with the prefixed name
tool.Tool.Name = prefix + tool.Tool.Name
}
s.AddTool(tool.Tool, tool.Handler)
}

for _, tool := range t.readTools {
registerToolWithPrefix(tool)
}
if !t.readOnly {
for _, tool := range t.writeTools {
s.AddTool(tool.Tool, tool.Handler)
registerToolWithPrefix(tool)
}
}
}
Expand Down Expand Up @@ -250,9 +258,9 @@ func (tg *ToolsetGroup) EnableToolset(name string) error {
return nil
}

func (tg *ToolsetGroup) RegisterAll(s *server.MCPServer) {
func (tg *ToolsetGroup) RegisterAll(s *server.MCPServer, prefix string) {
for _, toolset := range tg.Toolsets {
toolset.RegisterTools(s)
toolset.RegisterTools(s, prefix)
toolset.RegisterResourcesTemplates(s)
toolset.RegisterPrompts(s)
}
Expand Down