Skip to main content
Glama
fourcolors

Omi MCP Server

by fourcolors

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

  1. Clone the repository

  2. Install dependencies with npm install

  3. Create a .env file with the following variables:

    API_KEY=your_api_key
    APP_ID=your_app_id

Related MCP server: Omi Memories MCP Server

Usage

Installing via Smithery

To install Omi MCP Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @fourcolors/omi-mcp --client claude

Building the Server

npm run build

Running the Server

npm run start

Development Mode

For development with hot-reloading:

npm run dev

Testing the Server

A simple test client is included to interact with the MCP server. After building the project, run:

npm run test

Or directly:

./test-mcp-client.js

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:

npm run rebuild

Configuration with Claude and Cursor

Claude Configuration

To use this MCP server with Claude via Anthropic Console or API:

  1. Start the MCP server locally:

    npm run start
  2. When setting up your Claude conversation, configure the MCP connection:

    {
        "mcp_config": {
            "transports": [
                {
                    "type": "stdio",
                    "executable": {
                        "path": "/path/to/your/omi-mcp-local/dist/index.js",
                        "args": []
                    }
                }
            ]
        }
    }
  3. Example prompt to Claude:

    Please fetch the latest 5 conversations for user "user123" using the Omi API.
  4. Claude will use the MCP to execute the read_omi_conversations tool:

    {
        "id": "req-1",
        "type": "request",
        "method": "tools.read_omi_conversations",
        "params": {
            "user_id": "user123",
            "limit": 5
        }
    }

Cursor Configuration

To use this MCP server with Cursor:

  1. Start the MCP server in a terminal:

    npm run start
  2. In Cursor, go to Settings > Extensions > MCP Servers

  3. 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

  4. Now you can use the Omi tools directly within Cursor. For example:

    @Omi API Please fetch memories for user "user123" and summarize them.
  5. 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 for

  • limit (number, optional): Maximum number of conversations to return

  • offset (number, optional): Number of conversations to skip for pagination

  • include_discarded (boolean, optional): Whether to include discarded conversations

  • statuses (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 for

  • limit (number, optional): Maximum number of memories to return

  • offset (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 conversation

  • user_id (string): The user ID to create the conversation for

  • text_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 conversation

    • latitude (number): Latitude coordinate

    • longitude (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 for

  • text (string, optional): The text content from which memories will be extracted

  • memories (array, optional): An array of explicit memory objects to be created directly

    • content (string): The content of the memory

    • tags (array of strings, optional): Tags for the memory

  • text_source (string, optional): Source of the text content

  • text_source_spec (string, optional): Additional specification about the source

Testing

To test the MCP server, you can use the provided test client:

node test-mcp-client.js

This will start an interactive test client that allows you to:

  1. Get conversations

  2. Get memories

  3. Create a conversation

  4. 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:

tail -f logs/mcp-server.log

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:

[2024-03-21T12:34:56.789Z] Log message here

The timestamp is in ISO 8601 format, making it easy to correlate events and debug issues.

Available Tools

4 tools
create_omi_conversationC

Creates a new Omi conversation with text content and metadata

ParametersJSON Schema
NameRequiredDescriptionDefault
finished_atNoWhen the conversation/event ended in ISO 8601 format. Optional.
geolocationNoLocation data for the conversation. Optional object containing latitude and longitude.
languageNoLanguage code (e.g., "en" for English). Optional, defaults to "en".en
started_atNoWhen the conversation/event started in ISO 8601 format. Optional.
textYesThe full text content of the conversation
text_sourceYesSource of the text content. Required. Options: "audio_transcript", "message", "other_text".
text_source_specNoAdditional specification about the source. Optional.
user_idYesThe user ID to create the conversation for

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a creation operation, implying it's a write/mutation tool, but doesn't disclose any behavioral traits like permission requirements, rate limits, side effects, or what happens on success/failure. For a creation tool with zero annotation coverage, this leaves significant gaps in understanding how it behaves.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that gets straight to the point without unnecessary words. It's appropriately sized for a creation tool, though it could potentially benefit from slightly more context given the lack of annotations and usage guidelines.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (8 parameters, nested objects, no output schema, and no annotations), the description is insufficient. It doesn't explain what a successful creation returns, error conditions, or behavioral constraints. For a creation tool with multiple parameters and no structured safety hints, more descriptive context is needed to be complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, so the schema already documents all 8 parameters thoroughly. The description adds minimal value beyond the schema by mentioning 'text content and metadata', which loosely maps to the 'text' and other fields. Since the schema does the heavy lifting, the baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'creates' and the resource 'new Omi conversation', specifying it includes 'text content and metadata'. This distinguishes it from sibling tools like 'read_omi_conversations' (read vs. create) and 'create_omi_memories' (conversation vs. memories). However, it doesn't explicitly differentiate from 'create_omi_memories' beyond the resource name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to choose this over 'create_omi_memories' or whether it's for initial conversation creation versus updates. There's no context about prerequisites, dependencies, or typical use cases.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_omi_memoriesB

Creates Omi memories by extracting from text or using explicit memory objects

ParametersJSON Schema
NameRequiredDescriptionDefault
memoriesNoAn array of explicit memory objects to be created directly. Either this or text must be provided.
textNoThe text content from which memories will be extracted. Either this or memories must be provided.
text_sourceNoSource of the text content. Optional. Options: "email", "social_post", "other".
text_source_specNoAdditional specification about the source. Optional.
user_idYesThe user ID to create memories for

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. While it mentions the creation action and two input methods, it doesn't disclose important behavioral traits like whether this is a write operation (implied but not stated), what permissions are needed, whether it's idempotent, what happens on failure, or what the return format looks like. For a creation tool with zero annotation coverage, this leaves significant gaps in understanding how the tool behaves.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that clearly states the tool's purpose and two key input methods. It's front-loaded with essential information and contains no redundant or unnecessary words, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given that this is a creation tool with no annotations and no output schema, the description is insufficiently complete. It doesn't explain what 'Omi memories' are in this context, what the tool returns (e.g., success/failure, created memory IDs), or any behavioral constraints (e.g., rate limits, authentication needs). For a tool with 5 parameters and significant functionality, more context is needed to use it effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, meaning all parameters are well-documented in the input schema itself. The description adds minimal value beyond the schema by mentioning 'extracting from text' (hinting at the 'text' parameter) and 'using explicit memory objects' (hinting at the 'memories' parameter), but doesn't provide additional semantic context like examples, edge cases, or relationships between parameters. This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('creates Omi memories') and specifies two methods ('extracting from text' or 'using explicit memory objects'), which gives a good sense of what the tool does. However, it doesn't differentiate itself from sibling tools like 'create_omi_conversation' or 'read_omi_memories', leaving some ambiguity about when to use this specific memory creation tool versus other memory/conversation tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by mentioning two input methods ('extracting from text' or 'using explicit memory objects'), which provides some context for when to use it. However, it doesn't explicitly state when to choose this tool over alternatives like 'create_omi_conversation' or 'read_omi_memories', nor does it mention any prerequisites or exclusions. The guidance is present but incomplete.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

read_omi_conversationsC

Retrieves user conversations from Omi with pagination and filtering options

ParametersJSON Schema
NameRequiredDescriptionDefault
include_discardedNoWhether to include discarded conversations (default: false)
limitNoMaximum number of conversations to return (max: 1000, default: 100)
offsetNoNumber of conversations to skip for pagination (default: 0)
statusesNoComma-separated list of statuses to filter conversations by
user_idYesThe user ID to fetch conversations for

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'pagination and filtering options', which hints at some behavior, but fails to cover critical aspects like authentication requirements, rate limits, error handling, or what the return format looks like (e.g., JSON structure). For a retrieval tool with 5 parameters, this leaves significant gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core purpose ('retrieves user conversations from Omi') and adds relevant details ('with pagination and filtering options'). There is no wasted verbiage, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of a retrieval tool with 5 parameters, no annotations, and no output schema, the description is incomplete. It lacks details on authentication, rate limits, error cases, and the structure of returned data (e.g., conversation objects). Without annotations or an output schema, the agent has insufficient information to handle this tool effectively in context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the input schema fully documents all 5 parameters with descriptions. The description adds minimal value by mentioning 'pagination and filtering options', which loosely corresponds to parameters like 'limit', 'offset', and 'statuses', but doesn't provide additional semantics beyond what the schema already specifies. This meets the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('retrieves') and resource ('user conversations from Omi'), making the purpose evident. It also mentions 'pagination and filtering options' which adds specificity. However, it doesn't explicitly distinguish this tool from its sibling 'read_omi_memories', which might cause confusion about when to retrieve conversations versus memories.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'read_omi_memories' or 'create_omi_conversation'. It mentions filtering options but doesn't specify scenarios or prerequisites for usage, leaving the agent without context for tool selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

read_omi_memoriesB

Retrieves user memories from Omi with pagination options

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of memories to return (max: 1000, default: 100)
offsetNoNumber of memories to skip for pagination (default: 0)
user_idYesThe user ID to fetch memories for

TDQS

B3.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions 'pagination options', which adds some context about how results are handled, but it does not cover other aspects like rate limits, authentication needs, error conditions, or what the return format looks like. This leaves gaps in understanding the tool's behavior beyond basic retrieval.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's function and key feature (pagination). It is front-loaded with the core purpose and avoids unnecessary words, making it highly concise and well-structured for quick comprehension.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (3 parameters, no output schema, no annotations), the description is minimally adequate. It covers the basic purpose and hints at pagination but lacks details on return values, error handling, or usage context. This leaves the agent with incomplete information for effective tool invocation, though it meets a baseline for a read operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% description coverage, documenting all three parameters (limit, offset, user_id) with details like defaults and constraints. The description adds no additional meaning beyond this, as it only mentions 'pagination options' without elaborating on parameter usage. This meets the baseline for high schema coverage but does not enhance parameter understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Retrieves') and resource ('user memories from Omi'), making the purpose specific and understandable. However, it does not explicitly differentiate from sibling tools like 'read_omi_conversations', which might retrieve a different type of data, so it lacks sibling differentiation for a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives, such as when to choose it over 'read_omi_conversations' or other siblings. It mentions pagination options but does not specify scenarios or prerequisites for usage, leaving the agent without contextual direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

TDQS

B3.4/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: create vs. read operations for two distinct resources (conversations and memories). The separation between conversations and memories is explicit, and the create/read distinction is unambiguous, leaving no room for confusion or misselection.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern with 'create' or 'read' as the verb and 'omi_conversations' or 'omi_memories' as the noun. The naming is perfectly uniform, using snake_case throughout, making the set highly predictable and readable.

Tool Count4/5

With 4 tools, the count is reasonable for a server focused on Omi conversations and memories. It covers create and read operations for both resources, which is well-scoped, though it might feel slightly thin if update or delete operations are expected in the domain, but it's not a significant issue.

Completeness3/5

The tool set provides create and read operations for both conversations and memories, covering basic CRUD elements. However, there are notable gaps: no update or delete tools for either resource, which could limit agent workflows if modifications or deletions are needed, making the surface incomplete for full lifecycle management.

Maintenance

ActivityInactive
ResponsivenessSyncing

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/fourcolors/omi-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server