docs: add comprehensive fork attribution and fix container publishing

macayaven · macayaven · commit 51f1f64c07a8 · 2025-10-31T22:29:58.000+01:00
- Add proper fork attribution in README with original project credit
- Update container workflow to use fork maintainer's registry (quay.io/macayaven)
- Add FORKING.md with guidelines and etiquette for forked projects
- Fix gofmt hints in OpenShift AI toolsets
- Maintain learning phase transparency and proper open source etiquette

This ensures proper attribution to Marc Nuri's original kubernetes-mcp-server
while clearly documenting this fork's OpenShift AI enhancements.
diff --git a/.github/workflows/release-image.yml b/.github/workflows/release-image.yml
@@ -6,9 +6,13 @@ on:
       - main
     tags:
       - '*'
+  workflow_dispatch:  # Allow manual triggering
 
 env:
-  IMAGE_NAME: quay.io/manusa/kubernetes_mcp_server
+  # Fork attribution: This is a fork of containers/kubernetes-mcp-server enhanced with OpenShift AI support
+  # Original project: https://github.com/containers/kubernetes-mcp-server by Marc Nuri
+  # This fork adds OpenShift AI capabilities while maintaining full compatibility with the original
+  IMAGE_NAME: quay.io/macayaven/kubernetes_mcp_server_openshift_ai
   TAG: ${{ github.ref_name == 'main' && 'latest' || github.ref_type == 'tag' && github.ref_name && startsWith(github.ref_name, 'v') && github.ref_name || 'unknown' }}
 
 jobs:
@@ -32,6 +36,7 @@ jobs:
           sudo apt-get install -y podman
       - name: Quay Login
         run: |
+          # Using fork maintainer's registry credentials
           echo ${{ secrets.QUAY_PASSWORD }} | podman login quay.io -u ${{ secrets.QUAY_USERNAME }} --password-stdin
       - name: Build Image
         run: |
@@ -52,6 +57,7 @@ jobs:
     steps:
       - name: Quay Login
         run: |
+          # Using fork maintainer's registry credentials
           echo ${{ secrets.QUAY_PASSWORD }} | podman login quay.io -u ${{ secrets.QUAY_USERNAME }} --password-stdin
       - name: Create Manifest
         run: |
diff --git a/FORKING.md b/FORKING.md
@@ -0,0 +1,148 @@
+# Forking & Extension Guidelines
+
+This document outlines the proper etiquette and guidelines followed when creating this fork of kubernetes-mcp-server.
+
+## 🍴 Fork Information
+
+### Original Project
+- **Name**: kubernetes-mcp-server
+- **Author**: Marc Nuri
+- **Repository**: https://github.com/containers/kubernetes-mcp-server
+- **License**: Apache License 2.0
+
+### This Fork
+- **Name**: openshift-mcp-server (with OpenShift AI enhancements)
+- **Author**: Carlos Macaya
+- **Repository**: https://github.com/macayaven/openshift-mcp-server
+- **License**: Apache License 2.0 (preserved)
+
+## 🎯 Purpose of This Fork
+
+This fork was created to add **OpenShift AI** capabilities to the excellent kubernetes-mcp-server foundation while maintaining full compatibility with the original project.
+
+### Key Principles Followed
+
+1. **🔧 Compatibility**: All original functionality preserved
+2. **📝 Attribution**: Original work clearly credited
+3. **🏷️ Naming**: Distinct package names to avoid confusion
+4. **📚 Documentation**: Comprehensive documentation of changes
+5. **🤝 Openness**: Transparent development process
+6. **🎓 Learning**: Clear indication of learning/development status
+
+## 📋 Forking Etiquette Checklist
+
+### ✅ What We Did Right
+
+1. **Proper Attribution**
+   - Original author and project clearly credited
+   - Link to original repository provided
+   - Original license preserved
+
+2. **Clear Naming**
+   - Different package names: `kubernetes-mcp-server-openshift-ai`
+   - Different container registry: `quay.io/macayaven/kubernetes_mcp_server_openshift_ai`
+   - Clear indication in documentation
+
+3. **Documentation**
+   - Comprehensive README with fork notice
+   - Clear explanation of enhancements
+   - Installation differences documented
+
+4. **License Compliance**
+   - Original Apache License 2.0 maintained
+   - No license violations
+
+5. **Transparent Development**
+   - All commits publicly visible
+   - Clear commit messages
+   - Proper branching strategy
+
+6. **Learning Phase Indication**
+   - Clear notice about learning/development status
+   - Encouragement for issue reporting
+   - Patience requested from users
+
+### 🎯 Development Guidelines
+
+#### Code Changes
+- **Preserve Original**: Don't modify core functionality unnecessarily
+- **Additive Approach**: Add new features without breaking existing ones
+- **Code Style**: Follow original project's coding conventions
+- **Testing**: Maintain or improve test coverage
+
+#### Distribution
+- **Separate Packages**: Use different package names
+- **Different Registries**: Use your own container registry
+- **Clear Documentation**: Explain differences and installation
+
+#### Communication
+- **Credit Original**: Always mention original project
+- **Be Transparent**: Be clear about fork status and purpose
+- **Contribute Back**: Consider contributing useful changes upstream
+
+## 🚀 For Others Wanting to Fork
+
+If you want to fork this (or the original) project, here's a recommended approach:
+
+### 1. Initial Setup
+```bash
+# Fork the repository on GitHub
+git clone https://github.com/YOUR_USERNAME/kubernetes-mcp-server.git
+cd kubernetes-mcp-server
+git remote add upstream https://github.com/containers/kubernetes-mcp-server.git
+```
+
+### 2. Make Changes
+```bash
+# Create a feature branch
+git checkout -b feature/your-enhancement
+
+# Make your changes
+# ... (code changes) ...
+
+# Commit with clear messages
+git commit -m "feat: add your enhancement description"
+```
+
+### 3. Update Package Names
+```bash
+# Update package.json files with your own scope/name
+find npm -name "package.json" -exec sed -i 's/kubernetes-mcp-server/your-mcp-server/g' {} \;
+```
+
+### 4. Update Container Registry
+```yaml
+# In .github/workflows/release-image.yml
+env:
+  IMAGE_NAME: quay.io/YOUR_USERNAME/your_mcp_server
+```
+
+### 5. Update Documentation
+- Add fork notice to README.md
+- Create attribution section
+- Document your enhancements
+- Update installation instructions
+
+### 6. Publishing
+- Use your own npm registry or scope
+- Use your own container registry
+- Don't conflict with original package names
+
+## 🤝 Contributing Back
+
+If you add useful features, consider contributing them back to the original project:
+
+1. **Check Original**: Does the original project need this feature?
+2. **Create PR**: Submit a pull request to upstream
+3. **Coordinate**: Work with original maintainer
+4. **Credit**: Mention your fork in the PR
+
+## 📚 Resources
+
+- [GitHub Forking Guide](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
+- [Open Source Etiquette](https://opensource.guide/starting-a-project/)
+- [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+---
+
+**Remember**: Forking is a normal part of open source. The key is to do it respectfully, with proper attribution, and clear communication about your intentions and changes.
diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
 # OpenShift MCP Server
 
+> **🍴 Fork Notice**: This is a fork of [containers/kubernetes-mcp-server](https://github.com/containers/kubernetes-mcp-server) by Marc Nuri, enhanced with **OpenShift AI** support.
+> 
+> **Original Project**: A powerful Kubernetes [Model Context Protocol (MCP)](https://blog.marcnuri.com/model-context-protocol-mcp-introduction) server implementation.
+> 
+> **This Fork**: Adds comprehensive OpenShift AI capabilities while maintaining full compatibility with the original kubernetes-mcp-server functionality.
+> 
+> **🎯 Learning Phase**: This fork is actively developed as part of a learning journey. While thoroughly tested, please report any issues encountered.
+
 OpenShift MCP Server is currently under development.
 
 ## ✨ Features <a id="features"></a>
@@ -22,6 +30,12 @@ A powerful and flexible Kubernetes [Model Context Protocol (MCP)](https://blog.m
 - **✅ Namespaces**: List Kubernetes Namespaces.
 - **✅ Events**: View Kubernetes events in all namespaces or in a specific namespace.
 - **✅ Projects**: List OpenShift Projects.
+- **🤖 OpenShift AI** (Fork Enhancement):
+    - **Data Science Projects**: List, get, create, and delete Data Science Projects
+    - **Models**: Manage ML models with list, get, create, and delete operations
+    - **Applications**: Handle Data Science applications lifecycle
+    - **Experiments**: Track and manage ML experiments
+    - **Pipelines**: Manage Data Science pipelines and workflows
 - **☸️ Helm**:
     - **Install** a Helm chart in the current or provided namespace.
     - **List** Helm releases in all namespaces or in a specific namespace.
@@ -398,3 +412,59 @@ make build
 # Run the Kubernetes MCP server with mcp-inspector
 npx @modelcontextprotocol/inspector@latest $(pwd)/kubernetes-mcp-server
 ```
+
+## 🍴 Fork Attribution & Etiquette <a id="fork-attribution"></a>
+
+### Original Project
+This project is a fork of [containers/kubernetes-mcp-server](https://github.com/containers/kubernetes-mcp-server) by **Marc Nuri**.
+
+- **Original Author**: Marc Nuri
+- **Original Repository**: https://github.com/containers/kubernetes-mcp-server
+- **License**: Apache License 2.0 (preserved from original)
+
+### This Fork's Purpose
+This fork enhances the original kubernetes-mcp-server with **OpenShift AI** support while maintaining full backward compatibility.
+
+**Enhancements Added**:
+- 🤖 **OpenShift AI Toolset**: Complete integration with OpenShift AI/Red Hat OpenShift Data Science
+- 📊 **Data Science Projects**: Manage Data Science Projects lifecycle
+- 🤖 **Models**: ML model management and operations
+- 🚀 **Applications**: Data Science application handling
+- 🧪 **Experiments**: ML experiment tracking
+- ⚡ **Pipelines**: Data Science pipeline management
+
+### Development Philosophy
+- **🎯 Learning Phase**: This fork is developed as part of a learning journey
+- **🔧 Compatibility**: Maintains 100% compatibility with original kubernetes-mcp-server
+- **📝 Attribution**: All original work is properly attributed
+- **🤝 Collaboration**: Open to contributions and feedback
+- **🐛 Issue Reporting**: Please report issues encountered during usage
+
+### Fork Etiquette Followed
+1. **✅ Proper Attribution**: Original project and author clearly credited
+2. **✅ License Preservation**: Original Apache License 2.0 maintained
+3. **✅ Clear Documentation**: All changes and enhancements documented
+4. **✅ Separate Distribution**: Uses different package names to avoid confusion
+5. **✅ Open Development**: All changes visible and properly committed
+6. **✅ Learning Focus**: Clear indication of learning/development status
+
+### Installation Differences
+- **Original**: `kubernetes-mcp-server` (npm), `quay.io/manusa/kubernetes_mcp_server` (container)
+- **This Fork**: `kubernetes-mcp-server-openshift-ai` (npm), `quay.io/macayaven/kubernetes_mcp_server_openshift_ai` (container)
+
+### Contributing to This Fork
+While this is a learning project, contributions are welcome! Please:
+1. Clearly indicate the purpose of your contribution
+2. Follow the existing code style and patterns
+3. Add appropriate tests for new functionality
+4. Update documentation as needed
+
+### Reporting Issues
+If you encounter issues with this fork:
+1. **Original Functionality**: Check if issue exists in upstream project first
+2. **OpenShift AI Features**: Report issues in this repository
+3. **Learning Phase**: Be patient - this is actively developed and improved
+
+---
+
+**Thank you to Marc Nuri and the Kubernetes community for the excellent foundation!** 🙏
diff --git a/pkg/toolsets/openshift-ai/pipelines.go b/pkg/toolsets/openshift-ai/pipelines.go
@@ -106,13 +106,13 @@ func (t *PipelinesToolset) handlePipelinesList(params api.ToolHandlerParams) (*a
 	response := make([]map[string]interface{}, len(pipelines))
 	for i, pipeline := range pipelines {
 		response[i] = map[string]interface{}{
-			"name":         pipeline.Name,
-			"namespace":    pipeline.Namespace,
+			"name":        pipeline.Name,
+			"namespace":   pipeline.Namespace,
 			"displayName": pipeline.DisplayName,
-			"description":  pipeline.Description,
-			"labels":       pipeline.Labels,
-			"annotations":  pipeline.Annotations,
-			"status":       pipeline.Status,
+			"description": pipeline.Description,
+			"labels":      pipeline.Labels,
+			"annotations": pipeline.Annotations,
+			"status":      pipeline.Status,
 		}
 	}
 
@@ -162,13 +162,13 @@ func (t *PipelinesToolset) handlePipelineGet(params api.ToolHandlerParams) (*api
 	}
 
 	result := map[string]interface{}{
-		"name":         pipeline.Name,
-		"namespace":    pipeline.Namespace,
+		"name":        pipeline.Name,
+		"namespace":   pipeline.Namespace,
 		"displayName": pipeline.DisplayName,
-		"description":  pipeline.Description,
-		"labels":       pipeline.Labels,
-		"annotations":  pipeline.Annotations,
-		"status":       pipeline.Status,
+		"description": pipeline.Description,
+		"labels":      pipeline.Labels,
+		"annotations": pipeline.Annotations,
+		"status":      pipeline.Status,
 	}
 
 	// Convert to JSON response
@@ -245,14 +245,14 @@ func (t *PipelinesToolset) handlePipelineCreate(params api.ToolHandlerParams) (*
 	}
 
 	result := map[string]interface{}{
-		"name":         createdPipeline.Name,
-		"namespace":    createdPipeline.Namespace,
+		"name":        createdPipeline.Name,
+		"namespace":   createdPipeline.Namespace,
 		"displayName": createdPipeline.DisplayName,
-		"description":  createdPipeline.Description,
-		"labels":       createdPipeline.Labels,
-		"annotations":  createdPipeline.Annotations,
-		"status":       createdPipeline.Status,
-		"message":      "Pipeline created successfully",
+		"description": createdPipeline.Description,
+		"labels":      createdPipeline.Labels,
+		"annotations": createdPipeline.Annotations,
+		"status":      createdPipeline.Status,
+		"message":     "Pipeline created successfully",
 	}
 
 	// Convert to JSON response
@@ -351,14 +351,14 @@ func (t *PipelinesToolset) handlePipelineRunsList(params api.ToolHandlerParams)
 	response := make([]map[string]interface{}, len(pipelineRuns))
 	for i, pipelineRun := range pipelineRuns {
 		response[i] = map[string]interface{}{
-			"name":          pipelineRun.Name,
+			"name":         pipelineRun.Name,
 			"pipelineName": pipelineRun.PipelineName,
-			"namespace":     pipelineRun.Namespace,
+			"namespace":    pipelineRun.Namespace,
 			"displayName":  pipelineRun.DisplayName,
-			"description":   pipelineRun.Description,
-			"labels":        pipelineRun.Labels,
-			"annotations":   pipelineRun.Annotations,
-			"status":        pipelineRun.Status,
+			"description":  pipelineRun.Description,
+			"labels":       pipelineRun.Labels,
+			"annotations":  pipelineRun.Annotations,
+			"status":       pipelineRun.Status,
 		}
 	}
 
@@ -408,14 +408,14 @@ func (t *PipelinesToolset) handlePipelineRunGet(params api.ToolHandlerParams) (*
 	}
 
 	result := map[string]interface{}{
-		"name":          pipelineRun.Name,
+		"name":         pipelineRun.Name,
 		"pipelineName": pipelineRun.PipelineName,
-		"namespace":     pipelineRun.Namespace,
+		"namespace":    pipelineRun.Namespace,
 		"displayName":  pipelineRun.DisplayName,
-		"description":   pipelineRun.Description,
-		"labels":        pipelineRun.Labels,
-		"annotations":   pipelineRun.Annotations,
-		"status":        pipelineRun.Status,
+		"description":  pipelineRun.Description,
+		"labels":       pipelineRun.Labels,
+		"annotations":  pipelineRun.Annotations,
+		"status":       pipelineRun.Status,
 	}
 
 	// Convert to JSON response
