Configuration
API Key
To use the Omi MCP server, you need an API key. You can generate one in the Omi app underSettings > Developer > MCP
. The API key can be provided with each tool call. If not provided, the server will use the OMI_API_KEY
environment variable as a fallback.
Usage with Claude Desktop
Add this to yourclaude_desktop_config.json
:
Install docker, https://orbstack.dev/ is great.
Replace your_api_key_here
with the key you generated in the Omi app.
Examples (langchain, openai Agents, dspy)
https://github.com/BasedHardware/omi/tree/main/mcp/examplesTools
-
get_memories
- Retrieve a list of user memories
- Inputs:
limit
(number, optional): Maximum number of memories to retrieve (default: 100)categories
(array of MemoryFilterOptions, optional): Categories of memories to retrieve (default: [])
- Returns: JSON object containing list of memories
-
create_memory
- Create a new memory
- Inputs:
content
(string): Content of the memorycategory
(MemoryFilterOptions): Category of the memory
- Returns: Created memory object
-
delete_memory
- Delete a memory by ID
- Inputs:
memory_id
(string): ID of the memory to delete
- Returns: Status of the operation
-
edit_memory
- Edit a memory’s content
- Inputs:
memory_id
(string): ID of the memory to editcontent
(string): New content for the memory
- Returns: Status of the operation
-
get_conversations
- Retrieve a list of user conversations
- Inputs:
include_discarded
(boolean, optional): Whether to include discarded conversations (default: false)limit
(number, optional): Maximum number of conversations to retrieve (default: 25)
- Returns: List of conversation objects containing transcripts, timestamps, geolocation and structured summaries
Debugging
You can use the MCP inspector to debug the server. For uvx installations:tail -n 20 -f ~/Library/Logs/Claude/mcp-server-omi.log
will show the logs from the server and may
help you debug any issues.
Advanced
Custom Backend URL
If you are self-hosting the Omi backend, you can specify the API endpoint by setting theOMI_API_BASE_URL
environment variable.