Add 'path' to config

Author: ariadng

.env.example

@@ -2,3 +2,6 @@
 LOGIN=your_login_here
 PASSWORD=your_password_here
 SERVER=your_server_here
+
+# Optional: Path to MT5 terminal executable (auto-detected if not specified)
+# PATH=C:\Program Files\MetaTrader 5\terminal64.exe

CLAUDE.md

@@ -5,7 +5,7 @@
 MCP server enabling AI assistants to trade on MetaTrader 5 via natural language. Provides both MCP (stdio) and HTTP/REST interfaces.
 
 **Stack**: Python 3.10+ • FastMCP • FastAPI • MetaTrader5 SDK • Pandas • Pydantic • pytest
-**Version**: 0.2.8 (Beta)
+**Version**: 0.2.9 (Beta)
 **Repo**: https://github.com/ariadng/metatrader-mcp-server
 
 ---
@@ -79,7 +79,23 @@ def operation(connection, *, param: type, optional: Optional[type] = None):
 ```python
 from metatrader_client import MT5Client
 
+# Minimal configuration
 config = {"login": int(login), "password": password, "server": server}
+
+# Full configuration with all available options
+config = {
+    "login": int(login),         # Required: MT5 account login
+    "password": password,         # Required: MT5 account password
+    "server": server,             # Required: MT5 server name
+    "path": None,                 # Optional: Path to terminal executable (auto-detect if None)
+    "timeout": 60000,             # Optional: Connection timeout in ms (default: 60000)
+    "portable": False,            # Optional: Use portable mode (default: False)
+    "max_retries": 3,             # Optional: Max connection retries (default: 3)
+    "backoff_factor": 1.5,        # Optional: Retry delay multiplier (default: 1.5)
+    "cooldown_time": 2.0,         # Optional: Seconds between connections (default: 2.0)
+    "debug": False                # Optional: Enable debug logging (default: False)
+}
+
 client = MT5Client(config)
 client.connect()
 # operations...

README.md

@@ -128,6 +128,26 @@ Pick one based on how you want to use it:
 }
 ```
 
+**Optional: Specify Custom MT5 Terminal Path**
+
+If your MT5 terminal is installed in a non-standard location, add the `--path` argument:
+
+```json
+{
+  "mcpServers": {
+    "metatrader": {
+      "command": "metatrader-mcp-server",
+      "args": [
+        "--login",    "YOUR_MT5_LOGIN",
+        "--password", "YOUR_MT5_PASSWORD",
+        "--server",   "YOUR_MT5_SERVER",
+        "--path",     "C:\\Program Files\\MetaTrader 5\\terminal64.exe"
+      ]
+    }
+  }
+}
+```
+
 3. Replace `YOUR_MT5_LOGIN`, `YOUR_MT5_PASSWORD`, and `YOUR_MT5_SERVER` with your actual credentials
 
 4. Restart Claude Desktop
@@ -142,6 +162,14 @@ Pick one based on how you want to use it:
 metatrader-http-server --login YOUR_LOGIN --password YOUR_PASSWORD --server YOUR_SERVER --host 0.0.0.0 --port 8000
 ```
 
+**Optional: Specify Custom MT5 Terminal Path**
+
+If your MT5 terminal is installed in a non-standard location, add the `--path` argument:
+
+```bash
+metatrader-http-server --login YOUR_LOGIN --password YOUR_PASSWORD --server YOUR_SERVER --path "C:\Program Files\MetaTrader 5\terminal64.exe" --host 0.0.0.0 --port 8000
+```
+
 2. Open your browser to `http://localhost:8000/docs` to see the API documentation
 
 3. In Open WebUI:
@@ -305,6 +333,9 @@ Instead of putting credentials in the command line, create a `.env` file:
 LOGIN=12345678
 PASSWORD=your_password
 SERVER=MetaQuotes-Demo
+
+# Optional: Specify custom MT5 terminal path (auto-detected if not provided)
+# PATH=C:\Program Files\MetaTrader 5\terminal64.exe
 ```
 
 Then start the server without arguments:
@@ -313,6 +344,8 @@ Then start the server without arguments:
 metatrader-http-server
 ```
 
+The server will automatically load credentials from the `.env` file.
+
 ### Custom Port and Host
 
 ```bash
@@ -328,14 +361,29 @@ config = {
     "login": 12345678,
     "password": "your_password",
     "server": "MetaQuotes-Demo",
-    "timeout": 60000,           # Connection timeout (ms)
-    "max_retries": 3,           # Retry attempts
-    "backoff_factor": 1.5,      # Delay multiplier between retries
-    "cooldown_time": 2.0,       # Seconds to wait between connections
-    "debug": True               # Enable debug logging
+    "path": None,               # Path to MT5 terminal executable (default: auto-detect)
+    "timeout": 60000,           # Connection timeout in milliseconds (default: 60000)
+    "portable": False,          # Use portable mode (default: False)
+    "max_retries": 3,           # Maximum connection retry attempts (default: 3)
+    "backoff_factor": 1.5,      # Delay multiplier between retries (default: 1.5)
+    "cooldown_time": 2.0,       # Seconds to wait between connections (default: 2.0)
+    "debug": True               # Enable debug logging (default: False)
 }
 ```
 
+**Configuration Options:**
+
+- **login** (int, required): Your MT5 account login number
+- **password** (str, required): Your MT5 account password
+- **server** (str, required): MT5 server name (e.g., "MetaQuotes-Demo")
+- **path** (str, optional): Full path to the MT5 terminal executable. If not specified, the client will automatically search standard installation directories
+- **timeout** (int, optional): Connection timeout in milliseconds. Default: 60000 (60 seconds)
+- **portable** (bool, optional): Enable portable mode for the MT5 terminal. Default: False
+- **max_retries** (int, optional): Maximum number of connection retry attempts. Default: 3
+- **backoff_factor** (float, optional): Exponential backoff factor for retry delays. Default: 1.5
+- **cooldown_time** (float, optional): Minimum time in seconds between connection attempts. Default: 2.0
+- **debug** (bool, optional): Enable detailed debug logging for troubleshooting. Default: False
+
 ---
 
 ## 🗺️ Roadmap
@@ -468,7 +516,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## 📊 Project Stats
 
-- **Version**: 0.2.8
+- **Version**: 0.2.9
 - **Python**: 3.10+
 - **License**: MIT
 - **Status**: Active Development

docs/metatrader_client/README.md

@@ -32,16 +32,45 @@ from metatrader_client.client import MT5Client
 ```python
 from metatrader_client.client import MT5Client
 
+# Minimal configuration
 config = {
     "login": 12345678,
     "password": "your_password",
-    "server": "Broker-Server",
-    # Optional: path, timeout, portable, debug, etc.
+    "server": "Broker-Server"
+}
+
+# Full configuration with all available options
+config = {
+    "login": 12345678,           # Required: MT5 account login number
+    "password": "your_password",  # Required: MT5 account password
+    "server": "Broker-Server",    # Required: MT5 server name
+    "path": None,                 # Optional: Path to terminal executable (auto-detect if None)
+    "timeout": 60000,             # Optional: Connection timeout in ms (default: 60000)
+    "portable": False,            # Optional: Use portable mode (default: False)
+    "max_retries": 3,             # Optional: Max connection retries (default: 3)
+    "backoff_factor": 1.5,        # Optional: Retry delay multiplier (default: 1.5)
+    "cooldown_time": 2.0,         # Optional: Seconds between connections (default: 2.0)
+    "debug": False                # Optional: Enable debug logging (default: False)
 }
 
 client = MT5Client(config)
 ```
 
+### Configuration Parameters
+
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `login` | int | Yes | - | Your MT5 account login number |
+| `password` | str | Yes | - | Your MT5 account password |
+| `server` | str | Yes | - | MT5 server name (e.g., "MetaQuotes-Demo") |
+| `path` | str | No | None | Full path to MT5 terminal executable (auto-detected if not provided) |
+| `timeout` | int | No | 60000 | Connection timeout in milliseconds |
+| `portable` | bool | No | False | Enable portable mode for MT5 terminal |
+| `max_retries` | int | No | 3 | Maximum number of connection retry attempts |
+| `backoff_factor` | float | No | 1.5 | Exponential backoff factor for retry delays |
+| `cooldown_time` | float | No | 2.0 | Minimum time in seconds between connection attempts |
+| `debug` | bool | No | False | Enable detailed debug logging for troubleshooting |
+
 ---
 
 ## Main Attributes & Methods 🧩

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metatrader-mcp-server"
-version = "0.2.8"
+version = "0.2.9"
 authors = [
   { name = "Aria Dhanang", email = "ariadng@gmail.com" },
 ]

src/metatrader_mcp/cli.py

@@ -7,13 +7,16 @@
 @click.option("--login", required=True, type=int, help="MT5 login ID")
 @click.option("--password", required=True, help="MT5 password")
 @click.option("--server", required=True, help="MT5 server name")
-def main(login, password, server):
+@click.option("--path", default=None, help="Path to MT5 terminal executable (optional, auto-detected if not provided)")
+def main(login, password, server, path):
     """Launch the MetaTrader MCP STDIO server."""
     load_dotenv()
     # override env vars if provided via CLI
     os.environ["login"] = str(login)
     os.environ["password"] = password
     os.environ["server"] = server
+    if path:
+        os.environ["path"] = path
     # run STDIO transport
     mcp.run(transport="stdio")
 

src/metatrader_mcp/server.py

@@ -23,7 +23,12 @@ class AppContext:
 async def app_lifespan(server: FastMCP) -> AsyncIterator[AppContext]:
 
 	try:
-		client = init(os.getenv("login"), os.getenv("password"), os.getenv("server"))
+		client = init(
+			os.getenv("login"),
+			os.getenv("password"),
+			os.getenv("server"),
+			os.getenv("path")
+		)
 		yield AppContext(client=client)
 	finally:
 		client.disconnect()
@@ -229,13 +234,15 @@ def cancel_pending_orders_by_symbol(ctx: Context, symbol: str) -> dict:
 	parser.add_argument("--login",    type=str, help="MT5 login")
 	parser.add_argument("--password", type=str, help="MT5 password")
 	parser.add_argument("--server",   type=str, help="MT5 server name")
-	
+	parser.add_argument("--path",     type=str, help="Path to MT5 terminal executable (optional)")
+
 	args = parser.parse_args()
 
 	# inject into lifespan via env vars
 	if args.login:    os.environ["login"]    = args.login
 	if args.password: os.environ["password"] = args.password
 	if args.server:   os.environ["server"]   = args.server
+	if args.path:     os.environ["path"]     = args.path
 
 	# run the MCP server (must call mcp.run)
 	mcp.run(

src/metatrader_mcp/utils.py

@@ -5,6 +5,7 @@ def init(
 	login: Optional[Union[str, int]],
 	password: Optional[str],
 	server: Optional[str],
+	path: Optional[str] = None,
 ) -> Optional[client.MT5Client]:
 	"""
 	Initialize MT5Client
@@ -13,17 +14,24 @@ def init(
 		login (Optional[Union[str, int]]): Login ID
 		password (Optional[str]): Password
 		server (Optional[str]): Server name
+		path (Optional[str]): Path to MT5 terminal executable (default: None for auto-detect)
 
 	Returns:
 		Optional[client.MT5Client]: MT5Client instance if all parameters are provided, None otherwise
 	"""
-	
+
 	if login and password and server:
-		mt5_client = client.MT5Client(config={
+		config = {
 			"login": int(login),
 			"password": password,
 			"server": server,
-		})
+		}
+
+		# Add path to config if provided
+		if path:
+			config["path"] = path
+
+		mt5_client = client.MT5Client(config=config)
 		mt5_client.connect()
 		return mt5_client
 

src/metatrader_openapi/config.py

@@ -22,7 +22,7 @@ class Settings(BaseSettings):
     docs_url: str = "/docs"
     redoc_url: str = "/redoc"
     title: str = "MetaTrader MCP API"
-    version: str = "0.2.8"
+    version: str = "0.2.9"
 
     # Load from env vars prefixed with OPENAPI_
     model_config = SettingsConfigDict(env_prefix="OPENAPI_")

src/metatrader_openapi/main.py

@@ -22,7 +22,8 @@ async def lifespan(app):
     login = os.getenv("LOGIN", os.getenv("login"))
     password = os.getenv("PASSWORD", os.getenv("password"))
     server = os.getenv("SERVER", os.getenv("server"))
-    client = init(login, password, server)
+    path = os.getenv("PATH", os.getenv("path"))
+    client = init(login, password, server, path)
     app.state.client = client
     yield
     if client:
@@ -62,6 +63,7 @@ def main():
     parser.add_argument("--login", required=True, help="MT5 login")
     parser.add_argument("--password", required=True, help="MT5 password")
     parser.add_argument("--server", required=True, help="MT5 server address")
+    parser.add_argument("--path", default=None, help="Path to MT5 terminal executable (optional, auto-detected if not provided)")
     parser.add_argument("--host", default="127.0.0.1", help="Bind host")
     parser.add_argument("--port", type=int, default=8000, help="Bind port")
     args = parser.parse_args()
@@ -73,6 +75,9 @@ def main():
     os.environ["login"] = args.login
     os.environ["password"] = args.password
     os.environ["server"] = args.server
+    if args.path:
+        os.environ["PATH"] = args.path
+        os.environ["path"] = args.path
 
     uvicorn.run(
         "metatrader_openapi.main:app",