memoryking 0.1.0a1__tar.gz
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.
- memoryking-0.1.0a1/LICENSE +202 -0
- memoryking-0.1.0a1/NOTICE +12 -0
- memoryking-0.1.0a1/PKG-INFO +144 -0
- memoryking-0.1.0a1/README.md +113 -0
- memoryking-0.1.0a1/pyproject.toml +67 -0
- memoryking-0.1.0a1/setup.cfg +4 -0
- memoryking-0.1.0a1/src/memoryking/__init__.py +3 -0
- memoryking-0.1.0a1/src/memoryking/__main__.py +885 -0
- memoryking-0.1.0a1/src/memoryking/adapters/__init__.py +1 -0
- memoryking-0.1.0a1/src/memoryking/adapters/adapter_state.py +242 -0
- memoryking-0.1.0a1/src/memoryking/adapters/atlas.py +356 -0
- memoryking-0.1.0a1/src/memoryking/adapters/browser_commands.py +112 -0
- memoryking-0.1.0a1/src/memoryking/adapters/dashboard.py +750 -0
- memoryking-0.1.0a1/src/memoryking/adapters/dense_search.py +86 -0
- memoryking-0.1.0a1/src/memoryking/adapters/egress_policy.py +229 -0
- memoryking-0.1.0a1/src/memoryking/adapters/egress_schema.sql +13 -0
- memoryking-0.1.0a1/src/memoryking/adapters/embedding.schema.json +302 -0
- memoryking-0.1.0a1/src/memoryking/adapters/embedding_store.py +469 -0
- memoryking-0.1.0a1/src/memoryking/adapters/execution.py +368 -0
- memoryking-0.1.0a1/src/memoryking/adapters/experience.py +423 -0
- memoryking-0.1.0a1/src/memoryking/adapters/experience.schema.json +1508 -0
- memoryking-0.1.0a1/src/memoryking/adapters/experience_records.py +239 -0
- memoryking-0.1.0a1/src/memoryking/adapters/experience_schema.sql +23 -0
- memoryking-0.1.0a1/src/memoryking/adapters/handoff.py +494 -0
- memoryking-0.1.0a1/src/memoryking/adapters/handoff.schema.json +299 -0
- memoryking-0.1.0a1/src/memoryking/adapters/handoff_schema.sql +17 -0
- memoryking-0.1.0a1/src/memoryking/adapters/index_schema.sql +11 -0
- memoryking-0.1.0a1/src/memoryking/adapters/inference.py +434 -0
- memoryking-0.1.0a1/src/memoryking/adapters/inference.schema.json +541 -0
- memoryking-0.1.0a1/src/memoryking/adapters/inspection.py +392 -0
- memoryking-0.1.0a1/src/memoryking/adapters/inspection.schema.json +248 -0
- memoryking-0.1.0a1/src/memoryking/adapters/knowledge.schema.json +588 -0
- memoryking-0.1.0a1/src/memoryking/adapters/knowledge_schema.sql +37 -0
- memoryking-0.1.0a1/src/memoryking/adapters/knowledge_store.py +795 -0
- memoryking-0.1.0a1/src/memoryking/adapters/legacy_snapshot.py +358 -0
- memoryking-0.1.0a1/src/memoryking/adapters/legacy_tables.py +49 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_contract.py +20 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_embeddings.py +107 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_files.py +242 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_ipc.py +247 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_schema.sql +44 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_store.py +623 -0
- memoryking-0.1.0a1/src/memoryking/adapters/local_wire.schema.json +6625 -0
- memoryking-0.1.0a1/src/memoryking/adapters/models/minilm-l6-v2-onnx.json +57 -0
- memoryking-0.1.0a1/src/memoryking/adapters/optional_schema.sql +43 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_admin.py +294 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_counter.sql +14 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_egress_schema.sql +15 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_experience_schema.sql +39 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_index_schema.sql +7 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_optional_schema.sql +71 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_pool.py +71 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_recovery.py +517 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_schema.sql +365 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_sql.py +102 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_store.py +402 -0
- memoryking-0.1.0a1/src/memoryking/adapters/postgres_summary_schema.sql +12 -0
- memoryking-0.1.0a1/src/memoryking/adapters/processing.schema.json +471 -0
- memoryking-0.1.0a1/src/memoryking/adapters/processing_store.py +346 -0
- memoryking-0.1.0a1/src/memoryking/adapters/projects.py +83 -0
- memoryking-0.1.0a1/src/memoryking/adapters/ranking.py +315 -0
- memoryking-0.1.0a1/src/memoryking/adapters/repository.schema.json +664 -0
- memoryking-0.1.0a1/src/memoryking/adapters/repository_git.py +264 -0
- memoryking-0.1.0a1/src/memoryking/adapters/repository_schema.sql +25 -0
- memoryking-0.1.0a1/src/memoryking/adapters/repository_store.py +960 -0
- memoryking-0.1.0a1/src/memoryking/adapters/retrieval.py +1033 -0
- memoryking-0.1.0a1/src/memoryking/adapters/retrieval.schema.json +534 -0
- memoryking-0.1.0a1/src/memoryking/adapters/retrieval_schema.sql +10 -0
- memoryking-0.1.0a1/src/memoryking/adapters/shared_control.py +40 -0
- memoryking-0.1.0a1/src/memoryking/adapters/shared_dashboard.py +610 -0
- memoryking-0.1.0a1/src/memoryking/adapters/shared_gateway.py +63 -0
- memoryking-0.1.0a1/src/memoryking/adapters/shared_http.py +214 -0
- memoryking-0.1.0a1/src/memoryking/adapters/shared_mcp.py +154 -0
- memoryking-0.1.0a1/src/memoryking/adapters/shared_service.py +81 -0
- memoryking-0.1.0a1/src/memoryking/adapters/stdio.py +193 -0
- memoryking-0.1.0a1/src/memoryking/adapters/stdio.tools.json +4580 -0
- memoryking-0.1.0a1/src/memoryking/adapters/summary_schema.sql +10 -0
- memoryking-0.1.0a1/src/memoryking/adapters/team.py +249 -0
- memoryking-0.1.0a1/src/memoryking/adapters/timeline.py +79 -0
- memoryking-0.1.0a1/src/memoryking/adapters/token_count.py +55 -0
- memoryking-0.1.0a1/src/memoryking/adapters/tokenizers/LICENSE +21 -0
- memoryking-0.1.0a1/src/memoryking/adapters/tokenizers/cl100k_base.tiktoken +100256 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/app.css +1353 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/app.js +984 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/brand.js +44 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/crown-mono.svg +1 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/crown.svg +8 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/elephant.png +0 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/favicon.svg +8 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/graph-layout.js +52 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/graph-worker.js +10 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/graph.js +477 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/index.html +259 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/observatory.js +913 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/team.js +151 -0
- memoryking-0.1.0a1/src/memoryking/adapters/web/wordmark.svg +1 -0
- memoryking-0.1.0a1/src/memoryking/adapters/working.py +900 -0
- memoryking-0.1.0a1/src/memoryking/adapters/working.schema.json +1271 -0
- memoryking-0.1.0a1/src/memoryking/adapters/working_schema.sql +24 -0
- memoryking-0.1.0a1/src/memoryking/application/__init__.py +1 -0
- memoryking-0.1.0a1/src/memoryking/application/conformance.py +50 -0
- memoryking-0.1.0a1/src/memoryking/application/legacy_import.py +337 -0
- memoryking-0.1.0a1/src/memoryking/application/local_port.py +9 -0
- memoryking-0.1.0a1/src/memoryking/application/storage.py +113 -0
- memoryking-0.1.0a1/src/memoryking/application/store_core.py +1190 -0
- memoryking-0.1.0a1/src/memoryking/backups.py +120 -0
- memoryking-0.1.0a1/src/memoryking/contracts/__init__.py +6 -0
- memoryking-0.1.0a1/src/memoryking/contracts/__main__.py +20 -0
- memoryking-0.1.0a1/src/memoryking/contracts/canonical.py +85 -0
- memoryking-0.1.0a1/src/memoryking/contracts/embedding.schema.json +302 -0
- memoryking-0.1.0a1/src/memoryking/contracts/embedding_generated.py +65 -0
- memoryking-0.1.0a1/src/memoryking/contracts/experience.schema.json +1508 -0
- memoryking-0.1.0a1/src/memoryking/contracts/experience_generated.py +239 -0
- memoryking-0.1.0a1/src/memoryking/contracts/generated.py +122 -0
- memoryking-0.1.0a1/src/memoryking/contracts/handoff.schema.json +299 -0
- memoryking-0.1.0a1/src/memoryking/contracts/handoff_generated.py +69 -0
- memoryking-0.1.0a1/src/memoryking/contracts/inference.schema.json +541 -0
- memoryking-0.1.0a1/src/memoryking/contracts/inference_generated.py +106 -0
- memoryking-0.1.0a1/src/memoryking/contracts/processing.schema.json +471 -0
- memoryking-0.1.0a1/src/memoryking/contracts/processing_generated.py +82 -0
- memoryking-0.1.0a1/src/memoryking/contracts/py.typed +0 -0
- memoryking-0.1.0a1/src/memoryking/contracts/repository.schema.json +664 -0
- memoryking-0.1.0a1/src/memoryking/contracts/repository_generated.py +144 -0
- memoryking-0.1.0a1/src/memoryking/contracts/retrieval.schema.json +534 -0
- memoryking-0.1.0a1/src/memoryking/contracts/retrieval_generated.py +107 -0
- memoryking-0.1.0a1/src/memoryking/contracts/schema.json +696 -0
- memoryking-0.1.0a1/src/memoryking/contracts/validation.py +92 -0
- memoryking-0.1.0a1/src/memoryking/contracts/working.schema.json +1271 -0
- memoryking-0.1.0a1/src/memoryking/contracts/working_generated.py +213 -0
- memoryking-0.1.0a1/src/memoryking/domain/__init__.py +1 -0
- memoryking-0.1.0a1/src/memoryking/domain/briefing.py +108 -0
- memoryking-0.1.0a1/src/memoryking/domain/briefing_text.py +217 -0
- memoryking-0.1.0a1/src/memoryking/domain/checkpoint.py +111 -0
- memoryking-0.1.0a1/src/memoryking/domain/compression.py +64 -0
- memoryking-0.1.0a1/src/memoryking/domain/delta.py +129 -0
- memoryking-0.1.0a1/src/memoryking/domain/embeddings.py +90 -0
- memoryking-0.1.0a1/src/memoryking/domain/hints.py +444 -0
- memoryking-0.1.0a1/src/memoryking/domain/http_status.py +34 -0
- memoryking-0.1.0a1/src/memoryking/domain/learning.py +62 -0
- memoryking-0.1.0a1/src/memoryking/domain/local.py +65 -0
- memoryking-0.1.0a1/src/memoryking/domain/repository.py +118 -0
- memoryking-0.1.0a1/src/memoryking/domain/selectors.py +356 -0
- memoryking-0.1.0a1/src/memoryking/domain/summary.py +88 -0
- memoryking-0.1.0a1/src/memoryking/domain/usage.py +163 -0
- memoryking-0.1.0a1/src/memoryking/embedding_loop.py +98 -0
- memoryking-0.1.0a1/src/memoryking/embedding_worker.py +131 -0
- memoryking-0.1.0a1/src/memoryking/harness.py +882 -0
- memoryking-0.1.0a1/src/memoryking/harness_context.py +376 -0
- memoryking-0.1.0a1/src/memoryking/hooks.py +138 -0
- memoryking-0.1.0a1/src/memoryking/lean.py +323 -0
- memoryking-0.1.0a1/src/memoryking/migration.py +194 -0
- memoryking-0.1.0a1/src/memoryking/model_install.py +71 -0
- memoryking-0.1.0a1/src/memoryking/observability.py +101 -0
- memoryking-0.1.0a1/src/memoryking/observability_metrics.py +100 -0
- memoryking-0.1.0a1/src/memoryking/profiles.py +136 -0
- memoryking-0.1.0a1/src/memoryking/providers.py +325 -0
- memoryking-0.1.0a1/src/memoryking/py.typed +0 -0
- memoryking-0.1.0a1/src/memoryking/pytest_plugin.py +68 -0
- memoryking-0.1.0a1/src/memoryking/reference_agent.py +152 -0
- memoryking-0.1.0a1/src/memoryking/repository_worker.py +57 -0
- memoryking-0.1.0a1/src/memoryking/resume_adapter.py +154 -0
- memoryking-0.1.0a1/src/memoryking/sdk.py +283 -0
- memoryking-0.1.0a1/src/memoryking/shared.py +303 -0
- memoryking-0.1.0a1/src/memoryking/shared_sdk.py +101 -0
- memoryking-0.1.0a1/src/memoryking.egg-info/PKG-INFO +144 -0
- memoryking-0.1.0a1/src/memoryking.egg-info/SOURCES.txt +246 -0
- memoryking-0.1.0a1/src/memoryking.egg-info/dependency_links.txt +1 -0
- memoryking-0.1.0a1/src/memoryking.egg-info/entry_points.txt +7 -0
- memoryking-0.1.0a1/src/memoryking.egg-info/requires.txt +14 -0
- memoryking-0.1.0a1/src/memoryking.egg-info/top_level.txt +1 -0
- memoryking-0.1.0a1/tests/test_architecture.py +17 -0
- memoryking-0.1.0a1/tests/test_atlas.py +197 -0
- memoryking-0.1.0a1/tests/test_backups.py +74 -0
- memoryking-0.1.0a1/tests/test_checkpoint_complete.py +44 -0
- memoryking-0.1.0a1/tests/test_cli.py +457 -0
- memoryking-0.1.0a1/tests/test_conformance.py +88 -0
- memoryking-0.1.0a1/tests/test_contracts.py +46 -0
- memoryking-0.1.0a1/tests/test_dashboard.py +831 -0
- memoryking-0.1.0a1/tests/test_delta.py +173 -0
- memoryking-0.1.0a1/tests/test_dense_retrieval.py +182 -0
- memoryking-0.1.0a1/tests/test_egress.py +580 -0
- memoryking-0.1.0a1/tests/test_embedding_contracts.py +22 -0
- memoryking-0.1.0a1/tests/test_embedding_jobs.py +216 -0
- memoryking-0.1.0a1/tests/test_embedding_worker.py +124 -0
- memoryking-0.1.0a1/tests/test_embeddings.py +109 -0
- memoryking-0.1.0a1/tests/test_error_hints.py +83 -0
- memoryking-0.1.0a1/tests/test_evaluation_audit.py +203 -0
- memoryking-0.1.0a1/tests/test_execution.py +245 -0
- memoryking-0.1.0a1/tests/test_experience.py +289 -0
- memoryking-0.1.0a1/tests/test_experience_contracts.py +18 -0
- memoryking-0.1.0a1/tests/test_experience_migrations.py +173 -0
- memoryking-0.1.0a1/tests/test_experience_records.py +162 -0
- memoryking-0.1.0a1/tests/test_experience_repository.py +61 -0
- memoryking-0.1.0a1/tests/test_handoff.py +464 -0
- memoryking-0.1.0a1/tests/test_harness.py +376 -0
- memoryking-0.1.0a1/tests/test_inference.py +413 -0
- memoryking-0.1.0a1/tests/test_inspection.py +336 -0
- memoryking-0.1.0a1/tests/test_journal.py +173 -0
- memoryking-0.1.0a1/tests/test_knowledge.py +749 -0
- memoryking-0.1.0a1/tests/test_legacy_migration.py +368 -0
- memoryking-0.1.0a1/tests/test_local_store.py +743 -0
- memoryking-0.1.0a1/tests/test_observability.py +317 -0
- memoryking-0.1.0a1/tests/test_optional_migrations.py +142 -0
- memoryking-0.1.0a1/tests/test_ownership_cleanup.py +24 -0
- memoryking-0.1.0a1/tests/test_pgvector.py +52 -0
- memoryking-0.1.0a1/tests/test_postgres_atlas.py +8 -0
- memoryking-0.1.0a1/tests/test_postgres_concurrency.py +42 -0
- memoryking-0.1.0a1/tests/test_postgres_database.py +193 -0
- memoryking-0.1.0a1/tests/test_postgres_delta.py +6 -0
- memoryking-0.1.0a1/tests/test_postgres_dense.py +6 -0
- memoryking-0.1.0a1/tests/test_postgres_egress.py +61 -0
- memoryking-0.1.0a1/tests/test_postgres_embedding_jobs.py +8 -0
- memoryking-0.1.0a1/tests/test_postgres_experience.py +47 -0
- memoryking-0.1.0a1/tests/test_postgres_foundation_parity.py +119 -0
- memoryking-0.1.0a1/tests/test_postgres_inference.py +84 -0
- memoryking-0.1.0a1/tests/test_postgres_migration.py +8 -0
- memoryking-0.1.0a1/tests/test_postgres_operation_recovery.py +140 -0
- memoryking-0.1.0a1/tests/test_postgres_optional.py +144 -0
- memoryking-0.1.0a1/tests/test_postgres_parity.py +346 -0
- memoryking-0.1.0a1/tests/test_postgres_processing.py +37 -0
- memoryking-0.1.0a1/tests/test_postgres_sql.py +54 -0
- memoryking-0.1.0a1/tests/test_postgres_store.py +476 -0
- memoryking-0.1.0a1/tests/test_processing.py +251 -0
- memoryking-0.1.0a1/tests/test_processing_contracts.py +22 -0
- memoryking-0.1.0a1/tests/test_processing_repository.py +71 -0
- memoryking-0.1.0a1/tests/test_processing_transport.py +94 -0
- memoryking-0.1.0a1/tests/test_qualification_security.py +113 -0
- memoryking-0.1.0a1/tests/test_ranking.py +289 -0
- memoryking-0.1.0a1/tests/test_reference_agent.py +138 -0
- memoryking-0.1.0a1/tests/test_report_evidence.py +45 -0
- memoryking-0.1.0a1/tests/test_repository.py +542 -0
- memoryking-0.1.0a1/tests/test_repository_contracts.py +22 -0
- memoryking-0.1.0a1/tests/test_repository_git.py +171 -0
- memoryking-0.1.0a1/tests/test_repository_harness.py +109 -0
- memoryking-0.1.0a1/tests/test_resume_adapter.py +98 -0
- memoryking-0.1.0a1/tests/test_retrieval.py +515 -0
- memoryking-0.1.0a1/tests/test_retrieval_benchmark.py +38 -0
- memoryking-0.1.0a1/tests/test_sdk.py +615 -0
- memoryking-0.1.0a1/tests/test_shared_acceptance_matrix.py +380 -0
- memoryking-0.1.0a1/tests/test_shared_conformance_runner.py +47 -0
- memoryking-0.1.0a1/tests/test_shared_dashboard.py +234 -0
- memoryking-0.1.0a1/tests/test_shared_gateway.py +71 -0
- memoryking-0.1.0a1/tests/test_shared_http.py +476 -0
- memoryking-0.1.0a1/tests/test_shared_resume_adapter.py +78 -0
- memoryking-0.1.0a1/tests/test_summary.py +63 -0
- memoryking-0.1.0a1/tests/test_team.py +112 -0
- memoryking-0.1.0a1/tests/test_usage.py +89 -0
- memoryking-0.1.0a1/tests/test_working.py +741 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
MemoryKing
|
|
2
|
+
Copyright 2026 James King
|
|
3
|
+
|
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
|
5
|
+
this software except in compliance with the License. A copy of the License is in
|
|
6
|
+
the file LICENSE and at http://www.apache.org/licenses/LICENSE-2.0.
|
|
7
|
+
|
|
8
|
+
This distribution includes the cl100k_base tokenizer vocabulary from the tiktoken
|
|
9
|
+
project, Copyright (c) 2022 OpenAI, Shantanu Jain, under the MIT License; its notice
|
|
10
|
+
is kept at src/memoryking/adapters/tokenizers/LICENSE. The optional local embedding
|
|
11
|
+
model is not included; its manifest records the model's own Apache-2.0 licence and
|
|
12
|
+
it is downloaded only on request.
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: memoryking
|
|
3
|
+
Version: 0.1.0a1
|
|
4
|
+
Summary: MemoryKing local memory, checkpoint and recovery service
|
|
5
|
+
Author: James King
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/jamesking-us/memoryking
|
|
8
|
+
Classifier: Development Status :: 3 - Alpha
|
|
9
|
+
Classifier: Intended Audience :: Developers
|
|
10
|
+
Classifier: Operating System :: MacOS
|
|
11
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
12
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
15
|
+
Requires-Python: <3.13,>=3.12
|
|
16
|
+
Description-Content-Type: text/markdown
|
|
17
|
+
License-File: LICENSE
|
|
18
|
+
License-File: NOTICE
|
|
19
|
+
Requires-Dist: jsonschema==4.26.0
|
|
20
|
+
Provides-Extra: tokenizers
|
|
21
|
+
Requires-Dist: tiktoken==0.12.0; extra == "tokenizers"
|
|
22
|
+
Provides-Extra: embeddings
|
|
23
|
+
Requires-Dist: onnxruntime==1.23.2; extra == "embeddings"
|
|
24
|
+
Requires-Dist: numpy==2.5.4; extra == "embeddings"
|
|
25
|
+
Requires-Dist: tokenizers==0.23.3; extra == "embeddings"
|
|
26
|
+
Provides-Extra: shared
|
|
27
|
+
Requires-Dist: psycopg[binary]==3.3.6; extra == "shared"
|
|
28
|
+
Requires-Dist: psycopg-pool==3.3.3; extra == "shared"
|
|
29
|
+
Requires-Dist: mcp==2.3.0; extra == "shared"
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
<p align="center"><img src="src/memoryking/adapters/web/elephant.png" width="180" alt="MemoryKing" /></p>
|
|
33
|
+
|
|
34
|
+
# Give your AI agents a memory they can pick up again
|
|
35
|
+
|
|
36
|
+
MemoryKing keeps the useful context behind an agent's work: what it learned, what it tried, what must not be forgotten, and what should happen next.
|
|
37
|
+
|
|
38
|
+
Think of it as a **shared project notebook with a save point**. When a conversation ends, an agent restarts, or another agent takes over, the work can continue from a recorded state instead of starting with a blank page.
|
|
39
|
+
|
|
40
|
+
It is a service that you connect to your agents. It does not automatically read your chats or run agents for you.
|
|
41
|
+
|
|
42
|
+
## Why it is useful
|
|
43
|
+
|
|
44
|
+
Imagine an agent investigating a checkout bug. It discovers that a retry can charge a customer twice, tries a fix that fails, and runs out of context before finishing.
|
|
45
|
+
|
|
46
|
+
With MemoryKing, it can leave the next agent:
|
|
47
|
+
|
|
48
|
+
- **The goal:** fix the retry without creating duplicate charges.
|
|
49
|
+
- **The evidence:** the relevant error and test output, with their sources.
|
|
50
|
+
- **The failed approach:** what was tried and why not to repeat it.
|
|
51
|
+
- **The unfinished work:** the patch state, missing tests and next action.
|
|
52
|
+
- **The boundaries:** use the sandbox and keep production changes subject to approval.
|
|
53
|
+
|
|
54
|
+
The next agent receives a focused briefing and the saved task state. A reviewer can see the evidence and what is still unverified. This is an illustrative workflow; your integration supplies the observations and checks.
|
|
55
|
+
|
|
56
|
+
```mermaid
|
|
57
|
+
flowchart LR
|
|
58
|
+
A[Agent does work] --> B[Save findings and task state]
|
|
59
|
+
B --> C[MemoryKing checks access and relevance]
|
|
60
|
+
C --> D[Next session gets a focused briefing]
|
|
61
|
+
D --> E[Agent continues or hands off]
|
|
62
|
+
E --> B
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## What it does for agents
|
|
66
|
+
|
|
67
|
+
| Need | What MemoryKing provides |
|
|
68
|
+
| --- | --- |
|
|
69
|
+
| Remember useful findings | Searchable observations with source attribution; reviewed knowledge stays distinct from unverified notes. |
|
|
70
|
+
| Resume unfinished work | Checkpoints containing the objective, constraints, failed attempts, verification gaps and next actions, opened by a three-sentence "where this left off" summary. |
|
|
71
|
+
| Work together | Handoffs bound to the recipient's current permissions. |
|
|
72
|
+
| Keep context manageable | Focused briefings with explicit output budgets and links back to evidence. |
|
|
73
|
+
| Avoid stale advice | Repository identity, applicability rules and freshness checks for guidance tied to code. |
|
|
74
|
+
| Recover safely | Records of uncertain operations and history-aware backup/restore, so a restart does not silently authorize repeating an action. |
|
|
75
|
+
| Understand what happened | A dashboard with capacity, task progress, a per-project timeline, a memory graph, on-demand briefings with their receipts, and retrieval history. |
|
|
76
|
+
| Fit any agent host | A lean five-tool MCP profile with defaults for Claude Code, Codex, Grok or any stdio host; cited Markdown briefings; capture from the CLI, pytest or git hooks. |
|
|
77
|
+
| Know what to do when something is refused | Every error reply carries a one-line hint, and a [generated page](docs/error-codes.md) lists them all. |
|
|
78
|
+
|
|
79
|
+
The core runs locally **without a model account, GPU or paid API**. A shared PostgreSQL profile supports multiple agents and tenants. Optional local embeddings add semantic search. If you do want MemoryKing itself to talk to a model (Anthropic, OpenAI, xAI, Google Vertex AI, or one running on your own machine), you write a short policy saying which, and every request it sends is checked against that policy and recorded.
|
|
80
|
+
|
|
81
|
+
## See it work
|
|
82
|
+
|
|
83
|
+
You need Python **3.12** and Git. Repository access is currently private. From a terminal:
|
|
84
|
+
|
|
85
|
+
```sh
|
|
86
|
+
git clone https://github.com/jamesking-us/memoryking.git
|
|
87
|
+
cd memoryking
|
|
88
|
+
python3.12 -m venv .venv
|
|
89
|
+
.venv/bin/python -I -m pip install --require-hashes -r requirements-build.lock -r requirements-core.lock
|
|
90
|
+
.venv/bin/python -I -m pip install --no-build-isolation --no-deps .
|
|
91
|
+
.venv/bin/python examples/remember_and_resume.py
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
The example creates a temporary store, saves a finding and an unfinished task, closes the first connection, and resumes through a new client. It prints a readable walkthrough, makes no model requests, and removes its temporary data when finished.
|
|
95
|
+
|
|
96
|
+
For a lasting installation and the browser dashboard, follow the [getting started guide](docs/getting-started.md): name your store once with `memoryking profile add`, then `status`, `doctor`, `dashboard open` and `credential issue` need no paths. If you are evaluating the idea rather than installing software, start with the [agent workflows](docs/agent-guide.md).
|
|
97
|
+
|
|
98
|
+
## See what your agents are doing
|
|
99
|
+
|
|
100
|
+

|
|
101
|
+
|
|
102
|
+
*Dashboard overview with synthetic example data: capacity first, then the projects you can read, then the project's task activity with its summary. Progress reflects saved agent reports and evidence.*
|
|
103
|
+
|
|
104
|
+
The dashboard helps you inspect recorded work without reading a long chat transcript. Projects you can read are listed with their record counts; pick one and every view follows it.
|
|
105
|
+
|
|
106
|
+
- **Overview:** capacity use for each bounded resource, with a warning from 80 percent.
|
|
107
|
+
- **Task activity:** saved goals, completed and pending criteria, blockers and observed heartbeats.
|
|
108
|
+
- **Memory:** ask for the briefing an agent would receive and verify its replay, browse the project timeline, review proposed knowledge, preview a purge, and explore an interactive graph of memories and evidence, coloured by how far each record has been reviewed, with a tap through to the briefings that used it.
|
|
109
|
+
- **History and review:** inspect changes, review proposals and preview affected content.
|
|
110
|
+
- **Retrieval history:** see the exact briefing returned, its sources and recorded usage.
|
|
111
|
+
- **Team:** who did what in a project, the permissions that allow it, a revoke button, and an audit export; the overview lists your projects as cards you can open and link to.
|
|
112
|
+
- **Appearance:** textured dark and light themes, a crowned cybernetic elephant, an optional depth-tilt animation that respects reduced motion, and a phone layout for checking on agents away from the desk.
|
|
113
|
+
|
|
114
|
+
Agents must publish their state through the supported interfaces. A displayed heartbeat is an observation, not proof that an agent is still working; missing cost data stays unknown.
|
|
115
|
+
|
|
116
|
+
## Choose your setup
|
|
117
|
+
|
|
118
|
+
| Setup | Suitable for | What runs |
|
|
119
|
+
| --- | --- | --- |
|
|
120
|
+
| Local | One person or agents on one computer | Python service, SQLite, private local files; optional browser dashboard. |
|
|
121
|
+
| Shared | Multiple agents using a central service | PostgreSQL, authenticated HTTP/MCP, separate database roles and recovery storage. |
|
|
122
|
+
| Docker evaluation | Trying the shared profile on one machine | A source-built Compose stack with loopback HTTPS. |
|
|
123
|
+
|
|
124
|
+
See [deployment and configuration](docs/deployment.md) for commands, prerequisites, backup and recovery.
|
|
125
|
+
|
|
126
|
+
## Read the documentation
|
|
127
|
+
|
|
128
|
+
| Guide | What you will learn |
|
|
129
|
+
| --- | --- |
|
|
130
|
+
| [Getting started](docs/getting-started.md) | Install, run the demo, create a store and open the dashboard. |
|
|
131
|
+
| [Using MemoryKing with agents](docs/agent-guide.md) | Capture → brief → checkpoint → resume → handoff; Python, lean and full MCP profiles for any host, and automatic capture from hooks. |
|
|
132
|
+
| [Deployment and configuration](docs/deployment.md) | Local/shared/Docker setups, credentials, configuration, upgrades and recovery. |
|
|
133
|
+
| [How it is designed](docs/design.md) | Storage, knowledge review, retrieval, permissions and recovery guarantees. |
|
|
134
|
+
| [Feature and API reference](docs/reference.md) | Interfaces, optional capabilities, limits and capacity, metrics, migration and troubleshooting. |
|
|
135
|
+
| [Error codes](docs/error-codes.md) | Every error code with the next move, generated from the service's own table. |
|
|
136
|
+
| [Contributing](CONTRIBUTING.md) | Build, test and maintain the project locally. |
|
|
137
|
+
|
|
138
|
+
## Current status
|
|
139
|
+
|
|
140
|
+
**Early preview for local evaluation; not yet production-qualified.** Core behavior has automated coverage, but measured workload targets have not been met. Improved real-task success or reduced token cost has not yet been demonstrated. Windows, complete browser/device coverage, automatic failover and production recovery targets are not qualified. Third-party agent hosts need integration testing.
|
|
141
|
+
|
|
142
|
+
MemoryKing helps preserve and inspect context; it does not make an agent's conclusions automatically correct. Use reviewed evidence and appropriate human approval for consequential work. See the [security model](SECURITY.md) and [current limits](docs/reference.md#current-limits).
|
|
143
|
+
|
|
144
|
+
MemoryKing is released under the [Apache License 2.0](LICENSE). A packaged release (a Python wheel and a container image, each with recorded checksums) is built from this repository; the first public upload is in preparation. See [distribution](CONTRIBUTING.md#distribution).
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
<p align="center"><img src="src/memoryking/adapters/web/elephant.png" width="180" alt="MemoryKing" /></p>
|
|
2
|
+
|
|
3
|
+
# Give your AI agents a memory they can pick up again
|
|
4
|
+
|
|
5
|
+
MemoryKing keeps the useful context behind an agent's work: what it learned, what it tried, what must not be forgotten, and what should happen next.
|
|
6
|
+
|
|
7
|
+
Think of it as a **shared project notebook with a save point**. When a conversation ends, an agent restarts, or another agent takes over, the work can continue from a recorded state instead of starting with a blank page.
|
|
8
|
+
|
|
9
|
+
It is a service that you connect to your agents. It does not automatically read your chats or run agents for you.
|
|
10
|
+
|
|
11
|
+
## Why it is useful
|
|
12
|
+
|
|
13
|
+
Imagine an agent investigating a checkout bug. It discovers that a retry can charge a customer twice, tries a fix that fails, and runs out of context before finishing.
|
|
14
|
+
|
|
15
|
+
With MemoryKing, it can leave the next agent:
|
|
16
|
+
|
|
17
|
+
- **The goal:** fix the retry without creating duplicate charges.
|
|
18
|
+
- **The evidence:** the relevant error and test output, with their sources.
|
|
19
|
+
- **The failed approach:** what was tried and why not to repeat it.
|
|
20
|
+
- **The unfinished work:** the patch state, missing tests and next action.
|
|
21
|
+
- **The boundaries:** use the sandbox and keep production changes subject to approval.
|
|
22
|
+
|
|
23
|
+
The next agent receives a focused briefing and the saved task state. A reviewer can see the evidence and what is still unverified. This is an illustrative workflow; your integration supplies the observations and checks.
|
|
24
|
+
|
|
25
|
+
```mermaid
|
|
26
|
+
flowchart LR
|
|
27
|
+
A[Agent does work] --> B[Save findings and task state]
|
|
28
|
+
B --> C[MemoryKing checks access and relevance]
|
|
29
|
+
C --> D[Next session gets a focused briefing]
|
|
30
|
+
D --> E[Agent continues or hands off]
|
|
31
|
+
E --> B
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## What it does for agents
|
|
35
|
+
|
|
36
|
+
| Need | What MemoryKing provides |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| Remember useful findings | Searchable observations with source attribution; reviewed knowledge stays distinct from unverified notes. |
|
|
39
|
+
| Resume unfinished work | Checkpoints containing the objective, constraints, failed attempts, verification gaps and next actions, opened by a three-sentence "where this left off" summary. |
|
|
40
|
+
| Work together | Handoffs bound to the recipient's current permissions. |
|
|
41
|
+
| Keep context manageable | Focused briefings with explicit output budgets and links back to evidence. |
|
|
42
|
+
| Avoid stale advice | Repository identity, applicability rules and freshness checks for guidance tied to code. |
|
|
43
|
+
| Recover safely | Records of uncertain operations and history-aware backup/restore, so a restart does not silently authorize repeating an action. |
|
|
44
|
+
| Understand what happened | A dashboard with capacity, task progress, a per-project timeline, a memory graph, on-demand briefings with their receipts, and retrieval history. |
|
|
45
|
+
| Fit any agent host | A lean five-tool MCP profile with defaults for Claude Code, Codex, Grok or any stdio host; cited Markdown briefings; capture from the CLI, pytest or git hooks. |
|
|
46
|
+
| Know what to do when something is refused | Every error reply carries a one-line hint, and a [generated page](docs/error-codes.md) lists them all. |
|
|
47
|
+
|
|
48
|
+
The core runs locally **without a model account, GPU or paid API**. A shared PostgreSQL profile supports multiple agents and tenants. Optional local embeddings add semantic search. If you do want MemoryKing itself to talk to a model (Anthropic, OpenAI, xAI, Google Vertex AI, or one running on your own machine), you write a short policy saying which, and every request it sends is checked against that policy and recorded.
|
|
49
|
+
|
|
50
|
+
## See it work
|
|
51
|
+
|
|
52
|
+
You need Python **3.12** and Git. Repository access is currently private. From a terminal:
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
git clone https://github.com/jamesking-us/memoryking.git
|
|
56
|
+
cd memoryking
|
|
57
|
+
python3.12 -m venv .venv
|
|
58
|
+
.venv/bin/python -I -m pip install --require-hashes -r requirements-build.lock -r requirements-core.lock
|
|
59
|
+
.venv/bin/python -I -m pip install --no-build-isolation --no-deps .
|
|
60
|
+
.venv/bin/python examples/remember_and_resume.py
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
The example creates a temporary store, saves a finding and an unfinished task, closes the first connection, and resumes through a new client. It prints a readable walkthrough, makes no model requests, and removes its temporary data when finished.
|
|
64
|
+
|
|
65
|
+
For a lasting installation and the browser dashboard, follow the [getting started guide](docs/getting-started.md): name your store once with `memoryking profile add`, then `status`, `doctor`, `dashboard open` and `credential issue` need no paths. If you are evaluating the idea rather than installing software, start with the [agent workflows](docs/agent-guide.md).
|
|
66
|
+
|
|
67
|
+
## See what your agents are doing
|
|
68
|
+
|
|
69
|
+

|
|
70
|
+
|
|
71
|
+
*Dashboard overview with synthetic example data: capacity first, then the projects you can read, then the project's task activity with its summary. Progress reflects saved agent reports and evidence.*
|
|
72
|
+
|
|
73
|
+
The dashboard helps you inspect recorded work without reading a long chat transcript. Projects you can read are listed with their record counts; pick one and every view follows it.
|
|
74
|
+
|
|
75
|
+
- **Overview:** capacity use for each bounded resource, with a warning from 80 percent.
|
|
76
|
+
- **Task activity:** saved goals, completed and pending criteria, blockers and observed heartbeats.
|
|
77
|
+
- **Memory:** ask for the briefing an agent would receive and verify its replay, browse the project timeline, review proposed knowledge, preview a purge, and explore an interactive graph of memories and evidence, coloured by how far each record has been reviewed, with a tap through to the briefings that used it.
|
|
78
|
+
- **History and review:** inspect changes, review proposals and preview affected content.
|
|
79
|
+
- **Retrieval history:** see the exact briefing returned, its sources and recorded usage.
|
|
80
|
+
- **Team:** who did what in a project, the permissions that allow it, a revoke button, and an audit export; the overview lists your projects as cards you can open and link to.
|
|
81
|
+
- **Appearance:** textured dark and light themes, a crowned cybernetic elephant, an optional depth-tilt animation that respects reduced motion, and a phone layout for checking on agents away from the desk.
|
|
82
|
+
|
|
83
|
+
Agents must publish their state through the supported interfaces. A displayed heartbeat is an observation, not proof that an agent is still working; missing cost data stays unknown.
|
|
84
|
+
|
|
85
|
+
## Choose your setup
|
|
86
|
+
|
|
87
|
+
| Setup | Suitable for | What runs |
|
|
88
|
+
| --- | --- | --- |
|
|
89
|
+
| Local | One person or agents on one computer | Python service, SQLite, private local files; optional browser dashboard. |
|
|
90
|
+
| Shared | Multiple agents using a central service | PostgreSQL, authenticated HTTP/MCP, separate database roles and recovery storage. |
|
|
91
|
+
| Docker evaluation | Trying the shared profile on one machine | A source-built Compose stack with loopback HTTPS. |
|
|
92
|
+
|
|
93
|
+
See [deployment and configuration](docs/deployment.md) for commands, prerequisites, backup and recovery.
|
|
94
|
+
|
|
95
|
+
## Read the documentation
|
|
96
|
+
|
|
97
|
+
| Guide | What you will learn |
|
|
98
|
+
| --- | --- |
|
|
99
|
+
| [Getting started](docs/getting-started.md) | Install, run the demo, create a store and open the dashboard. |
|
|
100
|
+
| [Using MemoryKing with agents](docs/agent-guide.md) | Capture → brief → checkpoint → resume → handoff; Python, lean and full MCP profiles for any host, and automatic capture from hooks. |
|
|
101
|
+
| [Deployment and configuration](docs/deployment.md) | Local/shared/Docker setups, credentials, configuration, upgrades and recovery. |
|
|
102
|
+
| [How it is designed](docs/design.md) | Storage, knowledge review, retrieval, permissions and recovery guarantees. |
|
|
103
|
+
| [Feature and API reference](docs/reference.md) | Interfaces, optional capabilities, limits and capacity, metrics, migration and troubleshooting. |
|
|
104
|
+
| [Error codes](docs/error-codes.md) | Every error code with the next move, generated from the service's own table. |
|
|
105
|
+
| [Contributing](CONTRIBUTING.md) | Build, test and maintain the project locally. |
|
|
106
|
+
|
|
107
|
+
## Current status
|
|
108
|
+
|
|
109
|
+
**Early preview for local evaluation; not yet production-qualified.** Core behavior has automated coverage, but measured workload targets have not been met. Improved real-task success or reduced token cost has not yet been demonstrated. Windows, complete browser/device coverage, automatic failover and production recovery targets are not qualified. Third-party agent hosts need integration testing.
|
|
110
|
+
|
|
111
|
+
MemoryKing helps preserve and inspect context; it does not make an agent's conclusions automatically correct. Use reviewed evidence and appropriate human approval for consequential work. See the [security model](SECURITY.md) and [current limits](docs/reference.md#current-limits).
|
|
112
|
+
|
|
113
|
+
MemoryKing is released under the [Apache License 2.0](LICENSE). A packaged release (a Python wheel and a container image, each with recorded checksums) is built from this repository; the first public upload is in preparation. See [distribution](CONTRIBUTING.md#distribution).
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools==84.2.1", "wheel==0.48.0"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "memoryking"
|
|
7
|
+
version = "0.1.0a1"
|
|
8
|
+
description = "MemoryKing local memory, checkpoint and recovery service"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.12,<3.13"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
13
|
+
authors = [{ name = "James King" }]
|
|
14
|
+
dependencies = ["jsonschema==4.26.0"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 3 - Alpha",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"Operating System :: MacOS",
|
|
19
|
+
"Operating System :: POSIX :: Linux",
|
|
20
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
21
|
+
"Programming Language :: Python :: 3.12",
|
|
22
|
+
"Topic :: Software Development :: Libraries",
|
|
23
|
+
]
|
|
24
|
+
|
|
25
|
+
[project.urls]
|
|
26
|
+
Repository = "https://github.com/jamesking-us/memoryking"
|
|
27
|
+
|
|
28
|
+
[project.scripts]
|
|
29
|
+
memoryking = "memoryking.__main__:main"
|
|
30
|
+
memoryking-migrate = "memoryking.migration:main"
|
|
31
|
+
memoryking-shared = "memoryking.shared:main"
|
|
32
|
+
memoryking-reference-agent = "memoryking.reference_agent:main"
|
|
33
|
+
memoryking-repository-worker = "memoryking.repository_worker:main"
|
|
34
|
+
memoryking-embedding-worker = "memoryking.embedding_worker:main"
|
|
35
|
+
|
|
36
|
+
[project.optional-dependencies]
|
|
37
|
+
tokenizers = ["tiktoken==0.12.0"]
|
|
38
|
+
embeddings = ["onnxruntime==1.23.2", "numpy==2.5.4", "tokenizers==0.23.3"]
|
|
39
|
+
shared = ["psycopg[binary]==3.3.6", "psycopg-pool==3.3.3", "mcp==2.3.0"]
|
|
40
|
+
|
|
41
|
+
[tool.setuptools.packages.find]
|
|
42
|
+
where = ["src"]
|
|
43
|
+
|
|
44
|
+
[tool.setuptools.package-data]
|
|
45
|
+
"memoryking" = ["py.typed"]
|
|
46
|
+
"memoryking.contracts" = ["*.json", "py.typed"]
|
|
47
|
+
"memoryking.adapters" = ["*.sql", "*.json", "web/*", "tokenizers/*", "models/*.json"]
|
|
48
|
+
|
|
49
|
+
[tool.ruff]
|
|
50
|
+
target-version = "py312"
|
|
51
|
+
line-length = 100
|
|
52
|
+
extend-exclude = ["tmp", "docs/reports", "output"]
|
|
53
|
+
|
|
54
|
+
[tool.ruff.lint]
|
|
55
|
+
select = ["E4", "E7", "E9", "F", "I", "B"]
|
|
56
|
+
|
|
57
|
+
[tool.ruff.format]
|
|
58
|
+
exclude = ["src/memoryking/contracts/generated.py", "src/memoryking/contracts/retrieval_generated.py", "src/memoryking/contracts/working_generated.py", "src/memoryking/contracts/handoff_generated.py", "src/memoryking/contracts/inference_generated.py", "src/memoryking/contracts/repository_generated.py", "src/memoryking/contracts/embedding_generated.py", "src/memoryking/contracts/processing_generated.py", "src/memoryking/contracts/experience_generated.py"]
|
|
59
|
+
|
|
60
|
+
[tool.mypy]
|
|
61
|
+
python_version = "3.12"
|
|
62
|
+
strict = true
|
|
63
|
+
files = ["src/memoryking"]
|
|
64
|
+
|
|
65
|
+
[[tool.mypy.overrides]]
|
|
66
|
+
module = ["jsonschema", "jsonschema.*"]
|
|
67
|
+
ignore_missing_imports = true
|