Skip to content
This page was generated and translated with the assistance of AI. If you spot any inaccuracies, feel free to help improve it. Edit on GitHub

Configuration Reference ​

PRX-Memory is configured entirely through environment variables. This page documents every variable grouped by category.

Transport ​

VariableValuesDefaultDescription
PRX_MEMORYD_TRANSPORTstdio, httpstdioServer transport mode
PRX_MEMORY_HTTP_ADDRhost:port127.0.0.1:8787HTTP server bind address

Storage ​

VariableValuesDefaultDescription
PRX_MEMORY_BACKENDjson, sqlite, lancedbjsonStorage backend
PRX_MEMORY_DBfile/directory path--Database file or directory path

Embedding ​

VariableValuesDefaultDescription
PRX_EMBED_PROVIDERopenai-compatible, jina, gemini--Embedding provider
PRX_EMBED_API_KEYAPI key string--Embedding provider API key
PRX_EMBED_MODELmodel nameprovider-specificEmbedding model name
PRX_EMBED_BASE_URLURLprovider-specificCustom API endpoint URL

Provider Fallback Keys ​

If PRX_EMBED_API_KEY is not set, the system checks these provider-specific keys:

ProviderFallback Key
jinaJINA_API_KEY
geminiGEMINI_API_KEY

Reranking ​

VariableValuesDefaultDescription
PRX_RERANK_PROVIDERjina, cohere, pinecone, pinecone-compatible, nonenoneRerank provider
PRX_RERANK_API_KEYAPI key string--Rerank provider API key
PRX_RERANK_MODELmodel nameprovider-specificRerank model name
PRX_RERANK_ENDPOINTURLprovider-specificCustom rerank endpoint
PRX_RERANK_API_VERSIONversion string--API version (pinecone-compatible only)

Provider Fallback Keys ​

If PRX_RERANK_API_KEY is not set, the system checks these provider-specific keys:

ProviderFallback Key
jinaJINA_API_KEY
cohereCOHERE_API_KEY
pineconePINECONE_API_KEY

Standardization ​

VariableValuesDefaultDescription
PRX_MEMORY_STANDARD_PROFILEzero-config, governedzero-configStandardization profile
PRX_MEMORY_DEFAULT_PROJECT_TAGtag stringprx-memoryDefault project tag
PRX_MEMORY_DEFAULT_TOOL_TAGtag stringmcpDefault tool tag
PRX_MEMORY_DEFAULT_DOMAIN_TAGtag stringgeneralDefault domain tag

Streaming Sessions ​

VariableValuesDefaultDescription
PRX_MEMORY_STREAM_SESSION_TTL_MSmilliseconds300000Stream session time-to-live

Observability ​

Cardinality Controls ​

VariableDefaultDescription
PRX_METRICS_MAX_RECALL_SCOPE_LABELS32Max distinct scope labels in metrics
PRX_METRICS_MAX_RECALL_CATEGORY_LABELS32Max distinct category labels in metrics
PRX_METRICS_MAX_RERANK_PROVIDER_LABELS16Max distinct rerank provider labels

Alert Thresholds ​

VariableDefaultDescription
PRX_ALERT_TOOL_ERROR_RATIO_WARN0.05Tool error ratio warning threshold
PRX_ALERT_TOOL_ERROR_RATIO_CRIT0.20Tool error ratio critical threshold
PRX_ALERT_REMOTE_WARNING_RATIO_WARN0.25Remote warning ratio warning threshold
PRX_ALERT_REMOTE_WARNING_RATIO_CRIT0.60Remote warning ratio critical threshold

Example: Minimal Configuration ​

bash
PRX_MEMORYD_TRANSPORT=stdio
PRX_MEMORY_DB=./data/memory-db.json

Example: Full Production Configuration ​

bash
# Transport
PRX_MEMORYD_TRANSPORT=http
PRX_MEMORY_HTTP_ADDR=127.0.0.1:8787

# Storage
PRX_MEMORY_BACKEND=sqlite
PRX_MEMORY_DB=./data/memory.db

# Embedding
PRX_EMBED_PROVIDER=jina
PRX_EMBED_API_KEY=your_jina_key
PRX_EMBED_MODEL=jina-embeddings-v3

# Reranking
PRX_RERANK_PROVIDER=cohere
PRX_RERANK_API_KEY=your_cohere_key
PRX_RERANK_MODEL=rerank-v3.5

# Governance
PRX_MEMORY_STANDARD_PROFILE=governed
PRX_MEMORY_DEFAULT_PROJECT_TAG=my-project
PRX_MEMORY_DEFAULT_TOOL_TAG=mcp
PRX_MEMORY_DEFAULT_DOMAIN_TAG=backend

# Sessions
PRX_MEMORY_STREAM_SESSION_TTL_MS=600000

# Observability
PRX_METRICS_MAX_RECALL_SCOPE_LABELS=64
PRX_ALERT_TOOL_ERROR_RATIO_WARN=0.03
PRX_ALERT_TOOL_ERROR_RATIO_CRIT=0.15

Next Steps ​

Released under the Apache-2.0 License.