memory-journal-mcp 3.0.0
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.
- package/.dockerignore +88 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +76 -0
- package/.github/ISSUE_TEMPLATE/config.yml +11 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +89 -0
- package/.github/ISSUE_TEMPLATE/question.md +63 -0
- package/.github/dependabot.yml +110 -0
- package/.github/pull_request_template.md +110 -0
- package/.github/workflows/DOCKER_DEPLOYMENT_SETUP.md +346 -0
- package/.github/workflows/codeql.yml +45 -0
- package/.github/workflows/dependabot-auto-merge.yml +42 -0
- package/.github/workflows/docker-publish.yml +277 -0
- package/.github/workflows/lint-and-test.yml +58 -0
- package/.github/workflows/publish-npm.yml +75 -0
- package/.github/workflows/secrets-scanning.yml +32 -0
- package/.github/workflows/security-update.yml +99 -0
- package/.memory-journal-team.db +0 -0
- package/.trivyignore +18 -0
- package/CHANGELOG.md +19 -0
- package/CODE_OF_CONDUCT.md +128 -0
- package/CONTRIBUTING.md +209 -0
- package/DOCKER_README.md +377 -0
- package/Dockerfile +64 -0
- package/LICENSE +21 -0
- package/README.md +461 -0
- package/SECURITY.md +200 -0
- package/VERSION +1 -0
- package/dist/cli.d.ts +5 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +42 -0
- package/dist/cli.js.map +1 -0
- package/dist/constants/ServerInstructions.d.ts +8 -0
- package/dist/constants/ServerInstructions.d.ts.map +1 -0
- package/dist/constants/ServerInstructions.js +26 -0
- package/dist/constants/ServerInstructions.js.map +1 -0
- package/dist/database/SqliteAdapter.d.ts +198 -0
- package/dist/database/SqliteAdapter.d.ts.map +1 -0
- package/dist/database/SqliteAdapter.js +736 -0
- package/dist/database/SqliteAdapter.js.map +1 -0
- package/dist/filtering/ToolFilter.d.ts +63 -0
- package/dist/filtering/ToolFilter.d.ts.map +1 -0
- package/dist/filtering/ToolFilter.js +242 -0
- package/dist/filtering/ToolFilter.js.map +1 -0
- package/dist/github/GitHubIntegration.d.ts +91 -0
- package/dist/github/GitHubIntegration.d.ts.map +1 -0
- package/dist/github/GitHubIntegration.js +317 -0
- package/dist/github/GitHubIntegration.js.map +1 -0
- package/dist/handlers/prompts/index.d.ts +28 -0
- package/dist/handlers/prompts/index.d.ts.map +1 -0
- package/dist/handlers/prompts/index.js +366 -0
- package/dist/handlers/prompts/index.js.map +1 -0
- package/dist/handlers/resources/index.d.ts +27 -0
- package/dist/handlers/resources/index.d.ts.map +1 -0
- package/dist/handlers/resources/index.js +453 -0
- package/dist/handlers/resources/index.js.map +1 -0
- package/dist/handlers/tools/index.d.ts +26 -0
- package/dist/handlers/tools/index.d.ts.map +1 -0
- package/dist/handlers/tools/index.js +982 -0
- package/dist/handlers/tools/index.js.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +13 -0
- package/dist/index.js.map +1 -0
- package/dist/server/McpServer.d.ts +18 -0
- package/dist/server/McpServer.d.ts.map +1 -0
- package/dist/server/McpServer.js +171 -0
- package/dist/server/McpServer.js.map +1 -0
- package/dist/types/index.d.ts +300 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +15 -0
- package/dist/types/index.js.map +1 -0
- package/dist/utils/McpLogger.d.ts +61 -0
- package/dist/utils/McpLogger.d.ts.map +1 -0
- package/dist/utils/McpLogger.js +113 -0
- package/dist/utils/McpLogger.js.map +1 -0
- package/dist/utils/logger.d.ts +30 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +70 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/vector/VectorSearchManager.d.ts +63 -0
- package/dist/vector/VectorSearchManager.d.ts.map +1 -0
- package/dist/vector/VectorSearchManager.js +235 -0
- package/dist/vector/VectorSearchManager.js.map +1 -0
- package/docker-compose.yml +37 -0
- package/eslint.config.js +86 -0
- package/mcp-config-example.json +21 -0
- package/package.json +71 -0
- package/releases/release-notes-v2.2.0.md +165 -0
- package/releases/release-notes.md +214 -0
- package/releases/v3.0.0.md +236 -0
- package/server.json +42 -0
- package/src/cli.ts +52 -0
- package/src/constants/ServerInstructions.ts +25 -0
- package/src/database/SqliteAdapter.ts +952 -0
- package/src/filtering/ToolFilter.ts +271 -0
- package/src/github/GitHubIntegration.ts +409 -0
- package/src/handlers/prompts/index.ts +420 -0
- package/src/handlers/resources/index.ts +529 -0
- package/src/handlers/tools/index.ts +1081 -0
- package/src/index.ts +53 -0
- package/src/server/McpServer.ts +230 -0
- package/src/types/index.ts +435 -0
- package/src/types/sql.js.d.ts +34 -0
- package/src/utils/McpLogger.ts +155 -0
- package/src/utils/logger.ts +98 -0
- package/src/vector/VectorSearchManager.ts +277 -0
- package/tools.json +300 -0
- package/tsconfig.json +51 -0
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: Lint and Test
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [ main ]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [ main ]
|
|
8
|
+
|
|
9
|
+
permissions:
|
|
10
|
+
contents: read
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
lint:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
strategy:
|
|
16
|
+
matrix:
|
|
17
|
+
node-version: [ 20.x, 22.x, 25.x ]
|
|
18
|
+
|
|
19
|
+
steps:
|
|
20
|
+
- name: Checkout code
|
|
21
|
+
uses: actions/checkout@v5
|
|
22
|
+
|
|
23
|
+
- name: Setup Node.js ${{ matrix.node-version }}
|
|
24
|
+
uses: actions/setup-node@v6
|
|
25
|
+
with:
|
|
26
|
+
node-version: ${{ matrix.node-version }}
|
|
27
|
+
cache: 'npm'
|
|
28
|
+
|
|
29
|
+
- name: Install dependencies
|
|
30
|
+
run: npm ci
|
|
31
|
+
|
|
32
|
+
- name: Run ESLint
|
|
33
|
+
run: npm run lint
|
|
34
|
+
|
|
35
|
+
- name: Run TypeScript check
|
|
36
|
+
run: npm run typecheck
|
|
37
|
+
|
|
38
|
+
- name: Build
|
|
39
|
+
run: npm run build
|
|
40
|
+
|
|
41
|
+
security-scan:
|
|
42
|
+
runs-on: ubuntu-latest
|
|
43
|
+
steps:
|
|
44
|
+
- name: Checkout code
|
|
45
|
+
uses: actions/checkout@v5
|
|
46
|
+
|
|
47
|
+
- name: Setup Node.js
|
|
48
|
+
uses: actions/setup-node@v6
|
|
49
|
+
with:
|
|
50
|
+
node-version: '22.x'
|
|
51
|
+
cache: 'npm'
|
|
52
|
+
|
|
53
|
+
- name: Install dependencies
|
|
54
|
+
run: npm ci
|
|
55
|
+
|
|
56
|
+
- name: Run npm audit
|
|
57
|
+
run: npm audit --audit-level=moderate
|
|
58
|
+
continue-on-error: true
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
name: Publish to NPM
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
workflow_dispatch:
|
|
7
|
+
inputs:
|
|
8
|
+
version:
|
|
9
|
+
description: "Version to publish (must match VERSION file or package.json)"
|
|
10
|
+
required: false
|
|
11
|
+
default: ""
|
|
12
|
+
|
|
13
|
+
permissions:
|
|
14
|
+
contents: read
|
|
15
|
+
|
|
16
|
+
jobs:
|
|
17
|
+
publish:
|
|
18
|
+
runs-on: ubuntu-latest
|
|
19
|
+
environment:
|
|
20
|
+
name: npm
|
|
21
|
+
url: https://www.npmjs.com/package/memory-journal-mcp
|
|
22
|
+
|
|
23
|
+
steps:
|
|
24
|
+
- name: Checkout code
|
|
25
|
+
uses: actions/checkout@v5
|
|
26
|
+
|
|
27
|
+
- name: Setup Node.js
|
|
28
|
+
uses: actions/setup-node@v6
|
|
29
|
+
with:
|
|
30
|
+
node-version: '22.x'
|
|
31
|
+
registry-url: 'https://registry.npmjs.org'
|
|
32
|
+
cache: 'npm'
|
|
33
|
+
|
|
34
|
+
- name: Install dependencies
|
|
35
|
+
run: npm ci
|
|
36
|
+
|
|
37
|
+
- name: Read version
|
|
38
|
+
id: version
|
|
39
|
+
run: |
|
|
40
|
+
if [ -f "VERSION" ]; then
|
|
41
|
+
VERSION=$(head -1 VERSION | tr -d '[:space:]')
|
|
42
|
+
fi
|
|
43
|
+
if [ -z "$VERSION" ]; then
|
|
44
|
+
VERSION=$(node -p "require('./package.json').version")
|
|
45
|
+
fi
|
|
46
|
+
echo "version=$VERSION" >> $GITHUB_OUTPUT
|
|
47
|
+
echo "Detected version: $VERSION"
|
|
48
|
+
|
|
49
|
+
- name: Verify version matches release tag
|
|
50
|
+
if: github.event_name == 'release'
|
|
51
|
+
run: |
|
|
52
|
+
RELEASE_VERSION="${GITHUB_REF#refs/tags/}"
|
|
53
|
+
RELEASE_VERSION="${RELEASE_VERSION#v}"
|
|
54
|
+
PKG_VERSION="${{ steps.version.outputs.version }}"
|
|
55
|
+
echo "Package version: $PKG_VERSION"
|
|
56
|
+
echo "Release version: $RELEASE_VERSION"
|
|
57
|
+
if [ "$PKG_VERSION" != "$RELEASE_VERSION" ]; then
|
|
58
|
+
echo "Error: Version mismatch!"
|
|
59
|
+
echo "Expected: $PKG_VERSION"
|
|
60
|
+
echo "Got: $RELEASE_VERSION"
|
|
61
|
+
exit 1
|
|
62
|
+
fi
|
|
63
|
+
|
|
64
|
+
- name: Build package
|
|
65
|
+
run: npm run build
|
|
66
|
+
|
|
67
|
+
- name: Publish to NPM
|
|
68
|
+
run: npm publish --access public
|
|
69
|
+
env:
|
|
70
|
+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
|
71
|
+
|
|
72
|
+
- name: Verify publication
|
|
73
|
+
run: |
|
|
74
|
+
sleep 10
|
|
75
|
+
npm view memory-journal-mcp version
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
name: Secret Scanning
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [ main ]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [ main ]
|
|
8
|
+
|
|
9
|
+
permissions:
|
|
10
|
+
contents: read
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
secrets:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- name: Checkout code
|
|
17
|
+
uses: actions/checkout@v5
|
|
18
|
+
with:
|
|
19
|
+
fetch-depth: 0
|
|
20
|
+
|
|
21
|
+
- name: TruffleHog Secret Scanning
|
|
22
|
+
uses: trufflesecurity/trufflehog@main
|
|
23
|
+
with:
|
|
24
|
+
path: ./
|
|
25
|
+
base: ${{ github.event.before || 'HEAD~1' }}
|
|
26
|
+
head: HEAD
|
|
27
|
+
extra_args: --only-verified
|
|
28
|
+
continue-on-error: true
|
|
29
|
+
|
|
30
|
+
- name: GITLEAKS Secret Scanning
|
|
31
|
+
uses: gitleaks/gitleaks-action@v2
|
|
32
|
+
continue-on-error: true
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
name: Security Update Check
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
schedule:
|
|
5
|
+
# Run weekly on Sundays at 2 AM UTC
|
|
6
|
+
- cron: '0 2 * * 0'
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
|
|
9
|
+
permissions:
|
|
10
|
+
contents: write
|
|
11
|
+
pull-requests: write
|
|
12
|
+
security-events: write
|
|
13
|
+
issues: write
|
|
14
|
+
|
|
15
|
+
jobs:
|
|
16
|
+
security-scan:
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
|
|
19
|
+
steps:
|
|
20
|
+
- name: Checkout repository
|
|
21
|
+
uses: actions/checkout@v5
|
|
22
|
+
|
|
23
|
+
- name: Set up Docker Buildx
|
|
24
|
+
uses: docker/setup-buildx-action@v3
|
|
25
|
+
|
|
26
|
+
- name: Build image for scanning
|
|
27
|
+
uses: docker/build-push-action@v6
|
|
28
|
+
with:
|
|
29
|
+
context: .
|
|
30
|
+
file: Dockerfile
|
|
31
|
+
tags: security-test:latest
|
|
32
|
+
load: true
|
|
33
|
+
cache-from: type=gha
|
|
34
|
+
cache-to: type=gha,mode=max
|
|
35
|
+
|
|
36
|
+
# Run SARIF scan first (non-blocking) to always generate the file
|
|
37
|
+
- name: Run Trivy scanner for SARIF output
|
|
38
|
+
uses: aquasecurity/trivy-action@master
|
|
39
|
+
with:
|
|
40
|
+
image-ref: security-test:latest
|
|
41
|
+
format: 'sarif'
|
|
42
|
+
output: 'trivy-results.sarif'
|
|
43
|
+
exit-code: '0'
|
|
44
|
+
ignore-unfixed: true
|
|
45
|
+
severity: 'CRITICAL,HIGH,MEDIUM'
|
|
46
|
+
trivyignores: '.trivyignore'
|
|
47
|
+
skip-dirs: '/usr/local/lib/node_modules/npm'
|
|
48
|
+
|
|
49
|
+
- name: Upload Trivy scan results
|
|
50
|
+
uses: github/codeql-action/upload-sarif@v4
|
|
51
|
+
if: always()
|
|
52
|
+
with:
|
|
53
|
+
sarif_file: 'trivy-results.sarif'
|
|
54
|
+
|
|
55
|
+
# Run table scan (blocking) after SARIF is uploaded
|
|
56
|
+
- name: Run Trivy vulnerability scanner
|
|
57
|
+
uses: aquasecurity/trivy-action@master
|
|
58
|
+
with:
|
|
59
|
+
image-ref: security-test:latest
|
|
60
|
+
format: 'table'
|
|
61
|
+
exit-code: '1'
|
|
62
|
+
ignore-unfixed: true
|
|
63
|
+
severity: 'CRITICAL,HIGH,MEDIUM'
|
|
64
|
+
trivyignores: '.trivyignore'
|
|
65
|
+
skip-dirs: '/usr/local/lib/node_modules/npm'
|
|
66
|
+
|
|
67
|
+
- name: Create security issue if vulnerabilities found
|
|
68
|
+
if: failure()
|
|
69
|
+
uses: actions/github-script@v8
|
|
70
|
+
with:
|
|
71
|
+
script: |
|
|
72
|
+
github.rest.issues.create({
|
|
73
|
+
owner: context.repo.owner,
|
|
74
|
+
repo: context.repo.repo,
|
|
75
|
+
title: '๐จ Security vulnerabilities detected in Docker images',
|
|
76
|
+
body: `
|
|
77
|
+
## Security Alert
|
|
78
|
+
|
|
79
|
+
Trivy has detected security vulnerabilities in our Docker images.
|
|
80
|
+
|
|
81
|
+
**Action Required:**
|
|
82
|
+
1. Review the security scan results in the Actions tab
|
|
83
|
+
2. Update base images and dependencies
|
|
84
|
+
3. Test the fixes
|
|
85
|
+
4. Deploy updated images
|
|
86
|
+
|
|
87
|
+
**Scan Details:**
|
|
88
|
+
- Workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
|
89
|
+
- Triggered by: Weekly security scan
|
|
90
|
+
- Scan Date: ${{ github.event.schedule || 'Manual trigger' }}
|
|
91
|
+
|
|
92
|
+
**Next Steps:**
|
|
93
|
+
- [ ] Review vulnerability details
|
|
94
|
+
- [ ] Update Dockerfiles
|
|
95
|
+
- [ ] Test changes
|
|
96
|
+
- [ ] Deploy fixes
|
|
97
|
+
`,
|
|
98
|
+
labels: ['security', 'vulnerability', 'docker']
|
|
99
|
+
})
|
|
Binary file
|
package/.trivyignore
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Trivy Ignore File
|
|
2
|
+
# See: https://aquasecurity.github.io/trivy/latest/docs/configuration/filtering/
|
|
3
|
+
|
|
4
|
+
# CVE-2025-64756: glob command injection in npm CLI (HIGH)
|
|
5
|
+
# This is in the Node.js base image's npm installation (/usr/local/lib/node_modules/npm)
|
|
6
|
+
# We don't use glob CLI directly and cannot patch base image npm
|
|
7
|
+
# Will be fixed when Node.js releases updated base images
|
|
8
|
+
CVE-2025-64756
|
|
9
|
+
|
|
10
|
+
# CVE-2025-5889: brace-expansion ReDoS (LOW)
|
|
11
|
+
# Bundled in protobufjs/cli/node_modules - can't override with npm
|
|
12
|
+
# LOW severity, attack complexity is high, exploitation is difficult
|
|
13
|
+
CVE-2025-5889
|
|
14
|
+
|
|
15
|
+
# CVE-2025-54798: tmp symlink vulnerability (LOW)
|
|
16
|
+
# Bundled in protobufjs/cli/node_modules - can't override with npm
|
|
17
|
+
# LOW severity, only affects tmp file creation in CLI context
|
|
18
|
+
CVE-2025-54798
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
The D1 Database Manager changelog is maintained in the project wiki.
|
|
4
|
+
|
|
5
|
+
## ๐ View the Changelog
|
|
6
|
+
|
|
7
|
+
**Wiki (recommended):** [Changelog](https://github.com/neverinfamous/memory-journal-mcp/wiki/CHANGELOG)
|
|
8
|
+
|
|
9
|
+
**GitHub Repository:** [neverinfamous/memory-journal-mcp](https://github.com/neverinfamous/memory-journal-mcp)
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
The wiki changelog includes:
|
|
14
|
+
- All version history and release notes
|
|
15
|
+
- Detailed feature descriptions
|
|
16
|
+
- Bug fixes and improvements
|
|
17
|
+
- Breaking changes and migration guides
|
|
18
|
+
|
|
19
|
+
For the latest updates, please refer to the wiki.
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:* The use of sexualized language or imagery, and sexual attention or advances of
|
|
29
|
+
any kind
|
|
30
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
31
|
+
* Public or private harassment
|
|
32
|
+
* Publishing others' private information, such as a physical or email address,
|
|
33
|
+
without their explicit permission
|
|
34
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
35
|
+
professional setting
|
|
36
|
+
|
|
37
|
+
## Enforcement Responsibilities
|
|
38
|
+
|
|
39
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
40
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
41
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
42
|
+
or harmful.
|
|
43
|
+
|
|
44
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
45
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
46
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
47
|
+
decisions when appropriate.
|
|
48
|
+
|
|
49
|
+
## Scope
|
|
50
|
+
|
|
51
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
52
|
+
an individual is officially representing the community in public spaces.
|
|
53
|
+
Examples of representing our community include using an official e-mail address,
|
|
54
|
+
posting via an official social media account, or acting as an appointed
|
|
55
|
+
representative at an online or offline event.
|
|
56
|
+
|
|
57
|
+
## Enforcement
|
|
58
|
+
|
|
59
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
60
|
+
reported to the community leaders responsible for enforcement at
|
|
61
|
+
[INSERT CONTACT METHOD].
|
|
62
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
63
|
+
|
|
64
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
65
|
+
reporter of any incident.## Enforcement Guidelines
|
|
66
|
+
|
|
67
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
68
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
69
|
+
|
|
70
|
+
### 1. Correction
|
|
71
|
+
|
|
72
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
73
|
+
unprofessional or unwelcome in the community.
|
|
74
|
+
|
|
75
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
76
|
+
clarity around the nature of the violation and an explanation of why the
|
|
77
|
+
behavior was inappropriate. A public apology may be requested.
|
|
78
|
+
|
|
79
|
+
### 2. Warning
|
|
80
|
+
|
|
81
|
+
**Community Impact**: A violation through a single incident or series of
|
|
82
|
+
actions.
|
|
83
|
+
|
|
84
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
85
|
+
interaction with the people involved, including unsolicited interaction with
|
|
86
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
87
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
88
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
89
|
+
ban.
|
|
90
|
+
|
|
91
|
+
### 3. Temporary Ban
|
|
92
|
+
|
|
93
|
+
**Community Impact**: A serious violation of community standards, including
|
|
94
|
+
sustained inappropriate behavior.
|
|
95
|
+
|
|
96
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
97
|
+
communication with the community for a specified period of time. No public or
|
|
98
|
+
private interaction with the people involved, including unsolicited interaction
|
|
99
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
100
|
+
Violating these terms may lead to a permanent ban.
|
|
101
|
+
|
|
102
|
+
### 4. Permanent Ban
|
|
103
|
+
|
|
104
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
105
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
106
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
107
|
+
|
|
108
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
109
|
+
community.
|
|
110
|
+
|
|
111
|
+
## Attribution
|
|
112
|
+
|
|
113
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
114
|
+
version 2.1, available at
|
|
115
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
116
|
+
|
|
117
|
+
Community Impact Guidelines were inspired by
|
|
118
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
119
|
+
|
|
120
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
121
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
122
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
123
|
+
|
|
124
|
+
[homepage]: https://www.contributor-covenant.org
|
|
125
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
126
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
127
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
128
|
+
[translations]: https://www.contributor-covenant.org/translations
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Contributing to Memory Journal MCP Server
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to the Memory Journal MCP Server! This project is built by developers, for developers, and we welcome contributions that make the journaling experience better for everyone.
|
|
4
|
+
|
|
5
|
+
## ๐ Quick Start
|
|
6
|
+
|
|
7
|
+
1. **Fork the repository** on GitHub
|
|
8
|
+
2. **Clone your fork** locally
|
|
9
|
+
3. **Create a feature branch** from `main`
|
|
10
|
+
4. **Make your changes** and test thoroughly
|
|
11
|
+
5. **Submit a pull request** with a clear description
|
|
12
|
+
|
|
13
|
+
## ๐ ๏ธ Development Setup
|
|
14
|
+
|
|
15
|
+
### Option 1: Docker Development (Recommended)
|
|
16
|
+
```bash
|
|
17
|
+
# Clone your fork
|
|
18
|
+
git clone https://github.com/YOUR_USERNAME/memory-journal-mcp.git
|
|
19
|
+
cd memory-journal-mcp
|
|
20
|
+
|
|
21
|
+
# Build and test with Docker
|
|
22
|
+
docker build -f Dockerfile.alpine -t memory-journal-dev .
|
|
23
|
+
docker run --rm -v ./data:/app/data memory-journal-dev python src/server.py
|
|
24
|
+
|
|
25
|
+
# Test the MCP server
|
|
26
|
+
docker run --rm memory-journal-dev python -c "print('โ
MCP Server ready!')"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Option 2: Local Development
|
|
30
|
+
```bash
|
|
31
|
+
# Clone your fork
|
|
32
|
+
git clone https://github.com/YOUR_USERNAME/memory-journal-mcp.git
|
|
33
|
+
cd memory-journal-mcp
|
|
34
|
+
|
|
35
|
+
# Install dependencies
|
|
36
|
+
pip install -r requirements.txt
|
|
37
|
+
|
|
38
|
+
# Optional: Install semantic search dependencies
|
|
39
|
+
pip install sentence-transformers faiss-cpu
|
|
40
|
+
|
|
41
|
+
# Test the server
|
|
42
|
+
python src/server.py
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## ๐ What We're Looking For
|
|
46
|
+
|
|
47
|
+
We especially welcome contributions in these areas:
|
|
48
|
+
|
|
49
|
+
### ๐ฏ High Priority
|
|
50
|
+
- **New entry types** that make sense for developer workflows
|
|
51
|
+
- **Better Git/GitHub integrations** (more context, better performance)
|
|
52
|
+
- **Performance improvements** (faster search, reduced memory usage)
|
|
53
|
+
- **Bug fixes** and stability improvements
|
|
54
|
+
|
|
55
|
+
### ๐ Medium Priority
|
|
56
|
+
- **Enhanced semantic search** features and models
|
|
57
|
+
- **Import/export utilities** for data portability
|
|
58
|
+
- **Additional relationship types** between entries
|
|
59
|
+
- **Documentation improvements** and examples
|
|
60
|
+
|
|
61
|
+
### ๐ก Future Features
|
|
62
|
+
- **Graph visualization** of entry relationships
|
|
63
|
+
- **Weekly/monthly auto-summaries**
|
|
64
|
+
- **Team collaboration** features
|
|
65
|
+
- **IDE integrations** beyond MCP
|
|
66
|
+
|
|
67
|
+
## ๐งช Testing Your Changes
|
|
68
|
+
|
|
69
|
+
### Manual Testing
|
|
70
|
+
```bash
|
|
71
|
+
# Test basic functionality
|
|
72
|
+
python -c "
|
|
73
|
+
import sys
|
|
74
|
+
sys.path.append('src')
|
|
75
|
+
from server import *
|
|
76
|
+
print('โ
Server imports successfully')
|
|
77
|
+
"
|
|
78
|
+
|
|
79
|
+
# Test with MCP client (Cursor)
|
|
80
|
+
# Add your local server to ~/.cursor/mcp.json:
|
|
81
|
+
{
|
|
82
|
+
"mcpServers": {
|
|
83
|
+
"memory-journal-dev": {
|
|
84
|
+
"command": "python",
|
|
85
|
+
"args": ["path/to/your/memory-journal-mcp/src/server.py"]
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Docker Testing
|
|
92
|
+
```bash
|
|
93
|
+
# Test alpine build
|
|
94
|
+
docker build -f Dockerfile.alpine -t test-alpine .
|
|
95
|
+
docker run --rm test-alpine python -c "print('Alpine build works!')"
|
|
96
|
+
|
|
97
|
+
# Test full build
|
|
98
|
+
docker build -f Dockerfile -t test-full .
|
|
99
|
+
docker run --rm test-full python -c "print('Full build works!')"
|
|
100
|
+
```## ๐ Coding Standards
|
|
101
|
+
|
|
102
|
+
### Python Code Style
|
|
103
|
+
- **PEP 8 compliance** - Use `black` for formatting
|
|
104
|
+
- **Type hints** - Add type annotations for new functions
|
|
105
|
+
- **Docstrings** - Document public functions and classes
|
|
106
|
+
- **Async/await** - Use async patterns for I/O operations
|
|
107
|
+
- **Error handling** - Implement graceful fallbacks
|
|
108
|
+
|
|
109
|
+
### Database Changes
|
|
110
|
+
- **Schema migrations** - Update `src/schema.sql` for database changes
|
|
111
|
+
- **Backward compatibility** - Ensure existing data isn't broken
|
|
112
|
+
- **Performance** - Consider index implications for new queries
|
|
113
|
+
- **Testing** - Verify with both empty and populated databases
|
|
114
|
+
|
|
115
|
+
### Docker Considerations
|
|
116
|
+
- **Multi-stage builds** - Keep images lean
|
|
117
|
+
- **Security** - Run as non-root user, minimal privileges
|
|
118
|
+
- **Compatibility** - Test on both lite and full variants
|
|
119
|
+
- **Documentation** - Update Docker guides if needed
|
|
120
|
+
|
|
121
|
+
## ๐ Bug Reports
|
|
122
|
+
|
|
123
|
+
When reporting bugs, please include:
|
|
124
|
+
|
|
125
|
+
1. **Environment details** (OS, Python version, Docker version)
|
|
126
|
+
2. **Steps to reproduce** the issue
|
|
127
|
+
3. **Expected vs actual behavior**
|
|
128
|
+
4. **MCP client details** (Cursor version, configuration)
|
|
129
|
+
5. **Relevant logs** or error messages
|
|
130
|
+
6. **Database state** (if applicable)
|
|
131
|
+
|
|
132
|
+
Use our [Bug Report template](.github/ISSUE_TEMPLATE/bug_report.md) for consistency.
|
|
133
|
+
|
|
134
|
+
## ๐ก Feature Requests
|
|
135
|
+
|
|
136
|
+
For new features, please provide:
|
|
137
|
+
|
|
138
|
+
1. **Use case description** - What problem does this solve?
|
|
139
|
+
2. **Proposed solution** - How should it work?
|
|
140
|
+
3. **Developer workflow** - How does this fit into dev work?
|
|
141
|
+
4. **Alternatives considered** - What other approaches did you think about?
|
|
142
|
+
5. **Implementation notes** - Any technical considerations
|
|
143
|
+
|
|
144
|
+
Use our [Feature Request template](.github/ISSUE_TEMPLATE/feature_request.md).
|
|
145
|
+
|
|
146
|
+
## ๐ Pull Request Process
|
|
147
|
+
|
|
148
|
+
### Before Submitting
|
|
149
|
+
- [ ] **Fork** the repository and create a feature branch
|
|
150
|
+
- [ ] **Test** your changes thoroughly (manual + Docker)
|
|
151
|
+
- [ ] **Update documentation** if you changed APIs or behavior
|
|
152
|
+
- [ ] **Add examples** for new features
|
|
153
|
+
- [ ] **Check** that existing functionality still works
|
|
154
|
+
|
|
155
|
+
### PR Description Should Include
|
|
156
|
+
- **Summary** of changes made
|
|
157
|
+
- **Testing** performed (how did you verify it works?)
|
|
158
|
+
- **Breaking changes** (if any)
|
|
159
|
+
- **Related issues** (fixes #123)
|
|
160
|
+
- **Screenshots** (for UI changes)
|
|
161
|
+
|
|
162
|
+
### Review Process
|
|
163
|
+
1. **Automated checks** must pass
|
|
164
|
+
2. **Maintainer review** - we'll provide feedback
|
|
165
|
+
3. **Address feedback** - make requested changes
|
|
166
|
+
4. **Merge** - once approved, we'll merge your PR
|
|
167
|
+
|
|
168
|
+
## ๐ฏ Development Tips
|
|
169
|
+
|
|
170
|
+
### Working with MCP
|
|
171
|
+
- **Test in Cursor** - The primary MCP client environment
|
|
172
|
+
- **Check tool responses** - Ensure JSON responses are well-formed
|
|
173
|
+
- **Handle timeouts** - Git operations should fail fast
|
|
174
|
+
- **Async safety** - All blocking operations in thread pools
|
|
175
|
+
|
|
176
|
+
### Database Development
|
|
177
|
+
- **Use WAL mode** - Already configured for concurrency
|
|
178
|
+
- **FTS5 integration** - Full-text search is performance-critical
|
|
179
|
+
- **Proper transactions** - Always commit changes
|
|
180
|
+
- **Index optimization** - Consider query performance
|
|
181
|
+
|
|
182
|
+
### Docker Development
|
|
183
|
+
```bash
|
|
184
|
+
# Quick rebuild and test cycle
|
|
185
|
+
docker build -f Dockerfile.alpine -t dev-test . && \
|
|
186
|
+
docker run --rm -v ./data:/app/data dev-test python src/server.py
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
## ๐ค Community
|
|
190
|
+
|
|
191
|
+
- **Be respectful** - Follow our [Code of Conduct](CODE_OF_CONDUCT.md)
|
|
192
|
+
- **Ask questions** - Use GitHub Discussions for help
|
|
193
|
+
- **Share ideas** - Feature requests and feedback welcome
|
|
194
|
+
- **Help others** - Answer questions and review PRs
|
|
195
|
+
|
|
196
|
+
## ๐ Getting Help
|
|
197
|
+
|
|
198
|
+
- **GitHub Issues** - Bug reports and feature requests
|
|
199
|
+
- **GitHub Discussions** - Questions and community chat
|
|
200
|
+
- **Documentation** - Check README.md and Docker guides first
|
|
201
|
+
|
|
202
|
+
## ๐ Recognition
|
|
203
|
+
|
|
204
|
+
Contributors are recognized in:
|
|
205
|
+
- **Release notes** - Major contributions highlighted
|
|
206
|
+
- **README** - Contributor acknowledgments
|
|
207
|
+
- **Git history** - Your commits are permanent record
|
|
208
|
+
|
|
209
|
+
Thank you for helping make Memory Journal MCP Server better for the developer community! ๐
|