Skip to content
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

feat: add cmd and cmdArgs config options #32

Merged
Merged
Prev Previous commit
Next Next commit
feat(config): improve configuration with zero-config and flexible ins…
…tallation

This update significantly improves the plugin's configuration and installation
flexibility, with an emphasis on zero-config usage.

Zero Configuration Support:

Default port to 37373
Default config path to ~/.config/mcphub/servers.json
Auto-create config file with empty mcpServers object
Works out of the box with just require("mcphub").setup({})
Installation Improvements:

Default Installation (Global npm):

Continues to work with npm install -g mcp-hub
No additional configuration needed

Bundled Installation (No global npm access):

Add bundled_build.lua for local mcp-hub installation
Auto-updates with plugin updates
Enable with use_bundled_binary = true
No global npm permissions required

Custom Installation Support:

Flexible cmd and cmdArgs configuration
Supports NixOS and other custom environments
Example configurations provided in docs

Documentation:
Updated README with all installation methods
Added zero-config setup examples
Improved configuration documentation
Clear guidance for different use cases
Breaking Changes: None. Enhances existing functionality while
maintaining backward compatibility.
ravitemer committed Mar 22, 2025
commit 0c2c70d1788b06d06e1c49e5da219b598370f000
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -2,5 +2,6 @@
node_modules
junk/
*.avanterules
bundled/

.r*