memento-mcp-server 1.6.0 → 1.7.1
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/INSTALL.en.md +303 -303
- package/INSTALL.md +303 -303
- package/README.en.md +331 -330
- package/README.md +432 -432
- package/dist/algorithms/hybrid-search-engine.d.ts +114 -44
- package/dist/algorithms/hybrid-search-engine.d.ts.map +1 -1
- package/dist/algorithms/hybrid-search-engine.js +261 -235
- package/dist/algorithms/hybrid-search-engine.js.map +1 -1
- package/dist/algorithms/search-engine.d.ts +2 -14
- package/dist/algorithms/search-engine.d.ts.map +1 -1
- package/dist/algorithms/search-engine.js +43 -35
- package/dist/algorithms/search-engine.js.map +1 -1
- package/dist/algorithms/vector-search-engine-migration.d.ts +67 -0
- package/dist/algorithms/vector-search-engine-migration.d.ts.map +1 -0
- package/dist/algorithms/vector-search-engine-migration.js +196 -0
- package/dist/algorithms/vector-search-engine-migration.js.map +1 -0
- package/dist/algorithms/vector-search-engine-refactored.d.ts +56 -0
- package/dist/algorithms/vector-search-engine-refactored.d.ts.map +1 -0
- package/dist/algorithms/vector-search-engine-refactored.js +101 -0
- package/dist/algorithms/vector-search-engine-refactored.js.map +1 -0
- package/dist/algorithms/vector-search-engine.d.ts +9 -2
- package/dist/algorithms/vector-search-engine.d.ts.map +1 -1
- package/dist/algorithms/vector-search-engine.js +245 -121
- package/dist/algorithms/vector-search-engine.js.map +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +34 -11
- package/dist/client/index.js.map +1 -1
- package/dist/config/environment.d.ts +26 -0
- package/dist/config/environment.d.ts.map +1 -0
- package/dist/config/environment.js +103 -0
- package/dist/config/environment.js.map +1 -0
- package/dist/config/index.d.ts.map +1 -1
- package/dist/config/index.js +29 -50
- package/dist/config/index.js.map +1 -1
- package/dist/config/vector-search.config.d.ts +25 -0
- package/dist/config/vector-search.config.d.ts.map +1 -0
- package/dist/config/vector-search.config.js +40 -0
- package/dist/config/vector-search.config.js.map +1 -0
- package/dist/database/init.d.ts.map +1 -1
- package/dist/database/init.js +154 -17
- package/dist/database/init.js.map +1 -1
- package/dist/database/migrate.d.ts +2 -1
- package/dist/database/migrate.d.ts.map +1 -1
- package/dist/database/migrate.js +191 -18
- package/dist/database/migrate.js.map +1 -1
- package/dist/database/schema.sql +234 -159
- package/dist/factories/hybrid-search.factory.d.ts +20 -0
- package/dist/factories/hybrid-search.factory.d.ts.map +1 -0
- package/dist/factories/hybrid-search.factory.js +57 -0
- package/dist/factories/hybrid-search.factory.js.map +1 -0
- package/dist/factories/spaced-repetition.factory.d.ts +48 -0
- package/dist/factories/spaced-repetition.factory.d.ts.map +1 -0
- package/dist/factories/spaced-repetition.factory.js +187 -0
- package/dist/factories/spaced-repetition.factory.js.map +1 -0
- package/dist/factories/vector-search.factory.d.ts +25 -0
- package/dist/factories/vector-search.factory.d.ts.map +1 -0
- package/dist/factories/vector-search.factory.js +47 -0
- package/dist/factories/vector-search.factory.js.map +1 -0
- package/dist/interfaces/database.interface.d.ts +36 -0
- package/dist/interfaces/database.interface.d.ts.map +1 -0
- package/dist/interfaces/database.interface.js +6 -0
- package/dist/interfaces/database.interface.js.map +1 -0
- package/dist/interfaces/spaced-repetition.interface.d.ts +63 -0
- package/dist/interfaces/spaced-repetition.interface.d.ts.map +1 -0
- package/dist/interfaces/spaced-repetition.interface.js +6 -0
- package/dist/interfaces/spaced-repetition.interface.js.map +1 -0
- package/dist/repositories/vector-performance.repository.d.ts +25 -0
- package/dist/repositories/vector-performance.repository.d.ts.map +1 -0
- package/dist/repositories/vector-performance.repository.js +134 -0
- package/dist/repositories/vector-performance.repository.js.map +1 -0
- package/dist/repositories/vector-search.repository.d.ts +43 -0
- package/dist/repositories/vector-search.repository.d.ts.map +1 -0
- package/dist/repositories/vector-search.repository.js +377 -0
- package/dist/repositories/vector-search.repository.js.map +1 -0
- package/dist/server/http-server.d.ts.map +1 -1
- package/dist/server/http-server.js +25 -24
- package/dist/server/http-server.js.map +1 -1
- package/dist/server/index.d.ts +1 -0
- package/dist/server/index.d.ts.map +1 -1
- package/dist/server/index.js +3 -1
- package/dist/server/index.js.map +1 -1
- package/dist/services/alert-notification-service.d.ts +16 -0
- package/dist/services/alert-notification-service.d.ts.map +1 -0
- package/dist/services/alert-notification-service.js +44 -0
- package/dist/services/alert-notification-service.js.map +1 -0
- package/dist/services/async-optimizer.d.ts +62 -8
- package/dist/services/async-optimizer.d.ts.map +1 -1
- package/dist/services/async-optimizer.js +137 -8
- package/dist/services/async-optimizer.js.map +1 -1
- package/dist/services/batch-scheduler.d.ts +6 -0
- package/dist/services/batch-scheduler.d.ts.map +1 -1
- package/dist/services/batch-scheduler.js +59 -19
- package/dist/services/batch-scheduler.js.map +1 -1
- package/dist/services/cache-service.d.ts +32 -0
- package/dist/services/cache-service.d.ts.map +1 -1
- package/dist/services/cache-service.js +81 -6
- package/dist/services/cache-service.js.map +1 -1
- package/dist/services/database-optimizer.js +63 -63
- package/dist/services/database-optimizer.js.map +1 -1
- package/dist/services/embedding-migration-service.d.ts +24 -0
- package/dist/services/embedding-migration-service.d.ts.map +1 -0
- package/dist/services/embedding-migration-service.js +360 -0
- package/dist/services/embedding-migration-service.js.map +1 -0
- package/dist/services/embedding-provider-factory.d.ts +12 -5
- package/dist/services/embedding-provider-factory.d.ts.map +1 -1
- package/dist/services/embedding-provider-factory.js +107 -26
- package/dist/services/embedding-provider-factory.js.map +1 -1
- package/dist/services/forgetting-policy-service.js +17 -17
- package/dist/services/gemini-embedding-service.d.ts +1 -1
- package/dist/services/gemini-embedding-service.d.ts.map +1 -1
- package/dist/services/gemini-embedding-service.js +25 -18
- package/dist/services/gemini-embedding-service.js.map +1 -1
- package/dist/services/memory-embedding-service.d.ts +8 -0
- package/dist/services/memory-embedding-service.d.ts.map +1 -1
- package/dist/services/memory-embedding-service.js +180 -71
- package/dist/services/memory-embedding-service.js.map +1 -1
- package/dist/services/migration-history-service.d.ts +14 -0
- package/dist/services/migration-history-service.d.ts.map +1 -0
- package/dist/services/migration-history-service.js +270 -0
- package/dist/services/migration-history-service.js.map +1 -0
- package/dist/services/migration-monitor-service.d.ts +24 -0
- package/dist/services/migration-monitor-service.d.ts.map +1 -0
- package/dist/services/migration-monitor-service.js +93 -0
- package/dist/services/migration-monitor-service.js.map +1 -0
- package/dist/services/model-availability-service.d.ts +22 -0
- package/dist/services/model-availability-service.d.ts.map +1 -0
- package/dist/services/model-availability-service.js +140 -0
- package/dist/services/model-availability-service.js.map +1 -0
- package/dist/services/openai-embedding-service.d.ts +36 -0
- package/dist/services/openai-embedding-service.d.ts.map +1 -0
- package/dist/services/openai-embedding-service.js +192 -0
- package/dist/services/openai-embedding-service.js.map +1 -0
- package/dist/services/performance-monitor.d.ts +154 -10
- package/dist/services/performance-monitor.d.ts.map +1 -1
- package/dist/services/performance-monitor.js +446 -60
- package/dist/services/performance-monitor.js.map +1 -1
- package/dist/services/spaced-repetition/interval-calculation.service.d.ts +38 -0
- package/dist/services/spaced-repetition/interval-calculation.service.d.ts.map +1 -0
- package/dist/services/spaced-repetition/interval-calculation.service.js +105 -0
- package/dist/services/spaced-repetition/interval-calculation.service.js.map +1 -0
- package/dist/services/spaced-repetition/optimal-interval.service.d.ts +56 -0
- package/dist/services/spaced-repetition/optimal-interval.service.d.ts.map +1 -0
- package/dist/services/spaced-repetition/optimal-interval.service.js +163 -0
- package/dist/services/spaced-repetition/optimal-interval.service.js.map +1 -0
- package/dist/services/spaced-repetition/performance-analysis.service.d.ts +48 -0
- package/dist/services/spaced-repetition/performance-analysis.service.d.ts.map +1 -0
- package/dist/services/spaced-repetition/performance-analysis.service.js +174 -0
- package/dist/services/spaced-repetition/performance-analysis.service.js.map +1 -0
- package/dist/services/spaced-repetition/priority-calculation.service.d.ts +53 -0
- package/dist/services/spaced-repetition/priority-calculation.service.d.ts.map +1 -0
- package/dist/services/spaced-repetition/priority-calculation.service.js +161 -0
- package/dist/services/spaced-repetition/priority-calculation.service.js.map +1 -0
- package/dist/services/spaced-repetition/recall-probability.service.d.ts +36 -0
- package/dist/services/spaced-repetition/recall-probability.service.d.ts.map +1 -0
- package/dist/services/spaced-repetition/recall-probability.service.js +88 -0
- package/dist/services/spaced-repetition/recall-probability.service.js.map +1 -0
- package/dist/services/spaced-repetition/review-scheduling.service.d.ts +43 -0
- package/dist/services/spaced-repetition/review-scheduling.service.d.ts.map +1 -0
- package/dist/services/spaced-repetition/review-scheduling.service.js +130 -0
- package/dist/services/spaced-repetition/review-scheduling.service.js.map +1 -0
- package/dist/services/spaced-repetition/spaced-repetition-container.d.ts +69 -0
- package/dist/services/spaced-repetition/spaced-repetition-container.d.ts.map +1 -0
- package/dist/services/spaced-repetition/spaced-repetition-container.js +136 -0
- package/dist/services/spaced-repetition/spaced-repetition-container.js.map +1 -0
- package/dist/services/unified-embedding-service.d.ts +3 -0
- package/dist/services/unified-embedding-service.d.ts.map +1 -1
- package/dist/services/unified-embedding-service.js +58 -62
- package/dist/services/unified-embedding-service.js.map +1 -1
- package/dist/services/vector-compatibility-service.d.ts +68 -0
- package/dist/services/vector-compatibility-service.d.ts.map +1 -0
- package/dist/services/vector-compatibility-service.js +373 -0
- package/dist/services/vector-compatibility-service.js.map +1 -0
- package/dist/services/vector-search/vector-index-manager.d.ts +27 -0
- package/dist/services/vector-search/vector-index-manager.d.ts.map +1 -0
- package/dist/services/vector-search/vector-index-manager.js +66 -0
- package/dist/services/vector-search/vector-index-manager.js.map +1 -0
- package/dist/services/vector-search/vector-performance-tester.d.ts +30 -0
- package/dist/services/vector-search/vector-performance-tester.d.ts.map +1 -0
- package/dist/services/vector-search/vector-performance-tester.js +87 -0
- package/dist/services/vector-search/vector-performance-tester.js.map +1 -0
- package/dist/services/vector-search/vector-search-container.d.ts +41 -0
- package/dist/services/vector-search/vector-search-container.d.ts.map +1 -0
- package/dist/services/vector-search/vector-search-container.js +74 -0
- package/dist/services/vector-search/vector-search-container.js.map +1 -0
- package/dist/services/vector-search/vector-search-facade.d.ts +63 -0
- package/dist/services/vector-search/vector-search-facade.d.ts.map +1 -0
- package/dist/services/vector-search/vector-search-facade.js +91 -0
- package/dist/services/vector-search/vector-search-facade.js.map +1 -0
- package/dist/services/vector-search/vector-search-result-normalizer.d.ts +6 -0
- package/dist/services/vector-search/vector-search-result-normalizer.d.ts.map +1 -0
- package/dist/services/vector-search/vector-search-result-normalizer.js +65 -0
- package/dist/services/vector-search/vector-search-result-normalizer.js.map +1 -0
- package/dist/services/vector-search/vector-search.service.d.ts +33 -0
- package/dist/services/vector-search/vector-search.service.d.ts.map +1 -0
- package/dist/services/vector-search/vector-search.service.js +149 -0
- package/dist/services/vector-search/vector-search.service.js.map +1 -0
- package/dist/tools/forget-tool.js +14 -14
- package/dist/tools/pin-tool.js +14 -14
- package/dist/tools/unpin-tool.js +21 -21
- package/dist/types/alerts.types.d.ts +26 -0
- package/dist/types/alerts.types.d.ts.map +1 -0
- package/dist/types/alerts.types.js +2 -0
- package/dist/types/alerts.types.js.map +1 -0
- package/dist/types/embedding-provider-monitoring.types.d.ts +24 -0
- package/dist/types/embedding-provider-monitoring.types.d.ts.map +1 -0
- package/dist/types/embedding-provider-monitoring.types.js +2 -0
- package/dist/types/embedding-provider-monitoring.types.js.map +1 -0
- package/dist/types/embedding.types.d.ts +36 -1
- package/dist/types/embedding.types.d.ts.map +1 -1
- package/dist/types/migration.types.d.ts +131 -0
- package/dist/types/migration.types.d.ts.map +1 -0
- package/dist/types/migration.types.js +6 -0
- package/dist/types/migration.types.js.map +1 -0
- package/dist/types/spaced-repetition.types.d.ts +61 -0
- package/dist/types/spaced-repetition.types.d.ts.map +1 -0
- package/dist/types/spaced-repetition.types.js +6 -0
- package/dist/types/spaced-repetition.types.js.map +1 -0
- package/dist/types/vector-search.types.d.ts +96 -0
- package/dist/types/vector-search.types.d.ts.map +1 -0
- package/dist/types/vector-search.types.js +2 -0
- package/dist/types/vector-search.types.js.map +1 -0
- package/dist/utils/configuration-validator.d.ts +23 -0
- package/dist/utils/configuration-validator.d.ts.map +1 -0
- package/dist/utils/configuration-validator.js +102 -0
- package/dist/utils/configuration-validator.js.map +1 -0
- package/dist/utils/database.d.ts.map +1 -1
- package/dist/utils/database.js +101 -95
- package/dist/utils/database.js.map +1 -1
- package/dist/utils/environment-check.d.ts +8 -0
- package/dist/utils/environment-check.d.ts.map +1 -0
- package/dist/utils/environment-check.js +25 -0
- package/dist/utils/environment-check.js.map +1 -0
- package/dist/utils/logger.d.ts +8 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +33 -0
- package/dist/utils/logger.js.map +1 -0
- package/package.json +139 -125
- package/scripts/auto-setup.js +233 -233
- package/scripts/backup-daily.bat +28 -28
- package/scripts/backup-embeddings.js +108 -108
- package/scripts/check-db-integrity.js +93 -93
- package/scripts/debug-embeddings.js +184 -184
- package/scripts/direct-sql-migration.sql +36 -36
- package/scripts/docker-migration.sh +105 -105
- package/scripts/fix-migration.js +93 -93
- package/scripts/fix-vector-dimensions.js +206 -206
- package/scripts/migrate-embedding-data.js +307 -307
- package/scripts/regenerate-embeddings.js +144 -144
- package/scripts/restore-legacy.ps1 +60 -60
- package/scripts/run-migration.js +122 -122
- package/scripts/safe-migration.js +150 -150
- package/scripts/simple-migrate.js +41 -41
- package/scripts/simple-update.js +123 -123
- package/src/database/schema.sql +234 -159
- package/.cursor/rules/cache-management.mdc +0 -171
- package/.cursor/rules/database-schema.mdc +0 -344
- package/.cursor/rules/deployment.mdc +0 -596
- package/.cursor/rules/error-logging.mdc +0 -298
- package/.cursor/rules/forgetting-algorithms.mdc +0 -426
- package/.cursor/rules/http-server.mdc +0 -432
- package/.cursor/rules/hybrid-search.mdc +0 -424
- package/.cursor/rules/implementation.mdc +0 -369
- package/.cursor/rules/lightweight-embedding.mdc +0 -178
- package/.cursor/rules/mcp-client-development.mdc +0 -0
- package/.cursor/rules/mcp-server-development.mdc +0 -0
- package/.cursor/rules/mcp-tools-architecture.mdc +0 -205
- package/.cursor/rules/memento-memory-rule.mdc +0 -8
- package/.cursor/rules/memento-project-overview.mdc +0 -0
- package/.cursor/rules/memory-algorithms.mdc +0 -502
- package/.cursor/rules/monitoring.mdc +0 -622
- package/.cursor/rules/performance-alerts.mdc +0 -537
- package/.cursor/rules/performance-monitoring.mdc +0 -345
- package/.cursor/rules/performance-optimization.mdc +0 -563
- package/.cursor/rules/project-structure.mdc +0 -310
- package/.cursor/rules/testing.mdc +0 -473
- package/.dockerignore +0 -15
- package/.eslintrc.json +0 -34
- package/.github/ISSUE_TEMPLATE/bug_report.md +0 -51
- package/.github/ISSUE_TEMPLATE/feature_request.md +0 -45
- package/.github/ISSUE_TEMPLATE/question.md +0 -31
- package/.github/PULL_REQUEST_TEMPLATE.md +0 -97
- package/AGENTS.md +0 -28
- package/CHANGELOG.md +0 -416
- package/CODE_OF_CONDUCT.md +0 -62
- package/CONTRIBUTING.md +0 -165
- package/DOCKER_SETUP_GUIDE.md +0 -84
- package/Dockerfile +0 -90
- package/backup/legacy-removal-20250930-201816/http-server-legacy.ts +0 -1068
- package/backup/legacy-removal-20250930-201816/rollback-to-legacy.ps1 +0 -46
- package/backup/legacy-removal-20250930-201816/rollback-to-legacy.sh +0 -48
- package/dist/server/index-backup.d.ts +0 -5
- package/dist/server/index-backup.d.ts.map +0 -1
- package/dist/server/index-backup.js +0 -793
- package/dist/server/index-backup.js.map +0 -1
- package/dist/server/index-refactored.d.ts +0 -6
- package/dist/server/index-refactored.d.ts.map +0 -1
- package/dist/server/index-refactored.js +0 -206
- package/dist/server/index-refactored.js.map +0 -1
- package/dist/services/performance-monitoring-integration.d.ts +0 -77
- package/dist/services/performance-monitoring-integration.d.ts.map +0 -1
- package/dist/services/performance-monitoring-integration.js +0 -177
- package/dist/services/performance-monitoring-integration.js.map +0 -1
- package/dist/test/debug-http-v2.d.ts +0 -5
- package/dist/test/debug-http-v2.d.ts.map +0 -1
- package/dist/test/debug-http-v2.js +0 -28
- package/dist/test/debug-http-v2.js.map +0 -1
- package/dist/test/performance-benchmark.d.ts +0 -57
- package/dist/test/performance-benchmark.d.ts.map +0 -1
- package/dist/test/performance-benchmark.js +0 -427
- package/dist/test/performance-benchmark.js.map +0 -1
- package/dist/test/test-alerts-direct.d.ts +0 -7
- package/dist/test/test-alerts-direct.d.ts.map +0 -1
- package/dist/test/test-alerts-direct.js +0 -101
- package/dist/test/test-alerts-direct.js.map +0 -1
- package/dist/test/test-batch-scheduler.d.ts +0 -2
- package/dist/test/test-batch-scheduler.d.ts.map +0 -1
- package/dist/test/test-batch-scheduler.js +0 -156
- package/dist/test/test-batch-scheduler.js.map +0 -1
- package/dist/test/test-client.d.ts +0 -5
- package/dist/test/test-client.d.ts.map +0 -1
- package/dist/test/test-client.js +0 -86
- package/dist/test/test-client.js.map +0 -1
- package/dist/test/test-embedding.d.ts +0 -6
- package/dist/test/test-embedding.d.ts.map +0 -1
- package/dist/test/test-embedding.js +0 -142
- package/dist/test/test-embedding.js.map +0 -1
- package/dist/test/test-error-logging.d.ts +0 -7
- package/dist/test/test-error-logging.d.ts.map +0 -1
- package/dist/test/test-error-logging.js +0 -105
- package/dist/test/test-error-logging.js.map +0 -1
- package/dist/test/test-forgetting.d.ts +0 -6
- package/dist/test/test-forgetting.d.ts.map +0 -1
- package/dist/test/test-forgetting.js +0 -154
- package/dist/test/test-forgetting.js.map +0 -1
- package/dist/test/test-gemini-embedding.d.ts +0 -7
- package/dist/test/test-gemini-embedding.d.ts.map +0 -1
- package/dist/test/test-gemini-embedding.js +0 -134
- package/dist/test/test-gemini-embedding.js.map +0 -1
- package/dist/test/test-http-server-v2-simple.d.ts +0 -6
- package/dist/test/test-http-server-v2-simple.d.ts.map +0 -1
- package/dist/test/test-http-server-v2-simple.js +0 -131
- package/dist/test/test-http-server-v2-simple.js.map +0 -1
- package/dist/test/test-http-server-v2.d.ts +0 -7
- package/dist/test/test-http-server-v2.d.ts.map +0 -1
- package/dist/test/test-http-server-v2.js +0 -529
- package/dist/test/test-http-server-v2.js.map +0 -1
- package/dist/test/test-lightweight-embedding.d.ts +0 -6
- package/dist/test/test-lightweight-embedding.d.ts.map +0 -1
- package/dist/test/test-lightweight-embedding.js +0 -189
- package/dist/test/test-lightweight-embedding.js.map +0 -1
- package/dist/test/test-m1-completion.d.ts +0 -7
- package/dist/test/test-m1-completion.d.ts.map +0 -1
- package/dist/test/test-m1-completion.js +0 -124
- package/dist/test/test-m1-completion.js.map +0 -1
- package/dist/test/test-memory-injection-prompt.d.ts +0 -2
- package/dist/test/test-memory-injection-prompt.d.ts.map +0 -1
- package/dist/test/test-memory-injection-prompt.js +0 -299
- package/dist/test/test-memory-injection-prompt.js.map +0 -1
- package/dist/test/test-performance-alerts.d.ts +0 -7
- package/dist/test/test-performance-alerts.d.ts.map +0 -1
- package/dist/test/test-performance-alerts.js +0 -109
- package/dist/test/test-performance-alerts.js.map +0 -1
- package/dist/test/test-performance-monitor.d.ts +0 -2
- package/dist/test/test-performance-monitor.d.ts.map +0 -1
- package/dist/test/test-performance-monitor.js +0 -182
- package/dist/test/test-performance-monitor.js.map +0 -1
- package/dist/test/test-performance-monitoring.d.ts +0 -6
- package/dist/test/test-performance-monitoring.d.ts.map +0 -1
- package/dist/test/test-performance-monitoring.js +0 -156
- package/dist/test/test-performance-monitoring.js.map +0 -1
- package/dist/test/test-search.d.ts +0 -5
- package/dist/test/test-search.d.ts.map +0 -1
- package/dist/test/test-search.js +0 -141
- package/dist/test/test-search.js.map +0 -1
- package/dist/test/test-simple-alerts.d.ts +0 -6
- package/dist/test/test-simple-alerts.d.ts.map +0 -1
- package/dist/test/test-simple-alerts.js +0 -106
- package/dist/test/test-simple-alerts.js.map +0 -1
- package/dist/test/test-vector-search-engine.d.ts +0 -2
- package/dist/test/test-vector-search-engine.d.ts.map +0 -1
- package/dist/test/test-vector-search-engine.js +0 -225
- package/dist/test/test-vector-search-engine.js.map +0 -1
- package/docker-compose.dev.yml +0 -50
- package/docker-compose.prod.yml +0 -77
- package/docker-compose.yml +0 -43
- package/docs/en/Memento-Goals.md +0 -217
- package/docs/en/Memento-M1-DetailSpecs.md +0 -130
- package/docs/en/Memento-Milestones.md +0 -135
- package/docs/en/Search-Ranking-Memory-Decay-Formulas.md +0 -177
- package/docs/en/api-reference.md +0 -658
- package/docs/en/architecture.md +0 -1302
- package/docs/en/developer-guide.md +0 -1005
- package/docs/en/user-manual.md +0 -595
- package/docs/ko/Memento-Goals.md +0 -217
- package/docs/ko/Memento-M1-DetailSpecs.md +0 -130
- package/docs/ko/Memento-Milestones.md +0 -134
- package/docs/ko/Search-Ranking-Memory-Decay-Formulas.md +0 -177
- package/docs/ko/api-reference.md +0 -658
- package/docs/ko/architecture.md +0 -1302
- package/docs/ko/developer-guide.md +0 -1006
- package/docs/ko/embedding-api-reference.md +0 -122
- package/docs/ko/embedding-configuration.md +0 -62
- package/docs/ko/embedding-performance-benchmark.md +0 -62
- package/docs/ko/embedding-service-guide.md +0 -314
- package/docs/ko/user-manual.md +0 -595
- package/env.example +0 -49
- package/install.sh +0 -191
- package/mcp-http-client.js +0 -218
- package/mcp.json +0 -0
- package/packages/mcp-client/docs/API-REFERENCE.md +0 -560
- package/packages/mcp-client/docs/BEST-PRACTICES.md +0 -564
- package/packages/mcp-client/docs/MIGRATION-GUIDE.md +0 -344
- package/packages/mcp-client/docs/PERFORMANCE-GUIDE.md +0 -476
- package/packages/mcp-client/docs/TROUBLESHOOTING.md +0 -564
- package/packages/mcp-client/package-lock.json +0 -907
- package/packages/mcp-client/package.json +0 -58
- package/packages/mcp-client/performance-optimizer.js +0 -428
- package/packages/mcp-client/test-basic.js +0 -65
- package/packages/mcp-client/test-integration.js +0 -366
- package/src/algorithms/forgetting-algorithm.spec.ts +0 -538
- package/src/algorithms/forgetting-algorithm.ts +0 -243
- package/src/algorithms/hybrid-search-engine.spec.ts +0 -484
- package/src/algorithms/hybrid-search-engine.ts +0 -489
- package/src/algorithms/search-engine.spec.ts +0 -429
- package/src/algorithms/search-engine.ts +0 -392
- package/src/algorithms/search-ranking.spec.ts +0 -293
- package/src/algorithms/search-ranking.ts +0 -407
- package/src/algorithms/spaced-repetition.spec.ts +0 -510
- package/src/algorithms/spaced-repetition.ts +0 -238
- package/src/algorithms/vector-search-engine.ts +0 -505
- package/src/client/index.spec.ts +0 -427
- package/src/client/index.ts +0 -222
- package/src/config/index.spec.ts +0 -339
- package/src/config/index.ts +0 -106
- package/src/database/init.spec.ts +0 -239
- package/src/database/init.ts +0 -130
- package/src/database/migrate.spec.ts +0 -293
- package/src/database/migrate.ts +0 -94
- package/src/database/migrations/001_add_embedding_metadata.sql +0 -29
- package/src/npm-client/context-injector.spec.ts +0 -335
- package/src/npm-client/context-injector.ts +0 -412
- package/src/npm-client/index.spec.ts +0 -108
- package/src/npm-client/index.ts +0 -96
- package/src/npm-client/memento-client.spec.ts +0 -549
- package/src/npm-client/memento-client.ts +0 -501
- package/src/npm-client/memory-manager.spec.ts +0 -374
- package/src/npm-client/memory-manager.ts +0 -414
- package/src/npm-client/types.spec.ts +0 -427
- package/src/npm-client/types.ts +0 -296
- package/src/npm-client/utils.spec.ts +0 -355
- package/src/npm-client/utils.ts +0 -423
- package/src/scripts/copy-assets.js +0 -37
- package/src/server/http-server.spec.ts +0 -648
- package/src/server/http-server.ts +0 -1030
- package/src/server/index-backup.ts +0 -875
- package/src/server/index-refactored.ts +0 -237
- package/src/server/index.spec.ts +0 -281
- package/src/server/index.ts +0 -347
- package/src/server/simple-mcp-server.spec.ts +0 -207
- package/src/server/simple-mcp-server.ts +0 -173
- package/src/services/async-optimizer.spec.ts +0 -569
- package/src/services/async-optimizer.ts +0 -484
- package/src/services/batch-scheduler.ts +0 -759
- package/src/services/cache-service.spec.ts +0 -372
- package/src/services/cache-service.ts +0 -434
- package/src/services/database-optimizer.spec.ts +0 -344
- package/src/services/database-optimizer.ts +0 -450
- package/src/services/embedding-provider-factory.ts +0 -173
- package/src/services/embedding-service.spec.ts +0 -342
- package/src/services/embedding-service.ts +0 -333
- package/src/services/error-logging-service.spec.ts +0 -416
- package/src/services/error-logging-service.ts +0 -383
- package/src/services/forgetting-policy-service.spec.ts +0 -140
- package/src/services/forgetting-policy-service.ts +0 -334
- package/src/services/gemini-embedding-service.spec.ts +0 -463
- package/src/services/gemini-embedding-service.ts +0 -283
- package/src/services/lightweight-embedding-service.spec.ts +0 -458
- package/src/services/lightweight-embedding-service.ts +0 -324
- package/src/services/memory-embedding-service.spec.ts +0 -417
- package/src/services/memory-embedding-service.ts +0 -289
- package/src/services/minilm-embedding-service.spec.ts +0 -104
- package/src/services/minilm-embedding-service.ts +0 -262
- package/src/services/performance-alert-service.spec.ts +0 -517
- package/src/services/performance-alert-service.ts +0 -477
- package/src/services/performance-monitor.spec.ts +0 -401
- package/src/services/performance-monitor.ts +0 -532
- package/src/services/performance-monitoring-integration.spec.ts +0 -478
- package/src/services/performance-monitoring-integration.ts.bak +0 -276
- package/src/services/unified-embedding-service.spec.ts +0 -224
- package/src/services/unified-embedding-service.ts +0 -255
- package/src/test/debug-http-v2.ts +0 -30
- package/src/test/embedding-integration-test.spec.ts +0 -295
- package/src/test/embedding-integration-test.ts +0 -295
- package/src/test/embedding-performance-benchmark.spec.ts +0 -354
- package/src/test/embedding-performance-benchmark.ts +0 -312
- package/src/test/performance-benchmark.ts +0 -565
- package/src/test/test-alerts-direct.ts +0 -136
- package/src/test/test-batch-scheduler-simple.spec.ts +0 -122
- package/src/test/test-batch-scheduler.spec.ts +0 -453
- package/src/test/test-batch-scheduler.ts +0 -182
- package/src/test/test-client.ts +0 -97
- package/src/test/test-embedding.ts +0 -153
- package/src/test/test-error-handling.spec.ts +0 -575
- package/src/test/test-error-logging.ts +0 -117
- package/src/test/test-forgetting.ts +0 -162
- package/src/test/test-gemini-embedding.ts +0 -159
- package/src/test/test-http-server-v2-simple.ts +0 -147
- package/src/test/test-http-server-v2.ts +0 -586
- package/src/test/test-hybrid-search-engine.spec.ts +0 -521
- package/src/test/test-integration-fixed.spec.ts +0 -612
- package/src/test/test-integration.spec.ts +0 -463
- package/src/test/test-lightweight-embedding.ts +0 -208
- package/src/test/test-m1-completion.spec.ts +0 -614
- package/src/test/test-m1-completion.ts +0 -141
- package/src/test/test-m1-integration.spec.ts +0 -514
- package/src/test/test-memory-injection-prompt.spec.ts +0 -650
- package/src/test/test-memory-injection-prompt.ts +0 -391
- package/src/test/test-performance-alerts.ts +0 -125
- package/src/test/test-performance-monitor-updates.spec.ts +0 -490
- package/src/test/test-performance-monitor.spec.ts +0 -284
- package/src/test/test-performance-monitor.ts +0 -228
- package/src/test/test-performance-monitoring.ts +0 -171
- package/src/test/test-search.ts +0 -151
- package/src/test/test-simple-alerts.ts +0 -136
- package/src/test/test-vector-search-engine.spec.ts +0 -408
- package/src/test/test-vector-search-engine.ts +0 -303
- package/src/tools/base-tool.ts +0 -189
- package/src/tools/cleanup-memory-tool.ts +0 -77
- package/src/tools/database-optimize-tool.ts +0 -79
- package/src/tools/error-stats.ts +0 -119
- package/src/tools/forget-tool.spec.ts +0 -613
- package/src/tools/forget-tool.ts +0 -454
- package/src/tools/forgetting-stats-tool.ts +0 -47
- package/src/tools/index.ts +0 -71
- package/src/tools/memory-injection-prompt.ts +0 -257
- package/src/tools/performance-alerts.ts +0 -226
- package/src/tools/performance-stats-tool.ts +0 -48
- package/src/tools/pin-tool.spec.ts +0 -497
- package/src/tools/pin-tool.ts +0 -277
- package/src/tools/recall-tool.spec.ts +0 -475
- package/src/tools/recall-tool.ts +0 -389
- package/src/tools/remember-tool.spec.ts +0 -469
- package/src/tools/remember-tool.ts +0 -112
- package/src/tools/resolve-error.ts +0 -69
- package/src/tools/tool-registry.ts +0 -417
- package/src/tools/types.ts +0 -63
- package/src/tools/unpin-tool.spec.ts +0 -549
- package/src/tools/unpin-tool.ts +0 -306
- package/src/types/embedding.types.ts +0 -78
- package/src/types/index.spec.ts +0 -420
- package/src/types/index.ts +0 -117
- package/src/utils/database.spec.ts +0 -77
- package/src/utils/database.ts +0 -458
- package/src/utils/stopwords.ts +0 -128
- package/start-docker-setup.bat +0 -38
- package/static/logo.png +0 -0
- package/static/memento_logo.svg +0 -2
- package/test-docker.js +0 -103
- package/tsconfig.json +0 -46
- package/vitest.config.ts +0 -23
|
@@ -1,1006 +0,0 @@
|
|
|
1
|
-
# 개발자 가이드
|
|
2
|
-
|
|
3
|
-
## 개요
|
|
4
|
-
|
|
5
|
-
이 가이드는 Memento MCP Server의 개발 환경 설정, 아키텍처 이해, 기여 방법을 설명합니다.
|
|
6
|
-
|
|
7
|
-
## 목차
|
|
8
|
-
|
|
9
|
-
1. [개발 환경 설정](#개발-환경-설정)
|
|
10
|
-
2. [프로젝트 구조](#프로젝트-구조)
|
|
11
|
-
3. [아키텍처 이해](#아키텍처-이해)
|
|
12
|
-
4. [개발 워크플로우](#개발-워크플로우)
|
|
13
|
-
5. [테스트 작성](#테스트-작성)
|
|
14
|
-
6. [기여 방법](#기여-방법)
|
|
15
|
-
|
|
16
|
-
## 개발 환경 설정
|
|
17
|
-
|
|
18
|
-
### 필수 요구사항
|
|
19
|
-
|
|
20
|
-
- **Node.js**: 20.0.0 이상 (package.json 기준)
|
|
21
|
-
- **npm**: 10.0.0 이상
|
|
22
|
-
|
|
23
|
-
### 저장소 가이드라인 (`AGENTS.md`)
|
|
24
|
-
|
|
25
|
-
프로젝트에는 개발자 가이드라인이 포함되어 있습니다:
|
|
26
|
-
|
|
27
|
-
- **프로젝트 구조**: `src/` 하위 모듈별 조직화
|
|
28
|
-
- **빌드/테스트 명령어**: `npm run dev`, `npm run build`, `npm run test` 등
|
|
29
|
-
- **코딩 스타일**: Node.js ≥ 20, TypeScript ES 모듈, 2칸 들여쓰기
|
|
30
|
-
- **테스트 가이드라인**: Vitest 기반, `src/test/` 또는 `*.spec.ts` 파일
|
|
31
|
-
- **커밋/PR 가이드라인**: Conventional Commits, 한국어 컨텍스트 포함
|
|
32
|
-
- **환경/데이터베이스**: `.env` 설정, `data/` 폴더 관리
|
|
33
|
-
- **TypeScript**: 5.3.0 (실제 구현 기준)
|
|
34
|
-
- **Git**: 2.30.0 이상
|
|
35
|
-
|
|
36
|
-
### 개발 도구
|
|
37
|
-
|
|
38
|
-
- **IDE**: VS Code (권장)
|
|
39
|
-
- **확장 프로그램**:
|
|
40
|
-
- TypeScript and JavaScript Language Features
|
|
41
|
-
- ESLint
|
|
42
|
-
- Prettier
|
|
43
|
-
- Vitest (실제 사용)
|
|
44
|
-
- GitLens
|
|
45
|
-
|
|
46
|
-
### 환경 설정
|
|
47
|
-
|
|
48
|
-
#### 1. 저장소 클론
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
git clone https://github.com/your-org/memento.git
|
|
52
|
-
cd memento
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
#### 2. 의존성 설치
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
# 모든 의존성 설치 (package.json 기준)
|
|
59
|
-
npm install
|
|
60
|
-
|
|
61
|
-
# 실제 사용된 의존성들:
|
|
62
|
-
# - @modelcontextprotocol/sdk: ^0.5.0
|
|
63
|
-
# - better-sqlite3: ^12.4.1
|
|
64
|
-
# - express: ^5.1.0
|
|
65
|
-
# - cors: ^2.8.5
|
|
66
|
-
# - ws: ^8.18.3
|
|
67
|
-
# - zod: ^3.22.4
|
|
68
|
-
# - uuid: ^9.0.1
|
|
69
|
-
# - openai: ^4.20.1
|
|
70
|
-
# - dotenv: ^16.3.1
|
|
71
|
-
# - vitest: ^1.0.0 (테스트)
|
|
72
|
-
# - tsx: ^4.6.0 (개발)
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
#### 3. 환경 변수 설정
|
|
76
|
-
|
|
77
|
-
```bash
|
|
78
|
-
# 환경 변수 파일 복사
|
|
79
|
-
cp .env.example .env
|
|
80
|
-
|
|
81
|
-
# 환경 변수 편집
|
|
82
|
-
# .env 파일을 편집하여 필요한 설정을 입력하세요
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
#### 4. 데이터베이스 초기화
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
# better-sqlite3 데이터베이스 초기화
|
|
89
|
-
npm run db:init
|
|
90
|
-
|
|
91
|
-
# 데이터베이스 마이그레이션
|
|
92
|
-
npm run db:migrate
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
#### 5. 개발 서버 시작
|
|
96
|
-
|
|
97
|
-
```bash
|
|
98
|
-
# MCP 서버 개발 모드 (핫 리로드)
|
|
99
|
-
npm run dev
|
|
100
|
-
|
|
101
|
-
# HTTP/WebSocket 서버 개발 모드
|
|
102
|
-
npm run dev:http
|
|
103
|
-
|
|
104
|
-
# 별도 터미널에서 테스트 실행
|
|
105
|
-
npm run test -- --watch
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### VS Code 설정
|
|
109
|
-
|
|
110
|
-
#### .vscode/settings.json
|
|
111
|
-
|
|
112
|
-
```json
|
|
113
|
-
{
|
|
114
|
-
"typescript.preferences.importModuleSpecifier": "relative",
|
|
115
|
-
"editor.formatOnSave": true,
|
|
116
|
-
"editor.codeActionsOnSave": {
|
|
117
|
-
"source.fixAll.eslint": true
|
|
118
|
-
},
|
|
119
|
-
"vitest.commandLine": "npm run test",
|
|
120
|
-
"vitest.autoRun": "watch"
|
|
121
|
-
}
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
#### .vscode/launch.json
|
|
125
|
-
|
|
126
|
-
```json
|
|
127
|
-
{
|
|
128
|
-
"version": "0.2.0",
|
|
129
|
-
"configurations": [
|
|
130
|
-
{
|
|
131
|
-
"name": "Debug MCP Server",
|
|
132
|
-
"type": "node",
|
|
133
|
-
"request": "launch",
|
|
134
|
-
"program": "${workspaceFolder}/src/server/index.ts",
|
|
135
|
-
"outFiles": ["${workspaceFolder}/dist/**/*.js"],
|
|
136
|
-
"env": {
|
|
137
|
-
"NODE_ENV": "development"
|
|
138
|
-
},
|
|
139
|
-
"console": "integratedTerminal"
|
|
140
|
-
},
|
|
141
|
-
{
|
|
142
|
-
"name": "Debug Tests",
|
|
143
|
-
"type": "node",
|
|
144
|
-
"request": "launch",
|
|
145
|
-
"program": "${workspaceFolder}/node_modules/.bin/vitest",
|
|
146
|
-
"args": ["--run"],
|
|
147
|
-
"console": "integratedTerminal",
|
|
148
|
-
"internalConsoleOptions": "neverOpen"
|
|
149
|
-
}
|
|
150
|
-
]
|
|
151
|
-
}
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
## 프로젝트 구조
|
|
155
|
-
|
|
156
|
-
### 새로운 서비스 레이어 (`src/services/`)
|
|
157
|
-
|
|
158
|
-
Memento는 새로운 서비스 레이어를 도입하여 외부 API 연동과 복잡한 비즈니스 로직을 분리했습니다.
|
|
159
|
-
|
|
160
|
-
```
|
|
161
|
-
src/services/
|
|
162
|
-
├── embedding-service.ts # OpenAI 임베딩 서비스 (196줄)
|
|
163
|
-
├── memory-embedding-service.ts # 메모리 임베딩 서비스 (237줄)
|
|
164
|
-
├── lightweight-embedding-service.ts # 경량 하이브리드 임베딩 서비스 (321줄)
|
|
165
|
-
├── forgetting-policy-service.ts # 망각 정책 서비스 (335줄)
|
|
166
|
-
├── async-optimizer.ts # 비동기 처리 최적화 (447줄)
|
|
167
|
-
├── cache-service.ts # 캐시 서비스 (352줄)
|
|
168
|
-
├── database-optimizer.ts # 데이터베이스 최적화 (442줄)
|
|
169
|
-
└── performance-monitor.ts # 성능 모니터링 (367줄)
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
**서비스 레이어의 역할**:
|
|
173
|
-
- **외부 API 연동**: OpenAI API, 데이터베이스 연동
|
|
174
|
-
- **비즈니스 로직**: 임베딩 생성, 벡터 검색, 유사도 계산
|
|
175
|
-
- **에러 처리**: API 호출 실패, 재시도 로직
|
|
176
|
-
- **캐싱**: 임베딩 결과 캐싱, 성능 최적화
|
|
177
|
-
- **Fallback 솔루션**: 경량 하이브리드 임베딩 서비스로 OpenAI API 대체
|
|
178
|
-
- **성능 최적화**: 비동기 처리, 캐시 관리, 데이터베이스 최적화
|
|
179
|
-
- **모니터링**: 실시간 성능 메트릭 수집 및 분석
|
|
180
|
-
|
|
181
|
-
### 하이브리드 검색 엔진 (`src/algorithms/hybrid-search-engine.ts`)
|
|
182
|
-
|
|
183
|
-
기존 검색 엔진에 하이브리드 검색 기능이 추가되었습니다.
|
|
184
|
-
|
|
185
|
-
```
|
|
186
|
-
src/algorithms/
|
|
187
|
-
├── search-engine.ts # 기본 검색 엔진 (233줄)
|
|
188
|
-
├── hybrid-search-engine.ts # 하이브리드 검색 엔진 (200줄)
|
|
189
|
-
└── search-ranking.ts # 검색 랭킹 알고리즘
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
**하이브리드 검색의 특징**:
|
|
193
|
-
- **FTS5 + 벡터 검색**: 텍스트 검색과 벡터 검색 결합
|
|
194
|
-
- **가중치 조정**: 벡터 60%, 텍스트 40% (기본값)
|
|
195
|
-
- **점수 정규화**: 0-1 범위로 점수 정규화
|
|
196
|
-
- **결과 결합**: 두 검색 결과를 통합한 최종 점수
|
|
197
|
-
|
|
198
|
-
### 전체 프로젝트 구조
|
|
199
|
-
|
|
200
|
-
```
|
|
201
|
-
memento/
|
|
202
|
-
├── src/ # 소스 코드
|
|
203
|
-
│ ├── server/ # MCP 서버
|
|
204
|
-
│ │ ├── index.ts # 서버 진입점 (521줄)
|
|
205
|
-
│ │ ├── tools/ # MCP Tools 구현
|
|
206
|
-
│ │ │ ├── remember.ts # remember 도구
|
|
207
|
-
│ │ │ ├── recall.ts # recall 도구
|
|
208
|
-
│ │ │ ├── pin.ts # pin/unpin 도구
|
|
209
|
-
│ │ │ ├── forget.ts # forget 도구
|
|
210
|
-
│ │ │ ├── summarize-thread.ts
|
|
211
|
-
│ │ │ ├── link.ts # link 도구
|
|
212
|
-
│ │ │ ├── export.ts # export 도구
|
|
213
|
-
│ │ │ ├── feedback.ts # feedback 도구
|
|
214
|
-
│ │ │ └── index.ts # 도구 내보내기
|
|
215
|
-
│ │ ├── resources/ # MCP Resources 구현
|
|
216
|
-
│ │ │ ├── memory.ts # memory/{id} 리소스
|
|
217
|
-
│ │ │ ├── search.ts # memory/search 리소스
|
|
218
|
-
│ │ │ └── index.ts
|
|
219
|
-
│ │ ├── prompts/ # MCP Prompts 구현
|
|
220
|
-
│ │ │ ├── memory-injection.ts
|
|
221
|
-
│ │ │ └── index.ts
|
|
222
|
-
│ │ ├── database/ # 데이터베이스 관련
|
|
223
|
-
│ │ │ ├── sqlite.ts # SQLite 구현
|
|
224
|
-
│ │ │ ├── postgres.ts # PostgreSQL 구현
|
|
225
|
-
│ │ │ ├── migrations/ # 마이그레이션
|
|
226
|
-
│ │ │ └── index.ts
|
|
227
|
-
│ │ └── middleware/ # 미들웨어
|
|
228
|
-
│ │ ├── auth.ts # 인증 미들웨어
|
|
229
|
-
│ │ ├── logging.ts # 로깅 미들웨어
|
|
230
|
-
│ │ └── error.ts # 에러 처리 미들웨어
|
|
231
|
-
│ ├── client/ # MCP 클라이언트
|
|
232
|
-
│ │ ├── index.ts # 클라이언트 진입점
|
|
233
|
-
│ │ ├── memory-manager.ts # 메모리 관리자
|
|
234
|
-
│ │ ├── mcp-client.ts # MCP 클라이언트 래퍼
|
|
235
|
-
│ │ └── types.ts # 클라이언트 타입
|
|
236
|
-
│ ├── algorithms/ # 검색 및 망각 알고리즘
|
|
237
|
-
│ │ ├── search-ranking.ts # 검색 랭킹 알고리즘
|
|
238
|
-
│ │ ├── forgetting.ts # 망각 알고리즘
|
|
239
|
-
│ │ ├── spaced-review.ts # 간격 반복 알고리즘
|
|
240
|
-
│ │ └── index.ts
|
|
241
|
-
│ └── shared/ # 공통 유틸리티
|
|
242
|
-
│ ├── types.ts # 공통 타입 정의
|
|
243
|
-
│ ├── utils.ts # 유틸리티 함수
|
|
244
|
-
│ ├── constants.ts # 상수 정의
|
|
245
|
-
│ └── validation.ts # 검증 함수
|
|
246
|
-
├── src/ # 소스 코드
|
|
247
|
-
│ ├── algorithms/ # 알고리즘 모듈
|
|
248
|
-
│ │ ├── search-engine.ts
|
|
249
|
-
│ │ ├── search-engine.spec.ts # 단위 테스트
|
|
250
|
-
│ │ ├── forgetting-algorithm.ts
|
|
251
|
-
│ │ └── forgetting-algorithm.spec.ts # 단위 테스트
|
|
252
|
-
│ ├── services/ # 서비스 모듈
|
|
253
|
-
│ │ ├── embedding-service.ts
|
|
254
|
-
│ │ └── forgetting-policy-service.spec.ts # 단위 테스트
|
|
255
|
-
│ ├── test/ # E2E 테스트
|
|
256
|
-
│ │ ├── test-client.ts # 클라이언트 E2E 테스트
|
|
257
|
-
│ │ ├── test-search.ts # 검색 E2E 테스트
|
|
258
|
-
│ │ └── test-embedding.ts # 임베딩 E2E 테스트
|
|
259
|
-
│ └── fixtures/ # 테스트 데이터 (필요시)
|
|
260
|
-
│ └── test-data.json # 샘플 테스트 데이터
|
|
261
|
-
├── docs/ # 문서
|
|
262
|
-
├── scripts/ # 빌드 및 배포 스크립트
|
|
263
|
-
│ ├── build.js # 빌드 스크립트
|
|
264
|
-
│ ├── deploy.js # 배포 스크립트
|
|
265
|
-
│ └── db-migrate.js # 데이터베이스 마이그레이션
|
|
266
|
-
├── docker/ # Docker 관련 파일
|
|
267
|
-
│ ├── Dockerfile # M1 Dockerfile
|
|
268
|
-
│ ├── Dockerfile.m3 # M3 Dockerfile
|
|
269
|
-
│ ├── docker-compose.dev.yml # 개발 환경
|
|
270
|
-
│ ├── docker-compose.team.yml # 팀 환경
|
|
271
|
-
│ └── docker-compose.org.yml # 조직 환경
|
|
272
|
-
├── .cursor/rules/ # Cursor 개발 규칙
|
|
273
|
-
├── .github/ # GitHub Actions
|
|
274
|
-
│ └── workflows/
|
|
275
|
-
│ ├── ci.yml # CI 파이프라인
|
|
276
|
-
│ ├── test.yml # 테스트 파이프라인
|
|
277
|
-
│ └── deploy.yml # 배포 파이프라인
|
|
278
|
-
├── package.json # 프로젝트 설정
|
|
279
|
-
├── tsconfig.json # TypeScript 설정
|
|
280
|
-
├── jest.config.js # Jest 설정
|
|
281
|
-
├── .eslintrc.js # ESLint 설정
|
|
282
|
-
├── .prettierrc # Prettier 설정
|
|
283
|
-
└── README.md # 프로젝트 문서
|
|
284
|
-
```
|
|
285
|
-
|
|
286
|
-
## 아키텍처 이해
|
|
287
|
-
|
|
288
|
-
### 전체 아키텍처
|
|
289
|
-
|
|
290
|
-
```mermaid
|
|
291
|
-
graph TB
|
|
292
|
-
subgraph "AI Agent Layer"
|
|
293
|
-
A[Claude Desktop] --> B[MCP Client]
|
|
294
|
-
C[ChatGPT] --> B
|
|
295
|
-
D[Cursor] --> B
|
|
296
|
-
end
|
|
297
|
-
|
|
298
|
-
subgraph "MCP Protocol Layer"
|
|
299
|
-
B --> E[MCP Memory Server]
|
|
300
|
-
end
|
|
301
|
-
|
|
302
|
-
subgraph "Memory Management Layer"
|
|
303
|
-
E --> F[Memory Manager]
|
|
304
|
-
E --> G[Search Engine]
|
|
305
|
-
E --> H[Forgetting Policy]
|
|
306
|
-
end
|
|
307
|
-
|
|
308
|
-
subgraph "Storage Layer"
|
|
309
|
-
F --> I[SQLite M1]
|
|
310
|
-
F --> J[PostgreSQL M3+]
|
|
311
|
-
G --> K[Vector Search]
|
|
312
|
-
G --> L[Text Search]
|
|
313
|
-
end
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
### 핵심 컴포넌트
|
|
317
|
-
|
|
318
|
-
#### 1. MCP 서버 (`src/server/`)
|
|
319
|
-
|
|
320
|
-
MCP 프로토콜을 구현하는 핵심 서버입니다.
|
|
321
|
-
|
|
322
|
-
**주요 파일**:
|
|
323
|
-
- `index.ts`: 서버 진입점, MCP 서버 초기화
|
|
324
|
-
- `tools/`: MCP Tools 구현
|
|
325
|
-
- `resources/`: MCP Resources 구현
|
|
326
|
-
- `prompts/`: MCP Prompts 구현
|
|
327
|
-
|
|
328
|
-
**예시 코드**:
|
|
329
|
-
```typescript
|
|
330
|
-
// src/server/index.ts
|
|
331
|
-
import { Server } from '@modelcontextprotocol/sdk/server';
|
|
332
|
-
import { rememberTool } from './tools/remember';
|
|
333
|
-
import { recallTool } from './tools/recall';
|
|
334
|
-
|
|
335
|
-
const server = new Server({
|
|
336
|
-
name: 'memento-memory-server',
|
|
337
|
-
version: '0.1.0'
|
|
338
|
-
});
|
|
339
|
-
|
|
340
|
-
// Tools 등록
|
|
341
|
-
server.tool('remember', rememberTool);
|
|
342
|
-
server.tool('recall', recallTool);
|
|
343
|
-
|
|
344
|
-
// 서버 시작
|
|
345
|
-
server.start();
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
#### 2. 검색 엔진 (`src/algorithms/`)
|
|
349
|
-
|
|
350
|
-
기억 검색을 위한 알고리즘을 구현합니다.
|
|
351
|
-
|
|
352
|
-
**주요 파일**:
|
|
353
|
-
- `search-ranking.ts`: 검색 랭킹 알고리즘
|
|
354
|
-
- `forgetting.ts`: 망각 알고리즘
|
|
355
|
-
- `spaced-review.ts`: 간격 반복 알고리즘
|
|
356
|
-
|
|
357
|
-
**예시 코드**:
|
|
358
|
-
```typescript
|
|
359
|
-
// src/algorithms/search-ranking.ts
|
|
360
|
-
export class SearchRanking {
|
|
361
|
-
calculateFinalScore(features: SearchFeatures): number {
|
|
362
|
-
return this.ALPHA * features.relevance +
|
|
363
|
-
this.BETA * features.recency +
|
|
364
|
-
this.GAMMA * features.importance +
|
|
365
|
-
this.DELTA * features.usage -
|
|
366
|
-
this.EPSILON * features.duplication_penalty;
|
|
367
|
-
}
|
|
368
|
-
}
|
|
369
|
-
```
|
|
370
|
-
|
|
371
|
-
#### 3. 데이터베이스 레이어 (`src/server/database/`)
|
|
372
|
-
|
|
373
|
-
데이터 저장 및 검색을 담당합니다.
|
|
374
|
-
|
|
375
|
-
**주요 파일**:
|
|
376
|
-
- `sqlite.ts`: SQLite 구현 (M1)
|
|
377
|
-
- `postgres.ts`: PostgreSQL 구현 (M3+)
|
|
378
|
-
- `migrations/`: 데이터베이스 마이그레이션
|
|
379
|
-
|
|
380
|
-
### 데이터 플로우
|
|
381
|
-
|
|
382
|
-
#### 1. 기억 저장 플로우
|
|
383
|
-
|
|
384
|
-
```
|
|
385
|
-
AI Agent → MCP Client → MCP Server → Memory Manager → Database
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
#### 2. 기억 검색 플로우
|
|
389
|
-
|
|
390
|
-
```
|
|
391
|
-
AI Agent → MCP Client → MCP Server → Search Engine → Database → Ranking → Results
|
|
392
|
-
```
|
|
393
|
-
|
|
394
|
-
## 개발 워크플로우
|
|
395
|
-
|
|
396
|
-
### 1. 기능 개발
|
|
397
|
-
|
|
398
|
-
#### 브랜치 생성
|
|
399
|
-
|
|
400
|
-
```bash
|
|
401
|
-
# 기능 브랜치 생성
|
|
402
|
-
git checkout -b feature/new-tool
|
|
403
|
-
|
|
404
|
-
# 또는 버그 수정 브랜치
|
|
405
|
-
git checkout -b fix/memory-leak
|
|
406
|
-
```
|
|
407
|
-
|
|
408
|
-
#### 개발 진행
|
|
409
|
-
|
|
410
|
-
```bash
|
|
411
|
-
# 개발 서버 시작
|
|
412
|
-
npm run dev
|
|
413
|
-
|
|
414
|
-
# 테스트 실행 (별도 터미널)
|
|
415
|
-
npm run test:watch
|
|
416
|
-
|
|
417
|
-
# 코드 포맷팅
|
|
418
|
-
npm run format
|
|
419
|
-
|
|
420
|
-
# 린트 검사
|
|
421
|
-
npm run lint
|
|
422
|
-
```
|
|
423
|
-
|
|
424
|
-
#### 커밋
|
|
425
|
-
|
|
426
|
-
```bash
|
|
427
|
-
# 변경사항 스테이징
|
|
428
|
-
git add .
|
|
429
|
-
|
|
430
|
-
# 커밋 (컨벤셔널 커밋 형식)
|
|
431
|
-
git commit -m "feat: add new summarize_thread tool"
|
|
432
|
-
|
|
433
|
-
# 푸시
|
|
434
|
-
git push origin feature/new-tool
|
|
435
|
-
```
|
|
436
|
-
|
|
437
|
-
### 2. 테스트 작성
|
|
438
|
-
|
|
439
|
-
#### 단위 테스트
|
|
440
|
-
|
|
441
|
-
```typescript
|
|
442
|
-
// tests/unit/tools/remember.test.ts
|
|
443
|
-
import { RememberTool } from '@/server/tools/remember';
|
|
444
|
-
import { MockDatabase } from '@/tests/mocks/database.mock';
|
|
445
|
-
|
|
446
|
-
describe('RememberTool', () => {
|
|
447
|
-
let rememberTool: RememberTool;
|
|
448
|
-
let mockDatabase: MockDatabase;
|
|
449
|
-
|
|
450
|
-
beforeEach(() => {
|
|
451
|
-
mockDatabase = new MockDatabase();
|
|
452
|
-
rememberTool = new RememberTool(mockDatabase);
|
|
453
|
-
});
|
|
454
|
-
|
|
455
|
-
it('should create memory with valid parameters', async () => {
|
|
456
|
-
// Given
|
|
457
|
-
const params = {
|
|
458
|
-
content: 'Test memory',
|
|
459
|
-
type: 'episodic',
|
|
460
|
-
importance: 0.8
|
|
461
|
-
};
|
|
462
|
-
|
|
463
|
-
// When
|
|
464
|
-
const result = await rememberTool.execute(params);
|
|
465
|
-
|
|
466
|
-
// Then
|
|
467
|
-
expect(result.memory_id).toBeDefined();
|
|
468
|
-
expect(mockDatabase.createMemory).toHaveBeenCalledWith(
|
|
469
|
-
expect.objectContaining({
|
|
470
|
-
content: 'Test memory',
|
|
471
|
-
type: 'episodic',
|
|
472
|
-
importance: 0.8
|
|
473
|
-
})
|
|
474
|
-
);
|
|
475
|
-
});
|
|
476
|
-
});
|
|
477
|
-
```
|
|
478
|
-
|
|
479
|
-
#### 통합 테스트
|
|
480
|
-
|
|
481
|
-
```typescript
|
|
482
|
-
// tests/integration/mcp-server.test.ts
|
|
483
|
-
import { MCPClient } from '@modelcontextprotocol/sdk';
|
|
484
|
-
import { MCPServer } from '@/server';
|
|
485
|
-
|
|
486
|
-
describe('MCP Server Integration', () => {
|
|
487
|
-
let server: MCPServer;
|
|
488
|
-
let client: MCPClient;
|
|
489
|
-
|
|
490
|
-
beforeAll(async () => {
|
|
491
|
-
server = new MCPServer();
|
|
492
|
-
await server.start();
|
|
493
|
-
|
|
494
|
-
client = new MCPClient({
|
|
495
|
-
name: 'test-client',
|
|
496
|
-
version: '1.0.0'
|
|
497
|
-
});
|
|
498
|
-
await client.connect({
|
|
499
|
-
command: 'node',
|
|
500
|
-
args: ['dist/server/index.js']
|
|
501
|
-
});
|
|
502
|
-
});
|
|
503
|
-
|
|
504
|
-
afterAll(async () => {
|
|
505
|
-
await client.close();
|
|
506
|
-
await server.stop();
|
|
507
|
-
});
|
|
508
|
-
|
|
509
|
-
it('should handle remember and recall workflow', async () => {
|
|
510
|
-
// Remember
|
|
511
|
-
const rememberResult = await client.callTool('remember', {
|
|
512
|
-
content: 'Integration test memory'
|
|
513
|
-
});
|
|
514
|
-
|
|
515
|
-
expect(rememberResult.memory_id).toBeDefined();
|
|
516
|
-
|
|
517
|
-
// Recall
|
|
518
|
-
const recallResult = await client.callTool('recall', {
|
|
519
|
-
query: 'integration test'
|
|
520
|
-
});
|
|
521
|
-
|
|
522
|
-
expect(recallResult.items).toHaveLength(1);
|
|
523
|
-
expect(recallResult.items[0].content).toContain('Integration test memory');
|
|
524
|
-
});
|
|
525
|
-
});
|
|
526
|
-
```
|
|
527
|
-
|
|
528
|
-
### 3. 코드 리뷰
|
|
529
|
-
|
|
530
|
-
#### Pull Request 생성
|
|
531
|
-
|
|
532
|
-
1. GitHub에서 Pull Request 생성
|
|
533
|
-
2. 변경사항 설명 작성
|
|
534
|
-
3. 관련 이슈 연결
|
|
535
|
-
4. 리뷰어 지정
|
|
536
|
-
|
|
537
|
-
#### 리뷰 체크리스트
|
|
538
|
-
|
|
539
|
-
- [ ] 코드가 프로젝트 스타일 가이드를 따르는가?
|
|
540
|
-
- [ ] 테스트가 충분히 작성되었는가?
|
|
541
|
-
- [ ] 문서가 업데이트되었는가?
|
|
542
|
-
- [ ] 성능에 영향을 주는가?
|
|
543
|
-
- [ ] 보안 취약점이 없는가?
|
|
544
|
-
|
|
545
|
-
## 테스트 작성
|
|
546
|
-
|
|
547
|
-
### 테스트 전략
|
|
548
|
-
|
|
549
|
-
#### 1. 단위 테스트 (Unit Tests) - `.spec.ts`
|
|
550
|
-
|
|
551
|
-
- **목적**: 개별 함수/클래스의 동작 검증
|
|
552
|
-
- **범위**: 모든 public 메서드
|
|
553
|
-
- **도구**: Vitest
|
|
554
|
-
- **위치**: 각 모듈 폴더 내부
|
|
555
|
-
- **예시**:
|
|
556
|
-
- `src/algorithms/search-engine.spec.ts`
|
|
557
|
-
- `src/services/forgetting-policy-service.spec.ts`
|
|
558
|
-
- `src/utils/database.spec.ts`
|
|
559
|
-
|
|
560
|
-
#### 2. E2E 테스트 (End-to-End Tests) - `test-*.ts`
|
|
561
|
-
|
|
562
|
-
- **목적**: 전체 워크플로우 검증
|
|
563
|
-
- **범위**: 실제 MCP 서버와의 통신
|
|
564
|
-
- **도구**: tsx + MCP 클라이언트
|
|
565
|
-
- **위치**: `src/test/` 폴더
|
|
566
|
-
- **예시**:
|
|
567
|
-
- `src/test/test-client.ts`
|
|
568
|
-
- `src/test/test-search.ts`
|
|
569
|
-
- `src/test/test-embedding.ts`
|
|
570
|
-
|
|
571
|
-
### 4. 에러 로깅 테스트
|
|
572
|
-
|
|
573
|
-
- **목적**: 에러 로깅 시스템의 정상 동작 검증
|
|
574
|
-
- **범위**: ErrorLoggingService, 에러 통계, 에러 해결
|
|
575
|
-
- **도구**: tsx + 직접 서비스 테스트
|
|
576
|
-
- **위치**: `src/test-error-logging.ts`
|
|
577
|
-
|
|
578
|
-
### 5. 성능 알림 테스트
|
|
579
|
-
|
|
580
|
-
- **목적**: 성능 알림 시스템의 정상 동작 검증
|
|
581
|
-
- **범위**: PerformanceAlertService, 실시간 모니터링, 알림 관리
|
|
582
|
-
- **도구**: tsx + 직접 서비스 테스트
|
|
583
|
-
- **위치**: `src/test-performance-alerts.ts`
|
|
584
|
-
|
|
585
|
-
### 테스트 작성 가이드
|
|
586
|
-
|
|
587
|
-
#### 1. 테스트 구조 (AAA 패턴)
|
|
588
|
-
|
|
589
|
-
```typescript
|
|
590
|
-
describe('ComponentName', () => {
|
|
591
|
-
describe('methodName', () => {
|
|
592
|
-
it('should do something when condition', async () => {
|
|
593
|
-
// Arrange (준비)
|
|
594
|
-
const input = createTestInput();
|
|
595
|
-
const expected = createExpectedOutput();
|
|
596
|
-
|
|
597
|
-
// Act (실행)
|
|
598
|
-
const result = await component.method(input);
|
|
599
|
-
|
|
600
|
-
// Assert (검증)
|
|
601
|
-
expect(result).toEqual(expected);
|
|
602
|
-
});
|
|
603
|
-
});
|
|
604
|
-
});
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
#### 2. Mock 사용
|
|
608
|
-
|
|
609
|
-
```typescript
|
|
610
|
-
// Mock 객체 생성
|
|
611
|
-
const mockDatabase = {
|
|
612
|
-
createMemory: jest.fn(),
|
|
613
|
-
getMemory: jest.fn(),
|
|
614
|
-
searchMemories: jest.fn()
|
|
615
|
-
};
|
|
616
|
-
|
|
617
|
-
// Mock 설정
|
|
618
|
-
mockDatabase.createMemory.mockResolvedValue('memory-123');
|
|
619
|
-
|
|
620
|
-
// Mock 검증
|
|
621
|
-
expect(mockDatabase.createMemory).toHaveBeenCalledWith(expectedParams);
|
|
622
|
-
```
|
|
623
|
-
|
|
624
|
-
#### 3. 테스트 데이터 관리
|
|
625
|
-
|
|
626
|
-
```typescript
|
|
627
|
-
// tests/fixtures/memories.json
|
|
628
|
-
{
|
|
629
|
-
"episodic": [
|
|
630
|
-
{
|
|
631
|
-
"id": "memory-1",
|
|
632
|
-
"content": "Test episodic memory",
|
|
633
|
-
"type": "episodic",
|
|
634
|
-
"importance": 0.8
|
|
635
|
-
}
|
|
636
|
-
],
|
|
637
|
-
"semantic": [
|
|
638
|
-
{
|
|
639
|
-
"id": "memory-2",
|
|
640
|
-
"content": "Test semantic memory",
|
|
641
|
-
"type": "semantic",
|
|
642
|
-
"importance": 0.9
|
|
643
|
-
}
|
|
644
|
-
]
|
|
645
|
-
}
|
|
646
|
-
```
|
|
647
|
-
|
|
648
|
-
### 테스트 실행
|
|
649
|
-
|
|
650
|
-
```bash
|
|
651
|
-
# 모든 테스트 실행 (Vitest)
|
|
652
|
-
npm test
|
|
653
|
-
|
|
654
|
-
# 특정 테스트 실행
|
|
655
|
-
npm run test:client
|
|
656
|
-
npm run test:search
|
|
657
|
-
npm run test:embedding
|
|
658
|
-
npm run test:lightweight-embedding
|
|
659
|
-
npm run test:forgetting
|
|
660
|
-
npm run test:performance
|
|
661
|
-
npm run test:monitoring
|
|
662
|
-
npm run test:error-logging
|
|
663
|
-
npm run test:performance-alerts
|
|
664
|
-
|
|
665
|
-
# 커버리지 포함 테스트
|
|
666
|
-
npm run test -- --coverage
|
|
667
|
-
|
|
668
|
-
# 감시 모드
|
|
669
|
-
npm run test -- --watch
|
|
670
|
-
```
|
|
671
|
-
|
|
672
|
-
## 기여 방법
|
|
673
|
-
|
|
674
|
-
### 1. 이슈 생성
|
|
675
|
-
|
|
676
|
-
#### 버그 리포트
|
|
677
|
-
|
|
678
|
-
```markdown
|
|
679
|
-
**버그 설명**
|
|
680
|
-
간단명료한 버그 설명
|
|
681
|
-
|
|
682
|
-
**재현 단계**
|
|
683
|
-
1. '...'로 이동
|
|
684
|
-
2. '...' 클릭
|
|
685
|
-
3. '...' 입력
|
|
686
|
-
4. 오류 발생
|
|
687
|
-
|
|
688
|
-
**예상 동작**
|
|
689
|
-
어떤 일이 일어나야 하는지
|
|
690
|
-
|
|
691
|
-
**실제 동작**
|
|
692
|
-
실제로 일어난 일
|
|
693
|
-
|
|
694
|
-
**환경**
|
|
695
|
-
- OS: [예: Windows 10]
|
|
696
|
-
- Node.js: [예: 20.0.0]
|
|
697
|
-
- Memento: [예: 0.1.0]
|
|
698
|
-
```
|
|
699
|
-
|
|
700
|
-
#### 기능 요청
|
|
701
|
-
|
|
702
|
-
```markdown
|
|
703
|
-
**기능 설명**
|
|
704
|
-
원하는 기능에 대한 간단명료한 설명
|
|
705
|
-
|
|
706
|
-
**사용 사례**
|
|
707
|
-
이 기능이 왜 필요한지, 어떤 문제를 해결하는지
|
|
708
|
-
|
|
709
|
-
**제안하는 해결책**
|
|
710
|
-
구체적인 구현 방안 (있는 경우)
|
|
711
|
-
|
|
712
|
-
**대안**
|
|
713
|
-
고려한 다른 해결책들
|
|
714
|
-
```
|
|
715
|
-
|
|
716
|
-
### 2. 코드 기여
|
|
717
|
-
|
|
718
|
-
#### 1단계: 저장소 포크
|
|
719
|
-
|
|
720
|
-
1. GitHub에서 저장소 포크
|
|
721
|
-
2. 로컬에 클론
|
|
722
|
-
|
|
723
|
-
```bash
|
|
724
|
-
git clone https://github.com/your-username/memento.git
|
|
725
|
-
cd memento
|
|
726
|
-
```
|
|
727
|
-
|
|
728
|
-
#### 2단계: 개발 환경 설정
|
|
729
|
-
|
|
730
|
-
```bash
|
|
731
|
-
# 원본 저장소 추가
|
|
732
|
-
git remote add upstream https://github.com/your-org/memento.git
|
|
733
|
-
|
|
734
|
-
# 의존성 설치
|
|
735
|
-
npm install
|
|
736
|
-
|
|
737
|
-
# 개발 서버 시작
|
|
738
|
-
npm run dev
|
|
739
|
-
```
|
|
740
|
-
|
|
741
|
-
#### 3단계: 기능 개발
|
|
742
|
-
|
|
743
|
-
```bash
|
|
744
|
-
# 새 브랜치 생성
|
|
745
|
-
git checkout -b feature/your-feature
|
|
746
|
-
|
|
747
|
-
# 개발 진행
|
|
748
|
-
# ... 코드 작성 ...
|
|
749
|
-
|
|
750
|
-
# 테스트 작성
|
|
751
|
-
npm run test
|
|
752
|
-
|
|
753
|
-
# 커밋
|
|
754
|
-
git add .
|
|
755
|
-
git commit -m "feat: add your feature"
|
|
756
|
-
```
|
|
757
|
-
|
|
758
|
-
#### 4단계: Pull Request 생성
|
|
759
|
-
|
|
760
|
-
1. 변경사항 푸시
|
|
761
|
-
```bash
|
|
762
|
-
git push origin feature/your-feature
|
|
763
|
-
```
|
|
764
|
-
|
|
765
|
-
2. GitHub에서 Pull Request 생성
|
|
766
|
-
3. 템플릿에 따라 설명 작성
|
|
767
|
-
4. 리뷰어 지정
|
|
768
|
-
|
|
769
|
-
### 3. 문서 기여
|
|
770
|
-
|
|
771
|
-
#### 문서 작성 가이드
|
|
772
|
-
|
|
773
|
-
- **언어**: 한국어 (기술 용어는 영어 병기)
|
|
774
|
-
- **형식**: Markdown
|
|
775
|
-
- **구조**: 명확한 목차와 섹션 구분
|
|
776
|
-
- **예시**: 실제 사용 가능한 코드 예시
|
|
777
|
-
|
|
778
|
-
#### 문서 업데이트
|
|
779
|
-
|
|
780
|
-
1. 관련 문서 파일 수정
|
|
781
|
-
2. 변경사항 설명
|
|
782
|
-
3. 리뷰 요청
|
|
783
|
-
|
|
784
|
-
### 4. 커밋 메시지 규칙
|
|
785
|
-
|
|
786
|
-
#### 컨벤셔널 커밋 형식
|
|
787
|
-
|
|
788
|
-
```
|
|
789
|
-
<type>(<scope>): <description>
|
|
790
|
-
|
|
791
|
-
[optional body]
|
|
792
|
-
|
|
793
|
-
[optional footer(s)]
|
|
794
|
-
```
|
|
795
|
-
|
|
796
|
-
#### 타입
|
|
797
|
-
|
|
798
|
-
- `feat`: 새로운 기능
|
|
799
|
-
- `fix`: 버그 수정
|
|
800
|
-
- `docs`: 문서 변경
|
|
801
|
-
- `style`: 코드 포맷팅
|
|
802
|
-
- `refactor`: 코드 리팩토링
|
|
803
|
-
- `test`: 테스트 추가/수정
|
|
804
|
-
- `chore`: 빌드 프로세스 또는 보조 도구 변경
|
|
805
|
-
|
|
806
|
-
#### 예시
|
|
807
|
-
|
|
808
|
-
```bash
|
|
809
|
-
feat(tools): add summarize_thread tool
|
|
810
|
-
fix(database): resolve memory leak in SQLite connection
|
|
811
|
-
docs(api): update remember tool documentation
|
|
812
|
-
test(integration): add MCP server integration tests
|
|
813
|
-
```
|
|
814
|
-
|
|
815
|
-
## 에러 로깅 및 성능 모니터링 개발 가이드
|
|
816
|
-
|
|
817
|
-
### 에러 로깅 시스템
|
|
818
|
-
|
|
819
|
-
#### 1. 에러 로깅 서비스 사용
|
|
820
|
-
|
|
821
|
-
```typescript
|
|
822
|
-
import { ErrorLoggingService, ErrorSeverity, ErrorCategory } from '../services/error-logging-service.js';
|
|
823
|
-
|
|
824
|
-
// 에러 로깅 서비스 초기화
|
|
825
|
-
const errorLoggingService = new ErrorLoggingService();
|
|
826
|
-
|
|
827
|
-
// 에러 로깅
|
|
828
|
-
try {
|
|
829
|
-
// 위험한 작업 수행
|
|
830
|
-
await riskyOperation();
|
|
831
|
-
} catch (error) {
|
|
832
|
-
errorLoggingService.logError(
|
|
833
|
-
error instanceof Error ? error : new Error(String(error)),
|
|
834
|
-
ErrorSeverity.HIGH,
|
|
835
|
-
ErrorCategory.TOOL_EXECUTION,
|
|
836
|
-
{
|
|
837
|
-
operation: 'risky_operation',
|
|
838
|
-
userId: 'user123',
|
|
839
|
-
timestamp: new Date().toISOString()
|
|
840
|
-
}
|
|
841
|
-
);
|
|
842
|
-
}
|
|
843
|
-
```
|
|
844
|
-
|
|
845
|
-
#### 2. 에러 통계 조회
|
|
846
|
-
|
|
847
|
-
```typescript
|
|
848
|
-
// 기본 에러 통계
|
|
849
|
-
const stats = await errorLoggingService.getErrorStats();
|
|
850
|
-
|
|
851
|
-
// 필터링된 에러 통계
|
|
852
|
-
const highErrors = await errorLoggingService.getErrorStats({
|
|
853
|
-
severity: ErrorSeverity.HIGH,
|
|
854
|
-
hours: 24
|
|
855
|
-
});
|
|
856
|
-
|
|
857
|
-
// 데이터베이스 관련 에러만 조회
|
|
858
|
-
const dbErrors = await errorLoggingService.getErrorStats({
|
|
859
|
-
category: ErrorCategory.DATABASE,
|
|
860
|
-
limit: 10
|
|
861
|
-
});
|
|
862
|
-
```
|
|
863
|
-
|
|
864
|
-
#### 3. 에러 해결 처리
|
|
865
|
-
|
|
866
|
-
```typescript
|
|
867
|
-
// 에러 해결
|
|
868
|
-
const resolved = await errorLoggingService.resolveError(
|
|
869
|
-
'error-123',
|
|
870
|
-
'admin',
|
|
871
|
-
'데이터베이스 연결 문제 해결됨'
|
|
872
|
-
);
|
|
873
|
-
```
|
|
874
|
-
|
|
875
|
-
### 성능 알림 시스템
|
|
876
|
-
|
|
877
|
-
#### 1. 성능 알림 서비스 사용
|
|
878
|
-
|
|
879
|
-
```typescript
|
|
880
|
-
import { PerformanceAlertService, AlertLevel, AlertType } from '../services/performance-alert-service.js';
|
|
881
|
-
|
|
882
|
-
// 성능 알림 서비스 초기화
|
|
883
|
-
const alertService = new PerformanceAlertService('./logs');
|
|
884
|
-
|
|
885
|
-
// 알림 생성
|
|
886
|
-
const alert = alertService.createAlert(
|
|
887
|
-
AlertLevel.WARNING,
|
|
888
|
-
AlertType.RESPONSE_TIME,
|
|
889
|
-
'평균 응답시간',
|
|
890
|
-
150,
|
|
891
|
-
100,
|
|
892
|
-
'🟡 응답시간이 임계값을 초과했습니다',
|
|
893
|
-
{ component: 'search_engine', operation: 'search' }
|
|
894
|
-
);
|
|
895
|
-
|
|
896
|
-
// 알림 해결
|
|
897
|
-
const resolvedAlert = alertService.resolveAlert(
|
|
898
|
-
alert.id,
|
|
899
|
-
'admin',
|
|
900
|
-
'성능 최적화 완료'
|
|
901
|
-
);
|
|
902
|
-
```
|
|
903
|
-
|
|
904
|
-
#### 2. 실시간 모니터링 설정
|
|
905
|
-
|
|
906
|
-
```typescript
|
|
907
|
-
import { PerformanceMonitoringIntegration } from '../services/performance-monitoring-integration.js';
|
|
908
|
-
|
|
909
|
-
// 모니터링 통합 서비스 초기화
|
|
910
|
-
const monitoringIntegration = new PerformanceMonitoringIntegration(
|
|
911
|
-
db,
|
|
912
|
-
alertService,
|
|
913
|
-
{
|
|
914
|
-
enableRealTimeMonitoring: true,
|
|
915
|
-
monitoringInterval: 30000, // 30초마다 체크
|
|
916
|
-
alertThresholds: {
|
|
917
|
-
responseTime: { warning: 100, critical: 500 },
|
|
918
|
-
memoryUsage: { warning: 100, critical: 200 },
|
|
919
|
-
errorRate: { warning: 5, critical: 10 },
|
|
920
|
-
throughput: { warning: 10, critical: 5 }
|
|
921
|
-
}
|
|
922
|
-
}
|
|
923
|
-
);
|
|
924
|
-
|
|
925
|
-
// 실시간 모니터링 시작
|
|
926
|
-
monitoringIntegration.startRealTimeMonitoring();
|
|
927
|
-
```
|
|
928
|
-
|
|
929
|
-
### 테스트 작성
|
|
930
|
-
|
|
931
|
-
#### 1. 에러 로깅 테스트
|
|
932
|
-
|
|
933
|
-
```typescript
|
|
934
|
-
// src/test-error-logging.ts
|
|
935
|
-
import { ErrorLoggingService, ErrorSeverity, ErrorCategory } from './services/error-logging-service.js';
|
|
936
|
-
|
|
937
|
-
async function testErrorLogging() {
|
|
938
|
-
const errorService = new ErrorLoggingService();
|
|
939
|
-
|
|
940
|
-
// 에러 로깅 테스트
|
|
941
|
-
errorService.logError(
|
|
942
|
-
new Error('Test error'),
|
|
943
|
-
ErrorSeverity.HIGH,
|
|
944
|
-
ErrorCategory.SYSTEM,
|
|
945
|
-
{ test: true }
|
|
946
|
-
);
|
|
947
|
-
|
|
948
|
-
// 통계 조회 테스트
|
|
949
|
-
const stats = errorService.getErrorStats();
|
|
950
|
-
console.log('Error stats:', stats);
|
|
951
|
-
|
|
952
|
-
// 에러 해결 테스트
|
|
953
|
-
const errors = errorService.searchErrors({ limit: 1 });
|
|
954
|
-
if (errors.length > 0) {
|
|
955
|
-
const resolved = errorService.resolveError(
|
|
956
|
-
errors[0].id,
|
|
957
|
-
'test_user',
|
|
958
|
-
'Test resolution'
|
|
959
|
-
);
|
|
960
|
-
console.log('Error resolved:', resolved);
|
|
961
|
-
}
|
|
962
|
-
}
|
|
963
|
-
```
|
|
964
|
-
|
|
965
|
-
#### 2. 성능 알림 테스트
|
|
966
|
-
|
|
967
|
-
```typescript
|
|
968
|
-
// src/test-performance-alerts.ts
|
|
969
|
-
import { PerformanceAlertService, AlertLevel, AlertType } from './services/performance-alert-service.js';
|
|
970
|
-
|
|
971
|
-
async function testPerformanceAlerts() {
|
|
972
|
-
const alertService = new PerformanceAlertService('./logs');
|
|
973
|
-
|
|
974
|
-
// 알림 생성 테스트
|
|
975
|
-
const alert = alertService.createAlert(
|
|
976
|
-
AlertLevel.WARNING,
|
|
977
|
-
AlertType.MEMORY_USAGE,
|
|
978
|
-
'메모리 사용량',
|
|
979
|
-
150,
|
|
980
|
-
100,
|
|
981
|
-
'🟡 메모리 사용량 초과'
|
|
982
|
-
);
|
|
983
|
-
|
|
984
|
-
// 알림 통계 조회
|
|
985
|
-
const stats = alertService.getStats();
|
|
986
|
-
console.log('Alert stats:', stats);
|
|
987
|
-
|
|
988
|
-
// 알림 해결 테스트
|
|
989
|
-
const resolved = alertService.resolveAlert(
|
|
990
|
-
alert.id,
|
|
991
|
-
'test_user',
|
|
992
|
-
'Test resolution'
|
|
993
|
-
);
|
|
994
|
-
console.log('Alert resolved:', resolved);
|
|
995
|
-
}
|
|
996
|
-
```
|
|
997
|
-
|
|
998
|
-
## 추가 리소스
|
|
999
|
-
|
|
1000
|
-
- [API 참조 문서](api-reference.md)
|
|
1001
|
-
- [사용자 매뉴얼](user-manual.md)
|
|
1002
|
-
- [아키텍처 문서](architecture.md)
|
|
1003
|
-
- [테스트 가이드](testing-guide.md)
|
|
1004
|
-
- [Cursor Rules](../.cursor/rules/)
|
|
1005
|
-
- [GitHub 저장소](https://github.com/your-org/memento)
|
|
1006
|
-
- [커뮤니티 포럼](https://github.com/your-org/memento/discussions)
|