code-engine-mcp-server 1.0.0

package/docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as contributors and maintainers pledge to make participation in this project a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Demonstrating empathy and kindness toward other people.
+- Being respectful of differing opinions, viewpoints, and experiences.
+- Giving and gracefully accepting constructive feedback.
+- Accepting responsibility and apologizing to those affected by mistakes.
+- Focusing on what is best for the overall community.
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind.
+- Trolling, insulting or derogatory comments, and personal or political attacks.
+- Public or private harassment.
+- Publishing others' private information, such as a physical or email address, without explicit permission.
+- Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct.
+
+## Scope
+
+This Code of Conduct applies within all project spaces and also applies when an individual is officially representing the project in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project maintainers by opening a private communication channel agreed by the maintainers.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1:
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

package/docs/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+Thanks for your interest in contributing.
+
+## Getting Started
+
+- Fork and clone the repository.
+- Install dependencies with `npm install`.
+- Build with `npm run build`.
+- Run tests or validations relevant to your change.
+
+## Development Workflow
+
+- Create a branch from `main` for each change.
+- Keep pull requests focused and reviewable.
+- Write clear commit messages that explain why the change is needed.
+
+## Pull Request Guidelines
+
+- Provide a concise description of the change and motivation.
+- Link related issues when applicable.
+- Include manual testing steps or automated test coverage.
+- Ensure CI is passing before requesting review.
+
+## Code Style
+
+- Follow the existing style and patterns in the repository.
+- Keep changes small and avoid unrelated refactors.
+- Update documentation when behavior or usage changes.
+
+## Reporting Issues
+
+When opening an issue, include:
+
+- Expected behavior
+- Actual behavior
+- Steps to reproduce
+- Relevant logs or screenshots

package/docs/MAINTAINERS.md

@@ -0,0 +1,15 @@
+# Maintainers
+
+This file lists the current project maintainers.
+
+## Active Maintainers
+
+- Markus van Kempen
+
+## Responsibilities
+
+Maintainers are responsible for:
+
+- Reviewing and merging pull requests
+- Triaging issues and discussions
+- Maintaining release quality and project direction

package/docs/SETUP_INSTRUCTIONS.md

@@ -0,0 +1,218 @@
+# Quick Setup Instructions for Bob/Cline
+
+Follow these steps to enable Bob to understand Docker and Code Engine commands.
+
+## Step 1: Verify the Build
+
+The MCP server has been built successfully. Verify it exists:
+
+```bash
+ls -la /Users/markusvankempen/projects/code-engine/code-engine-mcp-server/build/index.js
+```
+
+You should see the compiled JavaScript file.
+
+## Step 2: Configure Cline in VSCode
+
+1. **Open VSCode Settings**
+   - Press `Cmd + ,` (Mac) or `Ctrl + ,` (Windows/Linux)
+   - Or go to: Code → Settings → Settings
+
+2. **Search for MCP Settings**
+   - Type "Cline MCP" in the search bar
+   - Look for "Cline: MCP Settings"
+
+3. **Edit settings.json**
+   - Click "Edit in settings.json" link
+   - This will open your VSCode settings file
+
+4. **Add the MCP Server Configuration**
+   
+   Copy and paste this configuration into your settings.json:
+
+   ```json
+   {
+     "cline.mcpServers": {
+       "code-engine": {
+         "command": "node",
+         "args": [
+           "/Users/markusvankempen/projects/code-engine/code-engine-mcp-server/build/index.js"
+         ],
+         "env": {
+           "IBMCLOUD_API_KEY": "YOUR_IBM_CLOUD_API_KEY_HERE"
+         }
+       }
+     }
+   }
+   ```
+
+5. **Replace YOUR_IBM_CLOUD_API_KEY_HERE**
+   - Get your IBM Cloud API key from: https://cloud.ibm.com/iam/apikeys
+   - Replace the placeholder with your actual API key
+   - Keep the quotes around the key
+
+6. **Save the file**
+   - Press `Cmd + S` (Mac) or `Ctrl + S` (Windows/Linux)
+
+## Step 3: Restart Cline/Bob
+
+1. **Reload VSCode Window**
+   - Press `Cmd + Shift + P` (Mac) or `Ctrl + Shift + P` (Windows/Linux)
+   - Type "Reload Window"
+   - Press Enter
+
+2. **Or Restart Cline**
+   - Open Cline sidebar
+   - Look for restart/reload option
+
+## Step 4: Verify the Connection
+
+1. **Check MCP Status**
+   - Look at the Cline status bar
+   - You should see "MCP" indicator
+   - It should show "code-engine" as connected
+
+2. **Test with a Simple Command**
+   
+   Ask Bob:
+   ```
+   Can you detect which container runtime I have installed?
+   ```
+
+   Bob should respond with Docker or Podman version information.
+
+## Step 5: Test Docker/Podman Integration
+
+Ask Bob:
+```
+Can you list all my local Docker images?
+```
+
+Bob should execute the `list_local_images` tool and show your images.
+
+## Step 6: Test Code Engine Integration
+
+Ask Bob:
+```
+Can you list all my Code Engine projects?
+```
+
+Bob should execute the `ce_list_projects` tool and show your projects.
+
+## Troubleshooting
+
+### MCP Server Not Showing as Connected
+
+1. **Check the path is correct**
+   ```bash
+   ls -la /Users/markusvankempen/projects/code-engine/code-engine-mcp-server/build/index.js
+   ```
+
+2. **Check Node.js is available**
+   ```bash
+   node --version
+   ```
+   Should show v18 or higher
+
+3. **Test the server manually**
+   ```bash
+   node /Users/markusvankempen/projects/code-engine/code-engine-mcp-server/build/index.js
+   ```
+   Should show: "Code Engine MCP Server running on stdio"
+   Press Ctrl+C to exit
+
+4. **Check VSCode Output**
+   - View → Output
+   - Select "Cline" from dropdown
+   - Look for MCP connection errors
+
+### Docker Commands Not Working
+
+1. **Verify Docker is installed**
+   ```bash
+   docker --version
+   ```
+
+2. **Check Docker daemon is running**
+   ```bash
+   docker ps
+   ```
+
+3. **Check permissions**
+   - You may need to add your user to the docker group
+   - Or use Podman instead
+
+### Code Engine Commands Not Working
+
+1. **Verify IBM Cloud CLI**
+   ```bash
+   ibmcloud --version
+   ```
+
+2. **Check Code Engine plugin**
+   ```bash
+   ibmcloud plugin list
+   ```
+   Should show "code-engine" plugin
+
+3. **Verify API key**
+   - Make sure you replaced the placeholder in settings.json
+   - Test manually:
+   ```bash
+   export IBMCLOUD_API_KEY="your-key-here"
+   ibmcloud ce project list
+   ```
+
+## What You Can Do Now
+
+Once configured, you can ask Bob to:
+
+### Docker/Podman Operations
+- "Detect my container runtime"
+- "Build a container from ./Dockerfile as myapp:latest"
+- "List all my local images"
+- "Test myapp:latest locally on port 8080"
+- "Get logs from container abc123"
+- "Stop and remove container abc123"
+- "List all running containers"
+
+### Code Engine Operations
+- "List all my Code Engine projects"
+- "List applications in project 'my-project'"
+- "Get details of application 'my-app' in project 'my-project'"
+- "Create an application named 'test-app' with image 'nginx:latest' in project 'my-project'"
+
+### Complete Workflows
+```
+I have a Node.js app in ./my-app with a Dockerfile. Can you:
+1. Build it as myapp:v1.0.0
+2. Test it locally on port 3000
+3. Push it to icr.io/my-namespace/myapp:v1.0.0
+4. Deploy it to my Code Engine project "production"
+```
+
+Bob will execute all these steps automatically!
+
+## Next Steps
+
+1. ✅ MCP server is built and ready
+2. ✅ Configuration example is provided
+3. ⏳ Add configuration to VSCode settings
+4. ⏳ Restart VSCode/Cline
+5. ⏳ Test with simple commands
+6. ⏳ Start using Bob for Docker and Code Engine tasks!
+
+## Need Help?
+
+- Check the README.md for detailed documentation
+- Review MCP_SERVER_SETUP_GUIDE.md for comprehensive setup
+- Look at CLINE_CONFIG_EXAMPLE.json for configuration reference
+- Open an issue if you encounter problems
+
+## Security Note
+
+⚠️ **Important**: Never commit your IBM Cloud API key to version control!
+
+- Keep your API key in VSCode settings (not tracked by git)
+- Or use environment variables
+- Consider using IBM Cloud IAM for better security

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "code-engine-mcp-server",
+  "version": "1.0.0",
+  "description": "MCP server for IBM Code Engine and Docker/Podman integration",
+  "type": "module",
+  "main": "build/index.js",
+  "bin": {
+    "code-engine-mcp-server": "build/index.js"
+  },
+  "scripts": {
+    "build": "tsc && chmod +x build/index.js && chmod +x build/simple-client.js && chmod +x build/deploy-tool.js",
+    "dev": "tsx src/index.ts",
+    "client": "tsx simple-client.ts",
+    "deploy": "tsx src/deploy-cli.ts",
+    "start": "node build/simple-client.js",
+    "prepare": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "mcp",
+    "code-engine",
+    "ibm-cloud",
+    "docker",
+    "podman"
+  ],
+  "author": "",
+  "license": "ISC",
+  "files": [
+    "build/",
+    "docs/",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "axios": "^1.7.0",
+    "dotenv": "^17.4.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.0"
+  }
+}