LibreChatMCPServers
by: wally-kroeker
Instructions for setting up SuperGateway MCP servers in docker containers for docker deployments of LibreChat
πOverview
Purpose: To enable seamless integration of Model Context Protocol (MCP) servers with LibreChat using the Supergateway bridge.
Overview: This framework facilitates the operation of stdio-based MCP servers over Server-Sent Events (SSE) in a Docker environment, enhancing LibreChat's capabilities.
Key Features:
-
Stdio to SSE Bridge: Converts stdio communication from MCP servers to SSE, allowing compatibility with LibreChat and improving flexibility in server communication.
-
Docker Integration: Each MCP server runs in its own Docker container with specified network configurations, ensuring isolated environments and easy scalability.
LibreChat MCP Servers
This directory contains Model Context Protocol (MCP) server implementations that extend LibreChat's capabilities through the Supergateway bridge.
These are the projects integrated together:
- The protocol providing tools to the Agent: Model Context Protocol Specification
- Converts stdio MCP servers to SSE allowing each server to run in its own container: Supergateway Documentation
- Multi-LLM agent and MCP client: LibreChat Documentation
Directory Structure
mcp/
βββ brave-search/ # Brave Search API integration
β βββ Dockerfile
β βββ README.md
βββ future-server/ # Template for future MCP servers
β βββ Dockerfile
β βββ README.md
βββ README.md # This file
Adding New MCP Servers
- Create a new directory under
mcp/
for your server - Add required files:
Dockerfile
- Server build configurationREADME.md
- Server-specific documentation
- Update
docker-compose.override.yml
to add your service - Update
librechat.yaml
to configure the MCP server
Common Configuration
Each MCP server should:
- Use Supergateway as a bridge (stdio to SSE)
- Follow consistent port numbering (8003+)
- Connect to the
librechat_default
network - Use environment variables for sensitive data
Port Assignments
- 8003: Brave Search
- 8004-8099: Reserved for future MCP servers
Security Best Practices
- Never commit API keys or sensitive data
- Use environment variables for secrets
- Follow least privilege principle
- Keep services isolated
- Regularly update dependencies
Adding MCP Servers to LibreChat with Supergateway
This guide provides step-by-step instructions for adding MCP servers to LibreChat using Supergateway as a bridge.
Overview
Supergateway allows you to run stdio-based MCP servers over SSE (Server-Sent Events), making it ideal for integrating MCP servers with LibreChat in a Docker environment.
Prerequisites
- A running LibreChat installation
- Docker and Docker Compose
- The MCP server package you want to integrate
Implementation Steps
1. Create Server Directory
Create a directory for your MCP server:
mkdir mcp-server-name
2. Create Dockerfile
Create mcp-server-name/Dockerfile
:
FROM node:18
WORKDIR /app
# Install both supergateway and your MCP server package
RUN npm install -g supergateway @organization/mcp-server-package
# Run supergateway as a bridge between your stdio MCP server and SSE
CMD ["npx", "-y", "supergateway", "--stdio", "npx -y @organization/mcp-server-package", "--port", "8002"]
3. Update docker-compose.override.yml
Add your MCP server service:
services:
mcp-server-name:
build:
context: ./mcp-server-name
ports:
- "8002:8002" # Adjust port as needed
networks:
- librechat_default
environment:
- API_KEY=${YOUR_API_KEY} # If your server needs API keys
volumes:
- ./mcp-server-name:/app # If your server needs access to local files
4. Update librechat.yaml
Add your MCP server configuration:
mcpServers:
server-name:
type: sse
url: "http://mcp-server-name:8002/sse"
Understanding the Architecture
- Your MCP server communicates via stdio.
- Supergateway acts as a bridge, converting stdio to SSE.
- LibreChat connects to the SSE endpoint exposed by Supergateway.
- All services run on the
librechat_default
Docker network and can communicate using service names as hostnames. - Only necessary ports are exposed externally.
Common Configurations
Basic MCP Server
mcpServers:
basic-server:
type: sse
url: "http://basic-server:8002/sse"
MCP Server with API Key
# docker-compose.override.yml
services:
api-server:
environment:
- API_KEY=${API_KEY}
# librechat.yaml
mcpServers:
api-server:
type: sse
url: "http://api-server:8002/sse"
MCP Server with File Access
# docker-compose.override.yml
services:
file-server:
volumes:
- ./data:/app/data
# librechat.yaml
mcpServers:
file-server:
type: sse
url: "http://file-server:8002/sse"
Troubleshooting
- Verify network configuration if connection issues occur.
- Check container logs with
docker compose logs mcp-server-name
. - Ensure ports are not conflicting.
- Verify package installation in Dockerfile and environment variables.
- Review server logs for errors.
- Confirm service names match in all configurations.
- Check network connectivity between containers.
- Make sure SSE endpoint URL is correct.
Best Practices
- Never commit API keys or sensitive data; use environment variables for secrets.
- Limit container permissions and expose only necessary ports.
- Use internal Docker networking when possible and follow least privilege principle.
- Keep configurations modular and document environment variables.
- Use version control for configuration files.
- Log important events, monitor resource usage, and configure health checks.
Example: Complete Setup
Directory Structure
librechat/
βββ mcp-server/
β βββ Dockerfile
βββ docker-compose.override.yml
βββ librechat.yaml
Dockerfile
FROM node:18
WORKDIR /app
RUN npm install -g supergateway @org/mcp-server
CMD ["npx", "-y", "supergateway", "--stdio", "npx -y @org/mcp-server", "--port", "8002"]
docker-compose.override.yml
services:
mcp-server:
build:
context: ./mcp-server
ports:
- "8002:8002"
networks:
- librechat_default
environment:
- API_KEY=${MCP_API_KEY}
librechat.yaml
mcpServers:
mcp-server:
type: sse
url: "http://mcp-server:8002/sse"
References
- Model Context Protocol Specification: https://spec.modelcontextprotocol.io/
- Supergateway Documentation: https://github.com/supercorp-ai/supergateway
- LibreChat Documentation: https://docs.librechat.ai/