@codesys/mcp-toolkit 1.1.4 → 1.1.6

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.
Files changed (12) hide show
  1. package/.claude/settings.local.json +10 -0
  2. package/CHANGELOG.md +36 -26
  3. package/CONTRIBUTING.md +72 -72
  4. package/LICENSE +21 -21
  5. package/README.md +145 -145
  6. package/README.md.enhanced +155 -155
  7. package/docs/index.md +26 -26
  8. package/docs/installation.md +84 -84
  9. package/examples/README.md +78 -78
  10. package/examples/sample_config.json +32 -32
  11. package/package.json +48 -48
  12. package/scriptDoc.txt +8679 -8679
package/examples/README.md CHANGED
@@ -1,78 +1,78 @@
1
- # CODESYS MCP Toolkit Examples
2
-
3
- This directory contains examples of how to use the CODESYS MCP toolkit effectively.
4
-
5
- ## Example Configuration Files
6
-
7
- ### Basic MCP Configuration
8
-
9
- `claude_desktop_config.json` - Example configuration for Claude Desktop:
10
-
11
- ```json
12
- {
13
- "mcpServers": {
14
- "codesys_local": {
15
- "command": "npx",
16
- "args": [
17
- "-y",
18
- "@codesys/mcp-toolkit",
19
- "--codesys-path", "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe",
20
- "--codesys-profile", "CODESYS V3.5 SP21"
21
- ]
22
- }
23
- }
24
- }
25
- ```
26
-
27
- ## Example Prompts
28
-
29
- Here are some example prompts you can use with Claude Desktop:
30
-
31
- ### Create a Motor Controller Function Block
32
-
33
- ```
34
- Using the CODESYS Local server, please create a MotorController function block with the following:
35
-
36
- 1. Properties:
37
- - SpeedSetpoint (INT)
38
- - ActualSpeed (INT)
39
- - IsRunning (BOOL)
40
-
41
- 2. Methods:
42
- - Start() - Sets IsRunning to TRUE
43
- - Stop() - Sets IsRunning to FALSE
44
- - SetSpeed(speed: INT) - Sets SpeedSetpoint to the given value
45
-
46
- Create this in a new project at C:/MyProjects/MotorControl.project
47
- ```
48
-
49
- ### Open and Analyze an Existing Project
50
-
51
- ```
52
- Using the CODESYS Local server, please open the project at C:/MyProjects/ExistingProject.project and show me its structure. Then, show me the code for the main POU.
53
- ```
54
-
55
- ### Compile a Project
56
-
57
- ```
58
- Using the CODESYS Local server, please open the project at C:/MyProjects/MyProject.project and compile it. Let me know if there are any errors.
59
- ```
60
-
61
- ## Programmatic Usage Examples
62
-
63
- If you're integrating directly with the server code, here are some examples:
64
-
65
- ### CLI Usage
66
-
67
- Run the server directly:
68
-
69
- ```bash
70
- codesys-mcp-toolkit --codesys-path "C:\Program Files\CODESYS 3.5.21.0\CODESYS\Common\CODESYS.exe" --codesys-profile "CODESYS V3.5 SP21"
71
- ```
72
-
73
- ## Use Cases
74
-
75
- * Automated PLC project creation
76
- * Standardized Function Block library management
77
- * Continuous integration for CODESYS projects
78
- * Documentation generation from CODESYS projects
1
+ # CODESYS MCP Toolkit Examples
2
+
3
+ This directory contains examples of how to use the CODESYS MCP toolkit effectively.
4
+
5
+ ## Example Configuration Files
6
+
7
+ ### Basic MCP Configuration
8
+
9
+ `claude_desktop_config.json` - Example configuration for Claude Desktop:
10
+
11
+ ```json
12
+ {
13
+ "mcpServers": {
14
+ "codesys_local": {
15
+ "command": "npx",
16
+ "args": [
17
+ "-y",
18
+ "@codesys/mcp-toolkit",
19
+ "--codesys-path", "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe",
20
+ "--codesys-profile", "CODESYS V3.5 SP21"
21
+ ]
22
+ }
23
+ }
24
+ }
25
+ ```
26
+
27
+ ## Example Prompts
28
+
29
+ Here are some example prompts you can use with Claude Desktop:
30
+
31
+ ### Create a Motor Controller Function Block
32
+
33
+ ```
34
+ Using the CODESYS Local server, please create a MotorController function block with the following:
35
+
36
+ 1. Properties:
37
+ - SpeedSetpoint (INT)
38
+ - ActualSpeed (INT)
39
+ - IsRunning (BOOL)
40
+
41
+ 2. Methods:
42
+ - Start() - Sets IsRunning to TRUE
43
+ - Stop() - Sets IsRunning to FALSE
44
+ - SetSpeed(speed: INT) - Sets SpeedSetpoint to the given value
45
+
46
+ Create this in a new project at C:/MyProjects/MotorControl.project
47
+ ```
48
+
49
+ ### Open and Analyze an Existing Project
50
+
51
+ ```
52
+ Using the CODESYS Local server, please open the project at C:/MyProjects/ExistingProject.project and show me its structure. Then, show me the code for the main POU.
53
+ ```
54
+
55
+ ### Compile a Project
56
+
57
+ ```
58
+ Using the CODESYS Local server, please open the project at C:/MyProjects/MyProject.project and compile it. Let me know if there are any errors.
59
+ ```
60
+
61
+ ## Programmatic Usage Examples
62
+
63
+ If you're integrating directly with the server code, here are some examples:
64
+
65
+ ### CLI Usage
66
+
67
+ Run the server directly:
68
+
69
+ ```bash
70
+ codesys-mcp-toolkit --codesys-path "C:\Program Files\CODESYS 3.5.21.0\CODESYS\Common\CODESYS.exe" --codesys-profile "CODESYS V3.5 SP21"
71
+ ```
72
+
73
+ ## Use Cases
74
+
75
+ * Automated PLC project creation
76
+ * Standardized Function Block library management
77
+ * Continuous integration for CODESYS projects
78
+ * Documentation generation from CODESYS projects
package/examples/sample_config.json CHANGED
@@ -1,32 +1,32 @@
1
- {
2
- "mcpServers": {
3
- "codesys_local": {
4
- "command": "npx",
5
- "args": [
6
- "-y",
7
- "@codesys/mcp-toolkit",
8
- "--codesys-path", "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe",
9
- "--codesys-profile", "CODESYS V3.5 SP21"
10
- ]
11
- },
12
- "filesystem": {
13
- "command": "npx",
14
- "args": [
15
- "-y",
16
- "@modelcontextprotocol/server-filesystem",
17
- "C:/MyProjects"
18
- ]
19
- },
20
- "memory": {
21
- "command": "npx",
22
- "args": [
23
- "-y",
24
- "@modelcontextprotocol/server-memory"
25
- ]
26
- },
27
- "puppeteer": {
28
- "command": "npx",
29
- "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
30
- }
31
- }
32
- }
1
+ {
2
+ "mcpServers": {
3
+ "codesys_local": {
4
+ "command": "npx",
5
+ "args": [
6
+ "-y",
7
+ "@codesys/mcp-toolkit",
8
+ "--codesys-path", "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe",
9
+ "--codesys-profile", "CODESYS V3.5 SP21"
10
+ ]
11
+ },
12
+ "filesystem": {
13
+ "command": "npx",
14
+ "args": [
15
+ "-y",
16
+ "@modelcontextprotocol/server-filesystem",
17
+ "C:/MyProjects"
18
+ ]
19
+ },
20
+ "memory": {
21
+ "command": "npx",
22
+ "args": [
23
+ "-y",
24
+ "@modelcontextprotocol/server-memory"
25
+ ]
26
+ },
27
+ "puppeteer": {
28
+ "command": "npx",
29
+ "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
30
+ }
31
+ }
32
+ }
package/package.json CHANGED
@@ -1,48 +1,48 @@
1
- {
2
- "name": "@codesys/mcp-toolkit",
3
- "version": "1.1.4",
4
- "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
5
- "main": "dist/server.js",
6
- "bin": {
7
- "codesys-mcp-tool": "./dist/bin.js"
8
- },
9
- "scripts": {
10
- "test": "echo \"Error: no test specified\" && exit 1",
11
- "build": "tsc",
12
- "start": "node ./dist/server.js"
13
- },
14
- "keywords": [
15
- "codesys",
16
- "mcp",
17
- "modelcontextprotocol",
18
- "plc",
19
- "automation",
20
- "programming"
21
- ],
22
- "author": "Your Name <your.email@example.com>",
23
- "license": "MIT",
24
- "type": "commonjs",
25
- "repository": {
26
- "type": "git",
27
- "url": "git+https://github.com/johannesPettersson80/codesys-mcp-toolkit.git"
28
- },
29
- "homepage": "https://github.com/johannesPettersson80/codesys-mcp-toolkit#readme",
30
- "bugs": {
31
- "url": "https://github.com/johannesPettersson80/codesys-mcp-toolkit/issues"
32
- },
33
- "engines": {
34
- "node": ">=18.0.0"
35
- },
36
- "dependencies": {
37
- "@modelcontextprotocol/sdk": "^1.10.2",
38
- "axios": "^1.6.8",
39
- "commander": "^11.1.0",
40
- "yargs": "^17.7.2",
41
- "zod": "^3.24.3"
42
- },
43
- "devDependencies": {
44
- "@types/node": "^20.14.1",
45
- "@types/yargs": "^17.0.33",
46
- "typescript": "^5.5.3"
47
- }
48
- }
1
+ {
2
+ "name": "@codesys/mcp-toolkit",
3
+ "version": "1.1.6",
4
+ "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
5
+ "main": "dist/server.js",
6
+ "bin": {
7
+ "codesys-mcp-tool": "./dist/bin.js"
8
+ },
9
+ "scripts": {
10
+ "test": "echo \"Error: no test specified\" && exit 1",
11
+ "build": "tsc",
12
+ "start": "node ./dist/server.js"
13
+ },
14
+ "keywords": [
15
+ "codesys",
16
+ "mcp",
17
+ "modelcontextprotocol",
18
+ "plc",
19
+ "automation",
20
+ "programming"
21
+ ],
22
+ "author": "Your Name <your.email@example.com>",
23
+ "license": "MIT",
24
+ "type": "commonjs",
25
+ "repository": {
26
+ "type": "git",
27
+ "url": "git+https://github.com/johannesPettersson80/codesys-mcp-toolkit.git"
28
+ },
29
+ "homepage": "https://github.com/johannesPettersson80/codesys-mcp-toolkit#readme",
30
+ "bugs": {
31
+ "url": "https://github.com/johannesPettersson80/codesys-mcp-toolkit/issues"
32
+ },
33
+ "engines": {
34
+ "node": ">=18.0.0"
35
+ },
36
+ "dependencies": {
37
+ "@modelcontextprotocol/sdk": "^1.10.2",
38
+ "axios": "^1.6.8",
39
+ "commander": "^11.1.0",
40
+ "yargs": "^17.7.2",
41
+ "zod": "^3.24.3"
42
+ },
43
+ "devDependencies": {
44
+ "@types/node": "^20.14.1",
45
+ "@types/yargs": "^17.0.33",
46
+ "typescript": "^5.8.3"
47
+ }
48
+ }