@@ -6,79 +6,50 @@ This is a Model Context Protocol (MCP) server built with Python to enable AI LLM
6
6
7
7
## Updates
8
8
9
+ - April 23, 2025: Published to PyPi (0.2.0) ✌🏻✌🏻✌🏻
9
10
- April 16, 2025: We have our first minor version release (0.1.0) 🎉🎉🎉
10
11
11
- ## Project Roadmap
12
-
13
- For full version checklist, see [ version-checklist.md] ( docs/roadmap/version-checklist.md ) .
14
-
15
- | Task | Status | Done | Tested |
16
- | ------| --------| ------| --------|
17
- | Connect to MetaTrader 5 terminal | Finished | ✅ | ✅ |
18
- | Develop MetaTrader client module | Finished | ✅ | ✅ |
19
- | Develop MCP Server module | Finished | ✅ | ✅ |
20
- | Implement MCP tools | Finished | ✅ | ✅ |
21
- | Publish to PyPi | On progress | - | - |
22
- | Claude Desktop integration | - | - | - |
23
- | Open WebUI integration | - | - | - |
24
-
25
- ## Documentation
26
-
27
- For developers, see [ Developer's Documentation] ( docs/README.md ) .
28
-
29
- ## Development Instructions
30
-
31
- ### Creating Virtual Environment
32
-
33
- ```
34
- uv venv
35
- ```
36
-
37
- Then, you need to enable the environment in the Terminal.
38
-
39
- Linux or macOS:
40
- ```
41
- source .venv/bin/activate
42
- ```
12
+ ## Installation Guide
43
13
44
- Windows (PowerShell):
45
- ```
46
- .venv\Scripts\Activate.ps1
47
- ```
48
-
49
- ### Installing Package
14
+ Make sure you have Python version 3.10+ and MetaTrader 5 terminal installed in your workspace. Then install the package:
50
15
51
16
``` bash
52
17
pip install metatrader-mcp-server
53
18
```
54
19
55
- ### Building Package
56
-
57
- ```
58
- python -m build
59
- ```
20
+ ## Claude Desktop Integration
60
21
61
- The build result will be in ` dist/ ` folder.
22
+ To use this package to enable trading operations via Claude Desktop app, please add this into your Claude Desktop configuration:
62
23
63
- ### Testing
64
-
65
- To run the test suite and generate a comprehensive Markdown report:
66
-
67
- ``` bash
68
- pytest -s tests
24
+ ``` json
25
+ {
26
+ "mcpServers" : {
27
+ "metatrader" : {
28
+ "command" : " metatrader-mcp-server" ,
29
+ "args" : [
30
+ " --login" , " <YOUR_MT5_LOGIN>" ,
31
+ " --password" , " <YOUR_MT5_PASSWORD>" ,
32
+ " --server" , " <YOUR_MT5_SERVER>"
33
+ ]
34
+ }
35
+ }
36
+ }
69
37
```
70
38
71
- Test reports will be saved in ` tests/reports/ ` with a timestamped filename.
72
-
73
- ### Publishing to Test PyPI
39
+ ## Project Roadmap
74
40
75
- ```
76
- twine upload --repository-url https://test.pypi.org/legacy/ dist/*
77
- ```
41
+ For full version checklist, see [ version-checklist.md] ( docs/roadmap/version-checklist.md ) .
78
42
79
- Enter credentials when required.
43
+ | Task | Status | Done | Tested |
44
+ | ------| --------| ------| --------|
45
+ | Connect to MetaTrader 5 terminal | Finished | ✅ | ✅ |
46
+ | Develop MetaTrader client module | Finished | ✅ | ✅ |
47
+ | Develop MCP Server module | Finished | ✅ | ✅ |
48
+ | Implement MCP tools | Finished | ✅ | ✅ |
49
+ | Publish to PyPi | Finished | ✅ | ✅ |
50
+ | Claude Desktop integration | Finished | ✅ | ✅ |
51
+ | Open WebUI integration | - | - | - |
80
52
81
- ### Usage
53
+ ## Developer Documentation
82
54
83
- ``` bash
84
- metatrader-mcp-server --login < LOGIN> --password < PASSWORD> --server < SERVER>
55
+ For developers, see [ Developer's Documentation] ( docs/README.md ) .
0 commit comments