The Omi MCP Server enables interaction with the Omi API for managing conversations and memories for specific users.
Key capabilities include:
- Retrieve Conversations: Fetch user conversations with pagination, filtering by status, and options to include discarded conversations
- Retrieve Memories: Access user memories with pagination options
- Create Conversations: Generate new conversations with text content, metadata (geolocation, timestamps), and source information
- Create Memories: Create memories by extracting from text or directly providing memory objects with optional tags
- Integration Options: Compatible with Claude (via Anthropic Console or API) and Cursor for streamlined API calls
- Logging and Testing: Includes built-in logging for debugging and a test client for validating functionality
Handles environment variable configuration for the MCP server to store API keys and application IDs for Omi API authentication
Used for package management and running script commands to build, start, and test the MCP server
Omi MCP Server
This project provides a Model Context Protocol (MCP) server for interacting with the Omi API. The server provides tools for reading conversations and memories, as well as creating new conversations and memories.
Setup
- Clone the repository
- Install dependencies with
npm install
- Create a
.env
file with the following variables:
Usage
Installing via Smithery
To install Omi MCP Server for Claude Desktop automatically via Smithery:
Building the Server
Running the Server
Development Mode
For development with hot-reloading:
Testing the Server
A simple test client is included to interact with the MCP server. After building the project, run:
Or directly:
This will start the MCP server and provide an interactive menu to test the available tools. The test client uses a default test user ID (test-user-123
) for all operations.
Clean and Rebuild
To clean the build directory and rebuild from scratch:
Configuration with Claude and Cursor
Claude Configuration
To use this MCP server with Claude via Anthropic Console or API:
- Start the MCP server locally:
- When setting up your Claude conversation, configure the MCP connection:
- Example prompt to Claude:
- Claude will use the MCP to execute the
read_omi_conversations
tool:
Cursor Configuration
To use this MCP server with Cursor:
- Start the MCP server in a terminal:
- In Cursor, go to Settings > Extensions > MCP Servers
- Add a new MCP server with these settings:
- Name: Omi API
- URL: stdio:/path/to/your/omi-mcp-local/dist/index.js
- Enable the server
- Now you can use the Omi tools directly within Cursor. For example:
- Cursor will communicate with your MCP server to execute the necessary API calls.
Available Tools
The MCP server provides the following tools:
read_omi_conversations
Retrieves conversations from Omi for a specific user, with optional filters.
Parameters:
user_id
(string): The user ID to fetch conversations forlimit
(number, optional): Maximum number of conversations to returnoffset
(number, optional): Number of conversations to skip for paginationinclude_discarded
(boolean, optional): Whether to include discarded conversationsstatuses
(string, optional): Comma-separated list of statuses to filter conversations by
read_omi_memories
Retrieves memories from Omi for a specific user.
Parameters:
user_id
(string): The user ID to fetch memories forlimit
(number, optional): Maximum number of memories to returnoffset
(number, optional): Number of memories to skip for pagination
create_omi_conversation
Creates a new conversation in Omi for a specific user.
Parameters:
text
(string): The full text content of the conversationuser_id
(string): The user ID to create the conversation fortext_source
(string): Source of the text content (options: "audio_transcript", "message", "other_text")started_at
(string, optional): When the conversation/event started (ISO 8601 format)finished_at
(string, optional): When the conversation/event ended (ISO 8601 format)language
(string, optional): Language code (default: "en")geolocation
(object, optional): Location data for the conversationlatitude
(number): Latitude coordinatelongitude
(number): Longitude coordinate
text_source_spec
(string, optional): Additional specification about the source
create_omi_memories
Creates new memories in Omi for a specific user.
Parameters:
user_id
(string): The user ID to create memories fortext
(string, optional): The text content from which memories will be extractedmemories
(array, optional): An array of explicit memory objects to be created directlycontent
(string): The content of the memorytags
(array of strings, optional): Tags for the memory
text_source
(string, optional): Source of the text contenttext_source_spec
(string, optional): Additional specification about the source
Testing
To test the MCP server, you can use the provided test client:
This will start an interactive test client that allows you to:
- Get conversations
- Get memories
- Create a conversation
- Quit
The test client uses a default test user ID (test-user-123
) for all operations.
Logging
The MCP server includes built-in logging functionality that writes to both the console and a log file. This is useful for debugging and monitoring server activity.
Log File Location
Logs are written to logs/mcp-server.log
in your project directory. The log file includes timestamps and detailed information about:
- Server startup and shutdown
- All API requests and responses
- Error messages and stack traces
- API calls to Omi
- Request parameters and response data
Viewing Logs
You can view the logs in real-time using the tail
command:
This will show you live updates as the server processes requests and interacts with the Omi API.
Log Format
Each log entry follows this format:
The timestamp is in ISO 8601 format, making it easy to correlate events and debug issues.
You must be authenticated.
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
A Model Context Protocol server that enables AI assistants to interact with the Omi API for retrieving and creating conversations and memories for users.
Related MCP Servers
- -securityFlicense-qualityA Model Context Protocol server that enables AI assistants to explore and interact with Cursor IDE's SQLite databases, providing access to project data, chat history, and composer information.Last updated -10Python
- -securityFlicense-qualityA versatile Model Context Protocol server that enables AI assistants to manage calendars, track tasks, handle emails, search the web, and control smart home devices.Last updated -2Python
- AsecurityFlicenseAqualityA Model Context Protocol server that enables AI assistants to interact with Bluesky/ATProtocol, providing authentication, timeline access, post creation, and social features like likes and follows.Last updated -1810TypeScript
- -securityFlicense-qualityA Model Context Protocol server that provides persistent task management capabilities for AI assistants, allowing them to create, update, and track tasks beyond their usual context limitations.Last updated -1TypeScript