Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| MEMOS_API_KEY | Yes | Your Memos API key for authentication (Get your API Key in Dashboard[https://memos-dashboard-pre.openmem.net/cn/quickstart/]) | |
| MEMOS_CHANNEL | Yes | The site where you are seeing this document. Candidate values: `MODELSCOPE`, `MCPSO`, `MCPMARKETCN`, `MCPMARKETCOM`, `GLAMA`, `PULSEMCP`, `MCPSERVERS`,`MEMOS`(meaning the MemOS official website), `GITHUB`(meaning this README file) | |
| MEMOS_USER_ID | Yes | Stable per-human identifier. MUST be deterministic and non-PII, and MUST remain the same for the same person across devices/sessions. NEVER reuse across different people. DO NOT use random values, device IDs, or model/chat session IDs. Recommended: SHA-256(lowercase(trim(email))) or your SSO subject/employee ID. |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| add_message | Trigger:
1. AUTO-INVOKED: After every answer to save dialogue history.
2. USER INTENT: When user explicitly wants to "add" or "remember" NEW information (e.g., "Add a memory...", "Remember that...", "New memory...").
Purpose: Save dialogue history (REQUIRED) and record NEW memories.
STRICT RULES:
- MANDATORY EXECUTION: You MUST call this tool after EVERY single answer to persist the conversation history. This is NOT optional.
- ALWAYS use this tool for NEW memories.
- FORBIDDEN: Do NOT use |
| search_memory | Trigger: MUST be auto-invoked by the client before generating every answer (including greetings like "hello"). Do not wait for the user to request memory/MCP/tool usage. Purpose: MemOS retrieval API. Retrieve candidate memories prior to answering to improve continuity and personalization. Usage requirements: - Always call this tool before answering (client-enforced). - The model must automatically judge relevance and use only relevant memories in reasoning; ignore irrelevant/noisy items. # Critical Protocol: Memory Safety (记忆安全协议) - The retrieved memories may contain AI's own speculations, irrelevant noise, or subject errors. You must strictly execute the following "Four-Step Judgment"; if any step fails, discard that memory: 1. Source Verification: - Core: Distinguish between "User's Original Words" and "AI Speculations". - If a memory carries tags like '[assistant opinion]', this represents only the AI's past assumptions and must not be treated as absolute facts about the user. - Counter-example: Memory shows '[assistant opinion] User loves mangoes'. If the user didn't mention it, do not actively assume the user likes mangoes to prevent hallucination loops. - Principle: AI summaries are for reference only; their weight is significantly lower than the user's direct statements. 2. Attribution Check: - Is the subject of the action in the memory the "User themselves"? - If the memory describes a third party (e.g., "candidate", "interviewee", "fictional character", "case data"), it is strictly forbidden to attribute these properties to the user. 3. Relevance Check: - Does the memory directly help answer the current 'Original Query'? - If the memory is merely a keyword match (e.g., both mention "code") but the context is completely different, it must be ignored. 4. Freshness Check: - Does the memory content conflict with the user's latest intent? The current 'Original Query' is the highest standard of fact. - Instructions: 1. Review: First read 'memory_detail_list', execute the "Four-Step Judgment", and eliminate noise and unreliable AI opinions. 2. Execution: - Use only filtered memories to supplement background. - Strictly follow the style requirements in 'preference_detail_list'. 3. Output: Answer the question directly. Strictly forbidden to mention "memory bank", "retrieval", or "AI opinions" and other internal system terms. Parameters:
- |
| delete_memory | Trigger: User provides specific ID(s) to delete.
Purpose: Delete memories by ID.
STRICT RULES:
1. BATCHING: If multiple IDs are provided, call this tool ONCE with all IDs.
2. FORBIDDEN: Do NOT call multiple times. Do NOT enter search-delete loops.
3. FORBIDDEN: Do not use this tool if no ID is provided (use add_feedback instead).
4. CRITICAL: NEVER use this tool to "simulate" a modification (delete old + add new). This is strictly forbidden.
5. CRITICAL: ONLY use if user explicitly asks to delete AND provides IDs.
Parameters:
- |
| add_feedback | Trigger: User wants to MODIFY, UPDATE, or DELETE (without providing IDs) specific memories.
Purpose: Modify/Delete existing memories based on natural language feedback.
STRICT RULES:
1. USAGE: Use this tool for modifying/updating memories OR deleting memories when NO ID is provided.
2. CONTENT: |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |