Enhance configuration, documentation, and CI/CD workflow

- Updated .env.example to reflect new environment and Redis configurations.
- Added CONTRIBUTING.md to provide guidelines for community contributions.
- Modified .gitignore to exclude log files and MCP-specific artifacts.
- Updated package.json to require Node.js 18+ and added prepublishOnly script for CI checks.
- Improved README.md with clearer setup instructions and additional commands.
- Refined GitHub Actions workflow for CI/CD, including security audits and coverage reporting.
- Refactored prompts in src/mcp/prompts.ts to include a new memory query prompt for enhanced functionality.

.env.example

@@ -1,5 +1,4 @@
-# Server Configuration
-PORT=3000
+# Environment Configuration
 NODE_ENV=development
 
 # FalkorDB Configuration
@@ -8,5 +7,10 @@ FALKORDB_PORT=6379
 FALKORDB_USERNAME=
 FALKORDB_PASSWORD=
 
-# MCP Configuration
-MCP_API_KEY=your_mcp_api_key_here
+# Redis Configuration (for key-value operations)
+REDIS_URL=redis://localhost:6379
+REDIS_USERNAME=
+REDIS_PASSWORD=
+
+# Logging Configuration (optional)
+ENABLE_FILE_LOGGING=false

.github/workflows/node.yml

@@ -1,74 +1,103 @@
-name: Node.js CI/CD
+name: CI/CD
 
 on:
   push:
-    branches: [ main, master, develop ]
+    branches: [ main, develop ]
   pull_request:
-    branches: [ main, master ]
+    branches: [ main ]
+  release:
+    types: [ published ]
 
 jobs:
-  build:
+  test:
+    name: Test & Build
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout code
+      uses: actions/checkout@v4
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
 
     - name: Install dependencies
       run: npm ci
 
-    - name: Build
-      run: npm run build --if-present
+    - name: Lint code
+      run: npm run lint
 
-    - name: Lint
-      run: npm run lint --if-present
+    - name: Run tests with coverage
+      run: npm run test:coverage
 
-    - name: Test
-      run: npm test --if-present
-      env:
-        CI: true
-
-  docker:
-    needs: build
-    if: github.event_name != 'pull_request'
+    - name: Build project
+      run: npm run build
+
+    - name: Upload coverage to Codecov
+      if: matrix.node-version == '20.x'
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage/lcov.info
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  security:
+    name: Security Audit
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v2
+    - name: Checkout code
+      uses: actions/checkout@v4
 
-    - name: Login to GitHub Container Registry
-      uses: docker/login-action@v2
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
       with:
-        registry: ghcr.io
-        username: ${{ github.repository_owner }}
-        password: ${{ secrets.GITHUB_TOKEN }}
+        node-version: '20.x'
+        cache: 'npm'
 
-    - name: Extract metadata for Docker
-      id: meta
-      uses: docker/metadata-action@v4
-      with:
-        images: ghcr.io/${{ github.repository }}
-        tags: |
-          type=sha,format=long
-          type=ref,event=branch
-          type=ref,event=tag
-
-    - name: Build and push Docker image
-      uses: docker/build-push-action@v4
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Run security audit
+      run: npm audit --audit-level=moderate
+
+    - name: Run Snyk security scan
+      uses: snyk/actions/node@master
+      continue-on-error: true
+      env:
+        SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
+
+  publish:
+    name: Publish to NPM
+    needs: [test, security]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
       with:
-        context: .
-        push: true
-        tags: ${{ steps.meta.outputs.tags }}
-        labels: ${{ steps.meta.outputs.labels }}
+        node-version: '20.x'
+        cache: 'npm'
+        registry-url: 'https://registry.npmjs.org'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build project
+      run: npm run build
+
+    - name: Publish to NPM
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -134,3 +134,7 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# MCP and project-specific
+logs/
+*.mcp.log