sfcc-dev-mcp 1.0.8 → 1.0.10

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,129 @@
+name: 🐛 Bug Report
+description: Report a bug or unexpected behavior in the SFCC Development MCP Server
+title: "[Bug]: "
+labels: ["bug", "needs-triage"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the information below to help us investigate and fix the issue.
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Pre-flight Checklist
+      description: Please confirm you have completed these steps before submitting the bug report.
+      options:
+        - label: I have searched existing issues to ensure this bug hasn't been reported already
+          required: true
+        - label: I have read the documentation and troubleshooting guide
+          required: true
+        - label: I am using a supported Node.js version (18+)
+          required: true
+
+  - type: dropdown
+    id: operating-mode
+    attributes:
+      label: Operating Mode
+      description: Which mode were you using when the bug occurred?
+      options:
+        - Documentation-only mode
+        - Full mode (with SFCC credentials)
+        - Not sure
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is.
+      placeholder: Describe what happened and what you expected to happen instead.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to Reproduce
+      description: Detailed steps to reproduce the behavior.
+      placeholder: |
+        1. Start the MCP server with...
+        2. Call the tool...
+        3. Observe the error...
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual Behavior
+      description: What actually happened, including any error messages.
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment Information
+      description: Information about your environment
+      value: |
+        - OS: [e.g., macOS 14.1, Windows 11, Ubuntu 22.04]
+        - Node.js version: [run `node --version`]
+        - NPM/Yarn version: [run `npm --version` or `yarn --version`]
+        - SFCC Dev MCP version: [check package.json version]
+        - MCP Client: [e.g., Claude Desktop, Custom implementation]
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant Logs
+      description: Any relevant log output or error messages
+      render: shell
+      placeholder: Paste any relevant logs here (please remove any sensitive information like credentials)
+
+  - type: textarea
+    id: configuration
+    attributes:
+      label: Configuration (Sanitized)
+      description: Your configuration (with sensitive information removed)
+      render: json
+      placeholder: |
+        {
+          "hostname": "your-instance.demandware.net",
+          "clientId": "[REDACTED]",
+          "version": "v21_3"
+        }
+
+  - type: dropdown
+    id: affected-tools
+    attributes:
+      label: Affected Tools
+      description: Which MCP tools are affected by this bug?
+      multiple: true
+      options:
+        - SFCC Class Documentation Tools
+        - Best Practices Guide Tools
+        - Log Analysis Tools
+        - System Object Tools
+        - Authentication/OAuth
+        - Configuration Loading
+        - All Tools
+        - Not sure
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any other context, screenshots, or information that might be helpful.

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📖 Documentation
+    url: https://github.com/taurgis/sfcc-dev-mcp/blob/main/README.md
+    about: Read the project documentation and setup guide
+  - name: 🔒 Security Issues
+    url: https://github.com/taurgis/sfcc-dev-mcp/security/advisories/new
+    about: Report security vulnerabilities privately
+

package/.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,117 @@
+name: 📚 Documentation Issue
+description: Report issues with documentation or suggest documentation improvements
+title: "[Docs]: "
+labels: ["documentation", "needs-triage"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for helping improve our documentation! Please provide details about the documentation issue or improvement.
+
+  - type: dropdown
+    id: doc-type
+    attributes:
+      label: Documentation Type
+      description: What type of documentation is this about?
+      options:
+        - README.md
+        - API Documentation (docs/ folder)
+        - Best Practices Guides
+        - Code Comments/JSDoc
+        - Setup/Installation Instructions
+        - Configuration Guide
+        - Troubleshooting Guide
+        - Contributing Guidelines
+        - GitHub Templates
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: issue-type
+    attributes:
+      label: Issue Type
+      description: What kind of documentation issue is this?
+      options:
+        - Missing documentation
+        - Incorrect/outdated information
+        - Unclear or confusing content
+        - Broken links or references
+        - Formatting issues
+        - Grammar/spelling errors
+        - Missing examples
+        - Inconsistent information
+        - Accessibility issues
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: location
+    attributes:
+      label: Location
+      description: Where is the documentation issue located?
+      placeholder: |
+        - File path: docs/best-practices/cartridge_creation.md
+        - Section: "Setting up Authentication"
+        - Line number: 45
+        - URL: (if applicable)
+    validations:
+      required: true
+
+  - type: textarea
+    id: current-content
+    attributes:
+      label: Current Content (if applicable)
+      description: Quote or describe the current problematic content
+      render: markdown
+
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: Issue Description
+      description: Clearly describe what's wrong or what's missing
+      placeholder: Explain what makes the current documentation problematic or what information is missing...
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggested-improvement
+    attributes:
+      label: Suggested Improvement
+      description: How should this be fixed or what should be added?
+      placeholder: Provide your suggestion for improving the documentation...
+    validations:
+      required: true
+
+  - type: textarea
+    id: user-impact
+    attributes:
+      label: User Impact
+      description: How does this documentation issue affect users?
+      placeholder: |
+        - Makes it difficult to get started
+        - Causes confusion during setup
+        - Leads to incorrect implementation
+        - Wastes developer time...
+
+  - type: dropdown
+    id: audience
+    attributes:
+      label: Target Audience
+      description: Who is primarily affected by this documentation issue?
+      multiple: true
+      options:
+        - New users/first-time setup
+        - SFCC developers
+        - MCP server developers
+        - Contributors
+        - All users
+        - Advanced users only
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any additional context, examples, or references that would help improve the documentation

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,151 @@
+name: ✨ Feature Request
+description: Suggest a new feature or enhancement for the SFCC Development MCP Server
+title: "[Feature]: "
+labels: ["enhancement", "needs-triage"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature! Please provide detailed information to help us understand and evaluate your request.
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Pre-submission Checklist
+      description: Please confirm you have completed these steps before submitting the feature request.
+      options:
+        - label: I have searched existing issues and discussions to ensure this feature hasn't been requested already
+          required: true
+        - label: I have reviewed the roadmap and documentation to confirm this feature doesn't already exist
+          required: true
+        - label: This feature aligns with the project's goals of improving SFCC development workflows
+          required: true
+
+  - type: dropdown
+    id: feature-category
+    attributes:
+      label: Feature Category
+      description: Which category does this feature request fall into?
+      options:
+        - New MCP Tool
+        - SFCC API Integration Enhancement
+        - Documentation/Best Practices
+        - Authentication/Security
+        - Performance/Caching
+        - Configuration/Setup
+        - Developer Experience
+        - Testing/Quality Assurance
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem-statement
+    attributes:
+      label: Problem Statement
+      description: What problem does this feature solve? What pain point are you experiencing?
+      placeholder: Describe the current limitation or challenge you're facing in SFCC development...
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: Proposed Solution
+      description: Describe your ideal solution to this problem.
+      placeholder: Explain how you envision this feature working...
+    validations:
+      required: true
+
+  - type: textarea
+    id: use-cases
+    attributes:
+      label: Use Cases
+      description: Provide specific examples of how this feature would be used.
+      placeholder: |
+        1. As a developer, I want to... so that...
+        2. When working on cartridge development, I need to...
+        3. During debugging sessions, it would help if...
+    validations:
+      required: true
+
+  - type: dropdown
+    id: target-mode
+    attributes:
+      label: Target Operating Mode
+      description: Which operating mode should this feature support?
+      multiple: true
+      options:
+        - Documentation-only mode
+        - Full mode (with SFCC credentials)
+        - Both modes
+        - New mode (please specify in additional context)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority Level
+      description: How would you rate the priority of this feature?
+      options:
+        - Critical - Blocking my work
+        - High - Would significantly improve my workflow
+        - Medium - Nice to have improvement
+        - Low - Minor enhancement
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Solutions
+      description: Have you considered any alternative approaches or workarounds?
+      placeholder: Describe any workarounds you're currently using or other solutions you've considered...
+
+  - type: textarea
+    id: implementation-ideas
+    attributes:
+      label: Implementation Ideas (Optional)
+      description: If you have ideas about how this could be implemented, please share them.
+      placeholder: |
+        - Could be implemented as a new tool in the clients/ directory
+        - Might require changes to the authentication flow
+        - Would need new SFCC API endpoints...
+
+  - type: dropdown
+    id: sfcc-apis
+    attributes:
+      label: SFCC APIs Involved
+      description: Which SFCC APIs would this feature likely interact with?
+      multiple: true
+      options:
+        - OCAPI (Open Commerce API)
+        - SCAPI (Shopper API)
+        - WebDAV
+        - SFCC Logs
+        - System Object Definitions
+        - Site Preferences
+        - Custom Objects
+        - Not sure
+        - Not applicable
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any other context, mockups, examples, or references that would help understand this feature request.
+
+  - type: checkboxes
+    id: contribution
+    attributes:
+      label: Contribution Intent
+      description: Are you interested in contributing to this feature?
+      options:
+        - label: I'm willing to help implement this feature
+          required: false
+        - label: I can help with testing and validation
+          required: false
+        - label: I can provide domain expertise or consultation
+          required: false

package/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,102 @@
+name: ❓ Question/Help
+description: Ask a question or get help with using the SFCC Development MCP Server
+title: "[Question]: "
+labels: ["question", "needs-triage"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Need help or have a question? We're here to help! Please provide as much detail as possible so we can assist you effectively.
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Pre-submission Checklist
+      description: Please confirm you have completed these steps before asking your question.
+      options:
+        - label: I have searched existing issues and discussions for similar questions
+          required: true
+        - label: I have read the README.md and relevant documentation
+          required: true
+        - label: I have checked the troubleshooting section (if applicable)
+          required: true
+
+  - type: dropdown
+    id: question-category
+    attributes:
+      label: Question Category
+      description: What category does your question fall into?
+      options:
+        - Installation and Setup
+        - Configuration and Authentication
+        - Using MCP Tools
+        - SFCC Integration
+        - Troubleshooting
+        - Best Practices
+        - Performance
+        - Security
+        - Development/Contributing
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Your Question
+      description: What would you like to know?
+      placeholder: Please ask your question clearly and provide context...
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Context and Background
+      description: Provide relevant context about what you're trying to accomplish
+      placeholder: |
+        - What are you trying to achieve?
+        - What's your current setup?
+        - What have you tried so far?
+
+  - type: textarea
+    id: current-setup
+    attributes:
+      label: Current Setup
+      description: Describe your current configuration and environment
+      value: |
+        - OS: [e.g., macOS 14.1, Windows 11, Ubuntu 22.04]
+        - Node.js version: [run `node --version`]
+        - SFCC Dev MCP version: [check package.json version]
+        - Operating mode: [Documentation-only or Full mode]
+        - MCP Client: [e.g., Claude Desktop, Custom implementation]
+
+  - type: textarea
+    id: attempted-solutions
+    attributes:
+      label: What Have You Tried?
+      description: What steps have you already taken to solve this?
+      placeholder: |
+        1. I tried...
+        2. I looked at...
+        3. I configured...
+
+  - type: textarea
+    id: expected-outcome
+    attributes:
+      label: Expected Outcome
+      description: What do you expect or hope to happen?
+
+  - type: textarea
+    id: relevant-logs
+    attributes:
+      label: Relevant Logs or Error Messages
+      description: Include any relevant logs or error messages (remove sensitive information)
+      render: shell
+
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: Any other information that might be helpful

package/.github/PULL_REQUEST_TEMPLATE/bug_fix.md

@@ -0,0 +1,59 @@
+## 🐛 Bug Fix
+
+### Bug Summary
+<!-- Brief description of the bug being fixed -->
+
+### Root Cause Analysis
+<!-- Explain what caused the bug -->
+
+### Solution Approach
+<!-- Describe how the fix addresses the root cause -->
+
+### Changes Made
+- [ ] Code changes in specific files
+- [ ] Configuration updates
+- [ ] Dependency updates
+- [ ] Test additions/modifications
+
+### Files Modified
+<!-- List the main files changed -->
+- 
+- 
+- 
+
+### Testing Strategy
+- [ ] Regression tests added to prevent reoccurrence
+- [ ] Existing tests updated if needed
+- [ ] Manual testing performed
+- [ ] Edge cases validated
+- [ ] Both operating modes tested (if applicable)
+
+### Backward Compatibility
+- [ ] No breaking changes
+- [ ] Breaking changes documented and justified
+- [ ] Migration guide provided (if breaking)
+
+### Risk Assessment
+- [ ] Low risk - isolated change
+- [ ] Medium risk - affects multiple components
+- [ ] High risk - core functionality changes
+
+### Verification Steps
+<!-- How to verify the fix works -->
+1. 
+2. 
+3. 
+
+### Performance Impact
+- [ ] No performance impact
+- [ ] Performance improvement
+- [ ] Minimal performance impact (acceptable)
+
+### Related Issues
+Fixes #
+
+### Additional Notes
+<!-- Any other relevant information -->
+
+---
+**This PR resolves a bug while maintaining system stability and backward compatibility.**

package/.github/PULL_REQUEST_TEMPLATE/documentation.md

@@ -0,0 +1,48 @@
+## 📚 Documentation Update
+
+### Documentation Type
+- [ ] README.md updates
+- [ ] copilot-instructions.md updates
+- [ ] API documentation (docs/ folder)
+- [ ] Best practices guides
+- [ ] Code comments/JSDoc
+- [ ] Configuration examples
+- [ ] Troubleshooting guide
+
+### Changes Made
+<!-- Describe what documentation was updated and why -->
+
+### Content Updates
+- [ ] New sections added
+- [ ] Existing content revised for accuracy
+- [ ] Broken links fixed
+- [ ] Examples updated/added
+- [ ] Structure/organization improved
+- [ ] Grammar/spelling corrections
+- [ ] Accessibility improvements
+
+### Consistency Checks
+- [ ] README.md and copilot-instructions.md kept in sync
+- [ ] Tool counts accurate in both files
+- [ ] File structure diagrams updated
+- [ ] Version numbers consistent
+- [ ] Links and references validated
+
+### Target Audience
+- [ ] New users/first-time setup
+- [ ] SFCC developers using the MCP server
+- [ ] Contributors and maintainers
+- [ ] Advanced users and integrators
+
+### Validation
+- [ ] Markdown syntax validated
+- [ ] Links tested and functional
+- [ ] Code examples tested
+- [ ] Configuration examples verified
+- [ ] Screenshots/diagrams current
+
+### Related Issues
+Closes #
+
+---
+**This PR improves project documentation to enhance user experience and maintainability.**

package/.github/PULL_REQUEST_TEMPLATE/new_tool.md

@@ -0,0 +1,55 @@
+## 🔧 New MCP Tool Implementation
+
+### Tool Overview
+**Tool Name:** `mcp_sfcc-dev_[tool_name]`
+**Category:** <!-- SFCC Documentation / Best Practices / Log Analysis / System Objects -->
+**Description:** 
+
+### Implementation Details
+- **Client Modified/Created:** 
+- **New Dependencies:** 
+- **SFCC APIs Used:** 
+
+### Tool Schema
+```typescript
+// Tool definition schema
+{
+  name: "mcp_sfcc-dev_[tool_name]",
+  description: "",
+  inputSchema: {
+    // Schema details
+  }
+}
+```
+
+### Testing Performed
+- [ ] Unit tests for tool handler
+- [ ] Integration tests with mock SFCC responses
+- [ ] Manual testing in documentation-only mode
+- [ ] Manual testing in full mode (if applicable)
+- [ ] Error handling validation
+- [ ] Parameter validation testing
+
+### Documentation Updates
+- [ ] Tool added to copilot-instructions.md tool categories
+- [ ] README.md feature list updated
+- [ ] Tool count updated in both documentation files
+- [ ] JSDoc comments added to implementation
+- [ ] Usage examples provided
+
+### Security Considerations
+- [ ] Input validation implemented
+- [ ] No sensitive data logged
+- [ ] Proper error handling without data leaks
+- [ ] Authentication requirements verified
+
+### Performance Notes
+- [ ] Caching strategy implemented (if applicable)
+- [ ] Resource usage reasonable for single-developer workload
+- [ ] No blocking operations without proper async handling
+
+### Related Issues
+Closes #
+
+---
+**This PR adds a new MCP tool following the project's architecture patterns and security guidelines.**