Streammable HTTP events (#10)

* wip: streammable http server

* chore: removed useless file

* fix: responses and bind

* wip: better code

* fix: misc

* style: imports

* wip: fixes and additions

* feat: docker and aliases

* fix: final tweaks

* fix: node graceful shutown

* wip: tweaks

* chore: docker

* feat: tests

* fix: test

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* feat: staging docker compose

* feat: review changes

* fix: security

* feat: removed features and readme

* feat: reimplemented tmx import

* fix: removed cors origins

* fix: allowed headers

Co-authored-by: Copilot <[email protected]>

* fix: readme typo

Co-authored-by: Copilot <[email protected]>

* Update README.md

* fix: readme

* fix: reamde

* Update README.md

* Update README.md

* Update README.md

* Update README.md

---------

Co-authored-by: Copilot <[email protected]>

Author: ikiwq

.env.example

@@ -0,0 +1,7 @@
+# Http
+HOST=0.0.0.0
+PORT=80
+TRANSPORT=http
+
+# Logging
+LOGGING_LEVEL=info

.gitignore

@@ -18,6 +18,9 @@ coverage/*
 # IntelliJ
 out/
 
+# Env
+.env
+
 # mpeltonen/sbt-idea plugin
 .idea_modules/
 

Dockerfile

@@ -1,27 +1,15 @@
-FROM node:22.13.1-alpine AS builder
+FROM node:22.14.0-alpine
 
-WORKDIR /app
+ENV CI=true
 
-COPY package.json pnpm-lock.yaml ./
-RUN npm install -g pnpm@latest-10
-RUN pnpm install --frozen-lockfile
+RUN apk update && apk upgrade
+RUN apk add curl
 
+WORKDIR /opt
 COPY . .
-RUN pnpm run test
-RUN pnpm run build
-
-
-FROM node:22.13.1-alpine AS release
-
-WORKDIR /app
-
-COPY --from=builder /app/dist /app/dist
-COPY --from=builder /app/package.json /app/package.json
-COPY --from=builder /app/pnpm-lock.yaml /app/pnpm-lock.yaml
-
-ENV NODE_ENV=production
 
 RUN npm install -g pnpm@latest-10
-RUN pnpm install --frozen-lockfile --prod
+RUN pnpm install --frozen-lockfile
+RUN pnpm build
 
-ENTRYPOINT ["node", "/app/dist/index.js"]
+CMD ["node", "dist/index.js"]

README.md

@@ -10,9 +10,9 @@ A Model Context Protocol (MCP) Server for [Lara Translate](https://laratranslate
 - 📖 [Introduction](#-introduction)
 - 🛠 [Available Tools](#-available-tools)
 - 🚀 [Getting Started](#-getting-started)
-  - 📋 [Requirements](#-requirements)
-  - 🔌 [Installation](#-installation)
-- 🧩 [Installation Engines](#-installation-engines)
+  - 📋 [HTTP Server](#http-server-)
+  - 🔌 [STDIO Server](#stdio-server-%EF%B8%8F)
+- 🧪 [Verify Installation](#-verify-installation)
 - 💻 [Popular Clients that supports MCPs](#-popular-clients-that-supports-mcps)
 - 🆘 [Support](#-support)
 
@@ -161,7 +161,7 @@ Lara also lowers the cost of using models like GPT-4 in non-English workflows. S
 
 **Inputs**:
 - `id` (string): ID of the memory to update
-- `tmx` (file path): The path of the TMX file to upload
+- `tmx_content` (string): The content of the tmx file to upload
 - `gzip` (boolean): Indicates if the file is compressed (.gz)
 
 **Returns**: Import details
@@ -177,69 +177,87 @@ Lara also lowers the cost of using models like GPT-4 in non-English workflows. S
 </details>
 
 ## 🚀 Getting Started
+Lara supports both the STDIO and streamable HTTP protocols. For a hassle-free setup, we recommend using the HTTP protocol. If you prefer to use STDIO, it must be installed locally on your machine.
 
-### 📋 Requirements
+You'll find setup instructions for both protocols in the sections below.
 
-- Lara Translate API Credentials
-    - To get them you can refer to the [Official Documentation](https://developers.laratranslate.com/docs/getting-started#step-3---configure-your-credentials)
-- An LLM client that supports Model Context Protocol (MCP), such as Claude Desktop, Cursors, or GitHub Copilot
-- NPX or Docker (depending on your preferred installation method)
+### HTTP Server 🌐
+<details>
+<summary><strong>❌ Clients NOT supporting <code>url</code> configuration (e.g., Claude, OpenAI)</strong></summary>
 
-### 🔌 Installation
+This installation guide is intended for clients that do NOT support the url-based configuration. This option requires Node.js to be installed on your system.
 
-#### Introduction
-The installation process is standardized across all MCP clients. It involves manually adding a configuration object to your client's MCP configuration JSON file.
 > If you're unsure how to configure an MCP with your client, please refer to your MCP client's official documentation.
 
-Lara Translate MCP supports multiple installation methods, including NPX and Docker. \
-Below, we'll use NPX as an example.
-
 ---
 
-#### Installation & Configuration
-
-**Step 1**: Open your client's MCP configuration JSON file with a text editor, then copy and paste the following snippet:
+1. Open your client's MCP configuration JSON file with a text editor, then copy and paste the following snippet:
 
 ```json
 {
   "mcpServers": {
-    "lara-translate": {
+    "lara": {
       "command": "npx",
       "args": [
-        "-y",
-        "@translated/lara-mcp@latest"
+        "mcp-remote",
+        "https://mcp.laratranslate.it/mcp",
+        "--header",
+        "x-lara-access-key-id: ${X_LARA_ACCESS_KEY_ID}",
+        "--header",
+        "x-lara-access-key-secret: ${X_LARA_ACCESS_KEY_SECRET}"
       ],
       "env": {
-        "LARA_ACCESS_KEY_ID": "<YOUR_ACCESS_KEY_ID>",
-        "LARA_ACCESS_KEY_SECRET": "<YOUR_ACCESS_KEY_SECRET>"
+        "X_LARA_ACCESS_KEY_ID": "<YOUR_ACCESS_KEY_ID>",
+        "X_LARA_ACCESS_KEY_SECRET": "<YOUR_ACCESS_KEY_SECRET>"
       }
     }
   }
 }
 ```
 
-**Step 2**: Replace `<YOUR_ACCESS_KEY_ID>` and `<YOUR_ACCESS_KEY_SECRET>` with your Lara Translate API credentials (refer to the [Official Documentation](https://developers.laratranslate.com/docs/getting-started#step-3---configure-your-credentials) for details).
+2. Replace `<YOUR_ACCESS_KEY_ID>` and `<YOUR_ACCESS_KEY_SECRET>` with your Lara Translate API credentials. Refer to the [Official Documentation](https://developers.laratranslate.com/docs/getting-started#step-3---configure-your-credentials) for details.
 
-**Step 3**: Restart your MCP client.
+3. Restart your MCP client.
 
----
+</details>
 
-#### Verify Installation
+<details>
+<summary><strong>✅ Clients supporting <code>url</code> configuration (e.g., Cursor, Continue)</strong></summary>
 
-After restarting your MCP client, you should see Lara Translate MCP in the list of available MCPs.
-> The method for viewing installed MCPs varies by client. Please consult your MCP client's documentation.
+This installation guide is intended for clients that support the url-based configuration. These clients can connect to Lara through a remote HTTP endpoint by specifying a simple configuration object.
 
-To verify that Lara Translate MCP is working correctly, try translating with a simple prompt:
-```text
-Translate with Lara "Hello world" to Spanish
+Some examples of supported clients include Cursor, Continue, OpenDevin, and Aider.
+> If you're unsure how to configure an MCP with your client, please refer to your MCP client's official documentation.
+
+---
+
+1. Open your client's MCP configuration JSON file with a text editor, then copy and paste the following snippet:
+
+```json
+{
+  "mcpServers": {
+    "lara": {
+      "url": "https://mcp.laratranslate.it/mcp",
+      "headers": {
+        "x-lara-access-key-id": "<YOUR_ACCESS_KEY_ID>",
+        "x-lara-access-key-secret": "<YOUR_ACCESS_KEY_SECRET>"
+      }
+    }
+  }
+}
 ```
 
-Your MCP client will begin generating a response. If Lara Translate MCP is properly installed and configured, your client will either request approval for the action or display a notification that Lara Translate is being used.
+2. Replace `<YOUR_ACCESS_KEY_ID>` and `<YOUR_ACCESS_KEY_SECRET>` with your Lara Translate API credentials. Refer to the [Official Documentation](https://developers.laratranslate.com/docs/getting-started#step-3---configure-your-credentials) for details.
 
-## 🧩 Installation Engines
+3. Restart your MCP client.
 
+</details>
+
+---
+
+### STDIO Server 🖥️
 <details>
-<summary><strong>Option 1: Using NPX</strong></summary>
+<summary><strong>Using NPX</strong></summary>
 
 This option requires Node.js to be installed on your system.
 
@@ -263,7 +281,7 @@ This option requires Node.js to be installed on your system.
 </details>
 
 <details>
-<summary><strong>Option 2: Using Docker</strong></summary>
+<summary><strong>Using Docker</strong></summary>
 
 This option requires Docker to be installed on your system.
 
@@ -296,7 +314,7 @@ This option requires Docker to be installed on your system.
 </details>
 
 <details>
-<summary><strong>Option 3: Building from Source</strong></summary>
+<summary><strong>Building from Source</strong></summary>
 
 #### Using Node.js
 
@@ -375,6 +393,18 @@ docker build -t lara-mcp .
 4. Replace `<YOUR_ACCESS_KEY_ID>` and `<YOUR_ACCESS_KEY_SECRET>` with your actual credentials.
 </details>
 
+## 🧪 Verify Installation
+
+After restarting your MCP client, you should see Lara Translate MCP in the list of available MCPs.
+> The method for viewing installed MCPs varies by client. Please consult your MCP client's documentation.
+
+To verify that Lara Translate MCP is working correctly, try translating with a simple prompt:
+```text
+Translate with Lara "Hello world" to Spanish
+```
+
+Your MCP client will begin generating a response. If Lara Translate MCP is properly installed and configured, your client will either request approval for the action or display a notification that Lara Translate is being used.
+
 ## 💻 Popular Clients that supports MCPs 
 
 > For a complete list of MCP clients and their feature support, visit the [official MCP clients page](https://modelcontextprotocol.io/clients).

docker-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  lara-mcp:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: lara-mcp
+    restart: unless-stopped
+    working_dir: /opt
+    command: ["pnpm", "--reporter=silent", "dev"]
+    ports:
+      - ${PORT}:${PORT}
+    env_file:
+      - .env
+    volumes:
+      - ./src:/opt/src
+      - ./.env:/opt/.env
+      - ./package.json:/opt/package.json
+      - ./pnpm-lock.yaml:/opt/pnpm-lock.yaml
+      - ./vitest.config.ts:/opt/vitest.config.ts
+      - ./nodemon.json:/opt/nodemon.json
+      - ./tsconfig.json:/opt/tsconfig.json

nodemon.json

@@ -0,0 +1,5 @@
+{
+  "execMap": {
+    "ts": "tsx"
+  }
+}

package.json

@@ -24,10 +24,17 @@
   "files": [
     "dist"
   ],
+  "imports": {
+    "#env": "./dist/env.js",
+    "#exception": "./dist/exception.js",
+    "#logger": "./dist/logger.js",
+    "#rest/server": "./dist/rest/server.js",
+    "#mcp/server": "./dist/mcp/server.js"
+  },
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf dist && tsc",
+    "dev": "nodemon src/index.ts",
     "start": "node dist/index.js",
-    "dev": "ts-node-esm src/index.ts",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage"
@@ -44,15 +51,23 @@
     "translated"
   ],
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.8.0",
+    "@modelcontextprotocol/sdk": "^1.12.3",
     "@translated/lara": "^1.4.0",
-    "zod": "^3.24.2",
-    "zod-to-json-schema": "^3.24.5"
+    "cors": "^2.8.5",
+    "express": "^5.1.0",
+    "helmet": "^8.1.0",
+    "pino": "^9.7.0",
+    "zod": "^3.25.0"
   },
   "devDependencies": {
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.3",
     "@types/node": "^22.13.14",
+    "@types/supertest": "^6.0.3",
     "@vitest/coverage-v8": "^3.1.1",
-    "ts-node": "^10.9.2",
+    "nodemon": "^3.1.10",
+    "supertest": "^7.1.1",
+    "tsx": "^4.20.3",
     "typescript": "^5.8.2",
     "vitest": "^3.1.1"
   }