You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Welcome to MCP Hub*mcphub.nvim-welcome-to-mcp-hub*
31
+
1. What is MCP HUB?*mcphub.nvim-what-is-mcp-hub?*
31
32
32
-
MCPHub.nvim is a MCP Client for neovim that seamlessly integrates MCP (Model
33
+
MCPHub.nvim is a MCP client for neovim that seamlessly integrates MCP (Model
33
34
Context Protocol) <https://modelcontextprotocol.io/> servers into your editing
34
35
workflow. It provides an intuitive interface for managing, testing, and using
35
-
MCP servers with your favorite LLM chat plugins.
36
+
MCP servers with your favorite chat plugins.
36
37
37
38
38
-
[!IMPORTANT] It is recommended to read the below "Getting Started" section
39
-
before going through the rest of the documentation.
39
+
[!IMPORTANT] It is recommended to read this page before going through the rest
40
+
of the documentation.
40
41
41
-
GETTING STARTED *mcphub.nvim-welcome-to-mcp-hub-getting-started*
42
+
HOW DOES MCP HUB WORK?*mcphub.nvim-what-is-mcp-hub?-how-does-mcp-hub-work?*
42
43
43
44
Let’s break down how MCP Hub operates in simple terms:
44
45
45
-
1. **Declare MCP Servers**- MCP servers are defined in a JSON configuration file
46
-
- Each server can be a local script or a remote endpoint
47
-
- You can configure authentication, environment variables, and other settings
48
46
47
+
MCP CONFIG FILE ~
49
48
49
+
Like any MCP client, MCP Hub requires a configuration file to define the MCP
50
+
servers you want to use. This file is typically located at
51
+
`~/.config/mcphub/servers.json`. MCP Hub supports local `stdio` servers as well
52
+
as remote `streamable-http` or `sse` servers. This is similar to
53
+
`claude_desktop_config.json` file for Claude desktop or `mcp.json` file used by
54
+
VSCode. In fact you can use the same file for MCP Hub as well with some
55
+
additional benefits. It looks something like:
50
56
51
57
>js
52
-
// Example: ~/.config/mcphub/servers.json
53
-
{
54
-
"mcpServers": {
55
-
"fetch": {
56
-
"command": "uvx",
57
-
"args": [
58
-
"mcp-server-fetch"
59
-
]
60
-
},
61
-
"remote-server": {
62
-
"url": "https://api.example.com/mcp"
63
-
}
64
-
}
65
-
}
66
-
<
67
-
68
-
1. **Server Management**- When you start Neovim, our plugin launches the nodejs binary, mcp-hub <https://github.com/ravitemer/mcp-hub> (an Express server)
69
-
- `mcp-hub` binary reads your servers config file and starts the MCP servers
70
-
- It provides a REST API endpoint (default: `http://localhost:37373`) for interacting with servers
58
+
// Example: ~/.config/mcphub/servers.json
59
+
{
60
+
"mcpServers": {
61
+
"fetch": {
62
+
"command": "uvx",
63
+
"args": [
64
+
"mcp-server-fetch"
65
+
]
66
+
},
67
+
"remote-server": {
68
+
"url": "https://api.example.com/mcp"
69
+
}
70
+
}
71
+
}
72
+
<
73
+
74
+
75
+
SERVERS MANAGER ~
76
+
77
+
- When MCP Hub’s `setup()` is called typically when Neovim starts, it launches the nodejs binary, mcp-hub <https://github.com/ravitemer/mcp-hub> with the `servers.json` file.
78
+
- The `mcp-hub` binary reads `servers.json` file and starts the MCP servers.
79
+
- It provides a express REST API endpoint (default: `http://localhost:37373`) for clients to interact with MCP servers
71
80
- The plugin communicates with this endpoint to:
72
81
- Start/stop MCP servers
73
82
- Execute tools, resources, prompts etc
74
-
- Handle real-time server events
83
+
- Handle real-time server events when tools or resources are changed.
84
+
75
85
86
+
USAGE ~
76
87
77
-
2. **Usage**- Use `:MCPHub` command to open the interface
78
-
- Manage servers, tools, and resources
79
-
- Browse and install servers from marketplace
88
+
- Use `:MCPHub` command to open the interface
89
+
- Adding (`<A>`), editing (`<e>`), deleting (`<d>`) MCP servers in easy and intuitive with MCP Hub. You don’t need to edit the `servers.json` file directly.
90
+
- Install servers from the Marketplace (`M`)
91
+
- Toggle servers, tools, and resources etc
80
92
- Test tools and resources directly in Neovim
81
93
82
94
83
-
3. **Chat Integration**- Works with popular chat plugins like Avante <https://github.com/yetone/avante.nvim>, CodeCompanion <https://github.com/olimorris/codecompanion.nvim>, CopilotChat <https://github.com/CopilotC-Nvim/CopilotChat.nvim>
84
-
- LLMs can use MCP servers through our `@mcp` tool
85
-
- Resources show up as `#variables` in chat
86
-
- Prompts become `/slash_commands`
95
+
CHAT INTEGRATIONS ~
96
+
97
+
- MCP Hub provides integrations with popular chat plugins like Avante <https://github.com/yetone/avante.nvim>, CodeCompanion <https://github.com/olimorris/codecompanion.nvim>, CopilotChat <https://github.com/CopilotC-Nvim/CopilotChat.nvim>.
98
+
- LLMs can use MCP servers through our `@mcp` tool.
99
+
- Resources show up as `#variables` in chat.
100
+
- Prompts become `/slash_commands`.
101
+
102
+
103
+
FEATURE SUPPORT MATRIX *mcphub.nvim-what-is-mcp-hub?-feature-support-matrix*
0 commit comments