☁️ docs: Update MCP docs for Dynamic Registration and CH MCP (#511)
* docs: update mcp servers for dynamic registration in UI and add clickhouse cloud instructions * chore: better verbiage on dynamic mcp registration docs * chore: reword sentence
@@ -49,12 +49,12 @@ mcpServers:
|
||||
MCP servers integrate seamlessly with LibreChat Agents:
|
||||
|
||||
1. Create or edit an agent
|
||||
2. Click "Add Tools" to open the Tools Dialog from the Agent Builder panel
|
||||
2. Click "Add MCP Server Tools" to open the Tools Dialog from the Agent Builder panel
|
||||
3. Select MCP servers once added, each appears as a single entry
|
||||
4. Fine-tune by enabling/disabling individual tools after adding
|
||||
4. Fine-tune your agent's capabilites by enabling/disabling individual tools after adding
|
||||
5. Save your agent
|
||||
|
||||

|
||||

|
||||
|
||||
This higher-level organization keeps the interface manageable - even servers with 20+ tools (like Spotify) appear as single entries that can be expanded for granular control.
|
||||
|
||||
@@ -64,6 +64,11 @@ Add MCP servers to your `librechat.yaml` file manually:
|
||||
|
||||
```yaml
|
||||
mcpServers:
|
||||
# ClickHouse Cloud
|
||||
clickhouse-cloud:
|
||||
type: streamable-http
|
||||
url: https://mcp.clickhouse.cloud/mcp
|
||||
|
||||
# File system access
|
||||
filesystem:
|
||||
command: npx
|
||||
@@ -90,6 +95,59 @@ mcpServers:
|
||||
serverInstructions: true
|
||||
```
|
||||
|
||||
### Adding MCP Servers in the UI
|
||||
|
||||
You can also add and configure MCP servers directly from the LibreChat interface without editing any configuration files or restarting the server.
|
||||
|
||||
#### Step 1: Open the MCP Settings Panel
|
||||
|
||||
Navigate to the **MCP Settings** panel from the right sidebar. You'll see any existing MCP servers listed here along with a **+** button to add new ones.
|
||||
|
||||

|
||||
|
||||
#### Step 2: Fill Out Server Details
|
||||
|
||||
Press the **+** button and fill out your MCP server name, description, URL, transport type, and authentication method, then click **Create**.
|
||||
|
||||

|
||||
|
||||
Your new server will appear in the MCP Settings panel with a confirmation toast.
|
||||
|
||||

|
||||
|
||||
#### Step 3: Check Connection Status and Authenticate
|
||||
|
||||
Review the [connection status indicator](#connection-status-indicators) for your new server. If the server requires OAuth authentication, the status will show as disconnected. Click the server's authenticate/connect button (you can do this either by clicking on the MCP server itself in the chat dropdown menu, or by clicking on the connection icon first to be taken to a dialog with more information on the connection state) to begin the authentication flow.
|
||||
|
||||

|
||||
|
||||
Once initiated, the status indicator will update to show that authentication is in progress.
|
||||
|
||||

|
||||
|
||||
#### Step 4: Continue in the OAuth Tab
|
||||
|
||||
A new browser tab will open for the OAuth provider. Verify the callback URL and click **Continue** to authorize LibreChat.
|
||||
|
||||

|
||||
|
||||
#### Step 5: Authentication Successful
|
||||
|
||||
After authenticating, you'll see a success confirmation. This window will automatically close and redirect you back to LibreChat.
|
||||
|
||||

|
||||
|
||||
#### Step 6: Server Ready for Use
|
||||
|
||||
LibreChat acknowledges the successful authentication and automatically selects the MCP server for use within your conversation. The server now shows a connected status indicator and is checked in the MCP Servers dropdown.
|
||||
|
||||

|
||||
|
||||
Your new MCP server is also available in the Agent Builder, where you can add its tools to any agent and customize what subset of tools are allowed.
|
||||
|
||||

|
||||
|
||||
|
||||
### Adding MCP Servers with Smithery
|
||||
|
||||
Smithery.ai provides a streamlined way to discover and install MCP servers for LibreChat. Follow these steps to get started:
|
||||
|
||||
BIN
public/images/mcp/mcp_ui_agent.png
Normal file
|
After Width: | Height: | Size: 335 KiB |
BIN
public/images/mcp/mcp_ui_authenticating.png
Normal file
|
After Width: | Height: | Size: 323 KiB |
BIN
public/images/mcp/mcp_ui_callback_confirm.png
Normal file
|
After Width: | Height: | Size: 206 KiB |
BIN
public/images/mcp/mcp_ui_configure.png
Normal file
|
After Width: | Height: | Size: 359 KiB |
BIN
public/images/mcp/mcp_ui_done.png
Normal file
|
After Width: | Height: | Size: 340 KiB |
BIN
public/images/mcp/mcp_ui_settings_panel.png
Normal file
|
After Width: | Height: | Size: 283 KiB |
BIN
public/images/mcp/mcp_ui_success_redirect.png
Normal file
|
After Width: | Height: | Size: 176 KiB |
BIN
public/images/mcp/mcp_ui_success_registered.png
Normal file
|
After Width: | Height: | Size: 308 KiB |
BIN
public/images/mcp/mcp_ui_unconnected.png
Normal file
|
After Width: | Height: | Size: 329 KiB |