MCP Connector

MCP Connector is a lightweight server that can run and manage multiple Model Context Protocol (MCP) servers, specifically designed to integrate with TypingMind. It provides an easy way to run MCP servers on your local computer or a remote server, making it possible to connect your custom AI models or tools with TypingMind through a simple REST API.

---

How to Run on Your Local Device

You can quickly start the MCP Connector using npx (no install required):

npx @typingmind/mcp@latest <auth-token>

- Replace <auth-token> with your authentication token provided by TypingMind.

You can also provide the auth token via an environment variable:

MCP_AUTH_TOKEN=<auth-token> npx @typingmind/mcp@latest

Keep the process running while you use TypingMind.

HTTPS Support

To enable HTTPS, set the following environment variables:

CERTFILE=./path/to/certificate.crt KEYFILE=./path/to/privatekey.key npx @typingmind/mcp@latest <auth-token>

- CERTFILE: Path to your SSL certificate file
- KEYFILE: Path to your SSL private key file

When both variables are set, the server will use HTTPS instead of HTTP.

---

How to Run on a Server

If you prefer running the MCP Connector on a remote server:

1. Install Node.js (version 14 or later).
2. Run the server using npx:

   npx @typingmind/mcp@latest <auth-token>
   

To run with HTTPS:

   CERTFILE=./path/to/certificate.crt KEYFILE=./path/to/privatekey.key npx @typingmind/mcp@latest <auth-token>
   

Alternatively, for persistent running (e.g., after closing SSH), you may use a process manager like pm2 or screen/tmux:

   pm2 start npx -- @typingmind/mcp@latest <auth-token>
   

---

How to Run with Docker

You can also run the MCP Connector using Docker.

1. Build the Docker Image:
Navigate to the project's root directory (where the Dockerfile is located) and run:

    docker build -t mcp-connector .
    

_(You can replace mcp-connector with your preferred image tag.)_

2. Run the Docker Container:

- Basic Run (HTTP):
Replace <auth-token> with your actual token. This command runs the container in detached mode (-d) and maps the container's default port 50880 to the same port on your host machine.

      docker run -d -p 50880:50880 --name mcp-connector-instance mcp-connector <auth-token>
      

- Using a Different Port:
If you need to use a different port (e.g., 8080 on the host mapped to 12345 in the container), use the -p flag for mapping and the -e PORT environment variable:

      docker run -d -p 8080:12345 -e PORT=12345 --name mcp-connector-instance mcp-connector <auth-token>
      

- Running with HTTPS:
To enable HTTPS, you need to provide the certificate and key files and set the CERTFILE and KEYFILE environment variables. Mount your host's certificate files into the container (e.g., into a /certs directory) and provide the paths via environment variables. Remember to map the appropriate port.

      docker run -d \
        -p 50880:50880 \
        -e PORT=50880 \
        -e CERTFILE=/certs/certificate.crt \
        -e KEYFILE=/certs/privatekey.key \
        -v /path/to/your/certificate.crt:/certs/certificate.crt:ro \
        -v /path/to/your/privatekey.key:/certs/privatekey.key:ro \
        --name mcp-connector-instance \
        mcp-connector <auth-token>
      

_(Replace /path/to/your/certificate.crt and /path/to/your/privatekey.key with the actual paths on your host machine. The :ro flag mounts them as read-only.)_

- Viewing Logs:
To see the logs from the running container:

      docker logs mcp-connector-instance
      

- Stopping the Container:

      docker stop mcp-connector-instance
      

- Removing the Container:

      docker rm mcp-connector-instance

      

---

How to Connect to TypingMind

To connect MCP Connector to TypingMind:

1. Follow the instructions at www.typingmind.com/mcp.
2. Paste your MCP Connector server address (http://localhost:<port> or your server’s IP address and port) and your authentication token on the TypingMind MCP integration page.

---

Configuring Tool Call Timeout

You can set a custom timeout for tool calls (in milliseconds) using the TIMEOUT environment variable:

```bash