LIBRECHAT.md

cf-kaizen

Getting started with LibreChat

• You're going to need to know of one or more API endpoints for cf-butler and/or cf-hoover application instance(s).
• Then you'll want to integrate one or both of the butler and hoover MCP servers (running locally or remotely)

Prerequisites

• one or more cf-butler and/or cf-hoover instance(s) deployed
  • take a look at the deploy script for how to build and deploy each of these instances
• the following CLIs/SDKs:
  • git
  • gh
  • java
  • mvn
  • (optionally) sdk
    • it might be the easiest way to install the Java SDK and Maven
• Docker Desktop
• LibreChat

Building

cd /tmp
gh repo clone cf-toolsuite/cf-kaizen
cd cf-kaizen
mvn install

Configuring LibreChat

Clone the repository and initialize configuration based off the example

gh repo clone danny-avila/LibreChat
cd LibreChat
cp docker-compose.override.yml.example docker-compose.override.yml
cp librechat.example.yaml librechat.yaml
cp .env.example .env

Now, make sure the following configurations are in each file.

docker-compose.override.yml

Edit the file. This should be the only content within the file, then save your changes.

services:
  api:
    volumes:
      - type: bind
        source: ./librechat.yaml
        target: /app/librechat.yaml

librechat.yaml

Consult the documentation on MCP Servers Object Structure.

Edit the file. Focus on the mcpServers stanza and make the additions as you see below, then save your changes.

mcpServers:
  butler:
    # remote (update domain)
    # url: http://cf-kaizen-butler-server.apps.tas.z52772e75.shepherd.lease/sse
    # local
    url: http://localhost:8082/sse
    timeout: 120000
  hoover:
    # remote (update domain)
    # url: http://cf-kaizen-hoover-server.apps.tas.z52772e75.shepherd.lease/sse
    # local
    url: http://localhost:8084/sse
    timeout: 120000

Then start the UI

echo $GITHUB_TOKEN | docker login ghcr.io -u USERNAME --password-stdin
docker compose up -d

Replace USERNAME above with your GitHub account username. And make sure you exported a valid GITHUB_TOKEN environment variable beforehand. If you're unsure how to setup your token, consult this documentation.

The UI will be accessible on http://localhost:3080.

After signing up for a new account, you'll want to create an agent for each MCP server you registered in librechat.yaml.

Consult the Agents documentation for how to do that.

Note

Here's an example of an agent named "Marsden" answering an inquiry via a Butler MCP server instance.