gavindiaz/mt5-quant
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix binary paths and tarball names across all documentation

Browse Source 
Updated files:
- README.md: Fix tarball filename mt5-quant -> mcp-mt5-quant
- QUICKSTART.md: Fix tarball names and all binary paths
- WINDSURF.md: Fix tarball names, binary paths, and install script paths
- CURSOR.md: Fix tarball names and all binary path references
- VSCODE.md: Fix tarball names and all binary path references

All paths now correctly point to:
- Prebuilt: /path/to/mt5-quant/mcp-server/bin/mt5-quant
- Dev build: /path/to/mt5-quant/target/release/mt5-quant
This commit is contained in:
Devid HW
2026-04-22 08:45:06 +07:00
parent 55e0822051
commit 74c3fdb87e
5 changed files with 36 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -49,7 +49,7 @@ Claude: [compile → clean → backtest → analyze 1,847 deals]
### Option 1: Pre-built Binary (Recommended) ### Option 1: Pre-built Binary (Recommended)
```bash ```bash
curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-macos-arm64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-macos-arm64.tar.gz
tar -xzf mt5.tar.gz tar -xzf mt5.tar.gz
bash scripts/setup.sh bash scripts/setup.sh
``` ```
docs/CURSOR.md
+9 -9
View File
@@ -6,12 +6,12 @@
```bash ```bash
# macOS (Apple Silicon) # macOS (Apple Silicon)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-macos-arm64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-macos-arm64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
# Linux (x64) # Linux (x64)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-linux-x64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-linux-x64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
``` ```
### Option 2: Build from Source ### Option 2: Build from Source
@@ -29,7 +29,7 @@ cargo build --release
3. Click **Add Custom MCP** 3. Click **Add Custom MCP**
4. Enter: 4. Enter:
- **Name**: `mt5-quant` - **Name**: `mt5-quant`
- **Command**: `~/.local/bin/mt5-quant` - **Command**: `/path/to/mt5-quant/mcp-server/bin/mt5-quant`
- **Type**: `stdio` - **Type**: `stdio`
### Method 2: Edit mcp.json Directly ### Method 2: Edit mcp.json Directly
@@ -41,7 +41,7 @@ Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
"mcpServers": { "mcpServers": {
"mt5-quant": { "mt5-quant": {
"type": "stdio", "type": "stdio",
"command": "~/.local/bin/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
@@ -56,7 +56,7 @@ cat > ~/.cursor/mcp.json << 'EOF'
"mcpServers": { "mcpServers": {
"mt5-quant": { "mt5-quant": {
"type": "stdio", "type": "stdio",
"command": "/path/to/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
@@ -92,7 +92,7 @@ Arch: arch -x86_64
1. Check MCP panel in Cursor Settings 1. Check MCP panel in Cursor Settings
2. Verify the path is absolute (not relative) 2. Verify the path is absolute (not relative)
3. Test binary: `/path/to/mt5-quant --help` 3. Test binary: `/path/to/mt5-quant/mcp-server/bin/mt5-quant --help`
4. View MCP logs: Output panel → select "MCP" from dropdown 4. View MCP logs: Output panel → select "MCP" from dropdown
### Config interpolation ### Config interpolation
@@ -103,7 +103,7 @@ Cursor supports variable substitution in `mcp.json`:
{ {
"mcpServers": { "mcpServers": {
"mt5-quant": { "mt5-quant": {
"command": "${userHome}/bin/mt5-quant", "command": "${userHome}/mt5-quant/mcp-server/bin/mt5-quant",
"args": ["--config", "${workspaceFolder}/config.yaml"] "args": ["--config", "${workspaceFolder}/config.yaml"]
} }
} }
docs/QUICKSTART.md
+9 -10
View File
@@ -6,12 +6,12 @@
```bash ```bash
# macOS (Apple Silicon) # macOS (Apple Silicon)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-macos-arm64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-macos-arm64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
# Linux (x64) # Linux (x64)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-linux-x64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-linux-x64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
``` ```
### Option B: Build from Source ### Option B: Build from Source
@@ -82,6 +82,7 @@ terminal_dir: "~/Library/Application Support/net.metaquotes.wine.metatrader5/dri
```bash ```bash
claude mcp add io.github.masdevid/mt5-quant -- ~/.local/bin/mt5-quant claude mcp add io.github.masdevid/mt5-quant -- ~/.local/bin/mt5-quant
# Or: claude mcp add mt5-quant -- $(pwd)/mcp-server/bin/mt5-quant
``` ```
Verify: Verify:
@@ -96,10 +97,8 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
```json ```json
{ {
"mcpServers": { "mcpServers": {
"io.github.masdevid/mt5-quant": { "mt5-quant": {
"command": "~/.local/bin/mt5-quant", "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
"disabled": false,
"registry": "io.github.masdevid/mt5-quant"
} }
} }
} }
@@ -113,7 +112,7 @@ Add to `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project):
{ {
"mcpServers": { "mcpServers": {
"mt5-quant": { "mt5-quant": {
"command": "~/.local/bin/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
@@ -129,7 +128,7 @@ Add to `.vscode/mcp.json` in your workspace:
{ {
"servers": { "servers": {
"mt5-quant": { "mt5-quant": {
"command": "/path/to/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
docs/VSCODE.md
+9 -9
View File
@@ -6,12 +6,12 @@
```bash ```bash
# macOS (Apple Silicon) # macOS (Apple Silicon)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-macos-arm64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-macos-arm64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
# Linux (x64) # Linux (x64)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-linux-x64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-linux-x64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
``` ```
### Option 2: Build from Source ### Option 2: Build from Source
@@ -28,7 +28,7 @@ cargo build --release
2. Run `MCP: Add Server` 2. Run `MCP: Add Server`
3. Choose **Workspace** or **User** scope 3. Choose **Workspace** or **User** scope
4. Enter server name: `mt5-quant` 4. Enter server name: `mt5-quant`
5. Enter command: `~/.local/bin/mt5-quant` 5. Enter command: `/path/to/mt5-quant/mcp-server/bin/mt5-quant`
### Method 2: Edit mcp.json Directly ### Method 2: Edit mcp.json Directly
@@ -38,7 +38,7 @@ Add to `.vscode/mcp.json` in your workspace:
{ {
"servers": { "servers": {
"mt5-quant": { "mt5-quant": {
"command": "~/.local/bin/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
@@ -52,7 +52,7 @@ cat > .vscode/mcp.json << 'EOF'
{ {
"servers": { "servers": {
"mt5-quant": { "mt5-quant": {
"command": "~/.local/bin/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
@@ -62,7 +62,7 @@ EOF
### Method 3: VS Code CLI ### Method 3: VS Code CLI
```bash ```bash
code --add-mcp '{"name":"mt5-quant","command":"~/.local/bin/mt5-quant"}' code --add-mcp '{"name":"mt5-quant","command":"/path/to/mt5-quant/mcp-server/bin/mt5-quant"}'
``` ```
## Verify Setup ## Verify Setup
@@ -115,7 +115,7 @@ Add to `.devcontainer/devcontainer.json`:
"mcp": { "mcp": {
"servers": { "servers": {
"mt5-quant": { "mt5-quant": {
"command": "/path/to/mt5-quant" "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
} }
} }
} }
docs/WINDSURF.md
+8 -10
View File
@@ -6,12 +6,12 @@
```bash ```bash
# macOS (Apple Silicon) # macOS (Apple Silicon)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-macos-arm64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-macos-arm64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
# Linux (x64) # Linux (x64)
curl -L -o mt5-quant.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mt5-quant-linux-x64.tar.gz curl -L -o mt5.tar.gz https://github.com/masdevid/mt5-quant/releases/latest/download/mcp-mt5-quant-linux-x64.tar.gz
tar -xzf mt5-quant.tar.gz tar -xzf mt5.tar.gz
``` ```
### Option 2: Build from Source ### Option 2: Build from Source
@@ -27,10 +27,8 @@ Edit `~/.codeium/windsurf/mcp_config.json`:
```json ```json
{ {
"mcpServers": { "mcpServers": {
"io.github.masdevid/mt5-quant": { "mt5-quant": {
"command": "~/.local/bin/mt5-quant", "command": "/path/to/mt5-quant/mcp-server/bin/mt5-quant"
"disabled": false,
"registry": "io.github.masdevid/mt5-quant"
} }
} }
} }
@@ -40,7 +38,7 @@ Or use the automated setup:
```bash ```bash
# Install binary to standard location # Install binary to standard location
cp target/release/mt5-quant ~/.local/bin/ cp mcp-server/bin/mt5-quant ~/.local/bin/
# Then configure # Then configure
bash scripts/setup.sh bash scripts/setup.sh
@@ -98,7 +96,7 @@ The binary auto-detects its config location. No environment variables needed.
### MCP server not appearing ### MCP server not appearing
1. Check Windsurf logs: `~/.windsurf/logs/` 1. Check Windsurf logs: `~/.windsurf/logs/`
2. Verify executable path is absolute 2. Verify executable path is absolute
3. Test executable manually: `./target/release/mt5-quant --help` 3. Test executable manually: `./mcp-server/bin/mt5-quant --help`
### Config not found ### Config not found
Set `MT5_MCP_HOME` environment variable or ensure config is at default location: Set `MT5_MCP_HOME` environment variable or ensure config is at default location: