@codesys/mcp-toolkit 1.0.1 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -26
- package/CONTRIBUTING.md +72 -72
- package/LICENSE +21 -21
- package/README.md +254 -254
- package/README.md.enhanced +155 -155
- package/dist/codesys_interop.js +55 -44
- package/dist/server.js +879 -879
- package/docs/configuration.md +119 -119
- package/docs/index.md +26 -26
- package/docs/installation.md +84 -84
- package/examples/README.md +78 -78
- package/examples/sample_config.json +32 -32
- package/package.json +47 -47
- package/dist/codesys_interop - Copy.js +0 -180
- package/dist/server - Copy.js +0 -1444
package/CHANGELOG.md
CHANGED
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
# Changelog
|
|
2
|
-
|
|
3
|
-
All notable changes to this project will be documented in this file.
|
|
4
|
-
|
|
5
|
-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
-
|
|
8
|
-
## [1.0.0] - 2025-04-23
|
|
9
|
-
|
|
10
|
-
### Added
|
|
11
|
-
- Initial release of the MCP server for CODESYS
|
|
12
|
-
- Command-line interface with configuration options
|
|
13
|
-
- Project management functionality:
|
|
14
|
-
- Opening existing CODESYS projects
|
|
15
|
-
- Creating new CODESYS projects
|
|
16
|
-
- Saving projects
|
|
17
|
-
- POU (Program Organization Unit) management:
|
|
18
|
-
- Creating POUs (Programs, Function Blocks, Functions)
|
|
19
|
-
- Setting POU code (declaration and implementation)
|
|
20
|
-
- Creating properties and methods for Function Blocks
|
|
21
|
-
- Project compilation support
|
|
22
|
-
- Resources for querying:
|
|
23
|
-
- Project status
|
|
24
|
-
- Project structure
|
|
25
|
-
- POU code
|
|
26
|
-
- Documentation for installation and usage
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [1.0.0] - 2025-04-23
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Initial release of the MCP server for CODESYS
|
|
12
|
+
- Command-line interface with configuration options
|
|
13
|
+
- Project management functionality:
|
|
14
|
+
- Opening existing CODESYS projects
|
|
15
|
+
- Creating new CODESYS projects
|
|
16
|
+
- Saving projects
|
|
17
|
+
- POU (Program Organization Unit) management:
|
|
18
|
+
- Creating POUs (Programs, Function Blocks, Functions)
|
|
19
|
+
- Setting POU code (declaration and implementation)
|
|
20
|
+
- Creating properties and methods for Function Blocks
|
|
21
|
+
- Project compilation support
|
|
22
|
+
- Resources for querying:
|
|
23
|
+
- Project status
|
|
24
|
+
- Project structure
|
|
25
|
+
- POU code
|
|
26
|
+
- Documentation for installation and usage
|
package/CONTRIBUTING.md
CHANGED
|
@@ -1,72 +1,72 @@
|
|
|
1
|
-
# Contributing to @codesys/mcp-toolkit
|
|
2
|
-
|
|
3
|
-
Thank you for considering contributing to the CODESYS MCP Toolkit! This document provides guidelines and steps for contributing.
|
|
4
|
-
|
|
5
|
-
## Code of Conduct
|
|
6
|
-
|
|
7
|
-
Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.
|
|
8
|
-
|
|
9
|
-
## How Can I Contribute?
|
|
10
|
-
|
|
11
|
-
### Reporting Bugs
|
|
12
|
-
|
|
13
|
-
Bug reports help improve the project! When reporting bugs:
|
|
14
|
-
|
|
15
|
-
1. Check if the bug has already been reported
|
|
16
|
-
2. Use the bug report template
|
|
17
|
-
3. Include detailed steps to reproduce the issue
|
|
18
|
-
4. Describe the expected vs. actual behavior
|
|
19
|
-
5. Include screenshots if applicable
|
|
20
|
-
6. Provide environment details (OS, Node.js version, etc.)
|
|
21
|
-
|
|
22
|
-
### Suggesting Features
|
|
23
|
-
|
|
24
|
-
We welcome feature suggestions! When suggesting features:
|
|
25
|
-
|
|
26
|
-
1. Describe the problem your feature would solve
|
|
27
|
-
2. Explain how your feature would work
|
|
28
|
-
3. Consider potential alternatives
|
|
29
|
-
4. Provide examples of similar features in other projects (if applicable)
|
|
30
|
-
|
|
31
|
-
### Pull Requests
|
|
32
|
-
|
|
33
|
-
1. Fork the repository
|
|
34
|
-
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
|
35
|
-
3. Make your changes
|
|
36
|
-
4. Run tests and ensure they pass
|
|
37
|
-
5. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
38
|
-
6. Push to your branch (`git push origin feature/amazing-feature`)
|
|
39
|
-
7. Open a Pull Request
|
|
40
|
-
|
|
41
|
-
## Development Setup
|
|
42
|
-
|
|
43
|
-
1. Clone the repository
|
|
44
|
-
```bash
|
|
45
|
-
git clone https://github.com/yourusername/codesys-mcp-toolkit.git
|
|
46
|
-
cd codesys-mcp-toolkit
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
2. Install dependencies
|
|
50
|
-
```bash
|
|
51
|
-
npm install
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
3. Build the project
|
|
55
|
-
```bash
|
|
56
|
-
npm run build
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
## Style Guidelines
|
|
60
|
-
|
|
61
|
-
- Follow existing code formatting patterns
|
|
62
|
-
- Use meaningful variable and function names
|
|
63
|
-
- Add comments where necessary to explain complex logic
|
|
64
|
-
- Update documentation when changing functionality
|
|
65
|
-
|
|
66
|
-
## Testing
|
|
67
|
-
|
|
68
|
-
- Add tests for new features
|
|
69
|
-
- Ensure all tests pass before submitting a PR
|
|
70
|
-
- Consider edge cases in your tests
|
|
71
|
-
|
|
72
|
-
Thank you for contributing!
|
|
1
|
+
# Contributing to @codesys/mcp-toolkit
|
|
2
|
+
|
|
3
|
+
Thank you for considering contributing to the CODESYS MCP Toolkit! This document provides guidelines and steps for contributing.
|
|
4
|
+
|
|
5
|
+
## Code of Conduct
|
|
6
|
+
|
|
7
|
+
Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.
|
|
8
|
+
|
|
9
|
+
## How Can I Contribute?
|
|
10
|
+
|
|
11
|
+
### Reporting Bugs
|
|
12
|
+
|
|
13
|
+
Bug reports help improve the project! When reporting bugs:
|
|
14
|
+
|
|
15
|
+
1. Check if the bug has already been reported
|
|
16
|
+
2. Use the bug report template
|
|
17
|
+
3. Include detailed steps to reproduce the issue
|
|
18
|
+
4. Describe the expected vs. actual behavior
|
|
19
|
+
5. Include screenshots if applicable
|
|
20
|
+
6. Provide environment details (OS, Node.js version, etc.)
|
|
21
|
+
|
|
22
|
+
### Suggesting Features
|
|
23
|
+
|
|
24
|
+
We welcome feature suggestions! When suggesting features:
|
|
25
|
+
|
|
26
|
+
1. Describe the problem your feature would solve
|
|
27
|
+
2. Explain how your feature would work
|
|
28
|
+
3. Consider potential alternatives
|
|
29
|
+
4. Provide examples of similar features in other projects (if applicable)
|
|
30
|
+
|
|
31
|
+
### Pull Requests
|
|
32
|
+
|
|
33
|
+
1. Fork the repository
|
|
34
|
+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
|
35
|
+
3. Make your changes
|
|
36
|
+
4. Run tests and ensure they pass
|
|
37
|
+
5. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
38
|
+
6. Push to your branch (`git push origin feature/amazing-feature`)
|
|
39
|
+
7. Open a Pull Request
|
|
40
|
+
|
|
41
|
+
## Development Setup
|
|
42
|
+
|
|
43
|
+
1. Clone the repository
|
|
44
|
+
```bash
|
|
45
|
+
git clone https://github.com/yourusername/codesys-mcp-toolkit.git
|
|
46
|
+
cd codesys-mcp-toolkit
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
2. Install dependencies
|
|
50
|
+
```bash
|
|
51
|
+
npm install
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
3. Build the project
|
|
55
|
+
```bash
|
|
56
|
+
npm run build
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Style Guidelines
|
|
60
|
+
|
|
61
|
+
- Follow existing code formatting patterns
|
|
62
|
+
- Use meaningful variable and function names
|
|
63
|
+
- Add comments where necessary to explain complex logic
|
|
64
|
+
- Update documentation when changing functionality
|
|
65
|
+
|
|
66
|
+
## Testing
|
|
67
|
+
|
|
68
|
+
- Add tests for new features
|
|
69
|
+
- Ensure all tests pass before submitting a PR
|
|
70
|
+
- Consider edge cases in your tests
|
|
71
|
+
|
|
72
|
+
Thank you for contributing!
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 CODESYS MCP Server Contributors
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 CODESYS MCP Server Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|