Servidor Omi MCP

Este proyecto proporciona un servidor de Protocolo de Contexto de Modelo (MCP) para interactuar con la API de Omi. El servidor proporciona herramientas para leer conversaciones y memorias, así como para crear nuevas conversaciones y memorias.

Configuración

1. Clonar el repositorio
2. Instalar dependencias con npm install
3. Crea un archivo .env con las siguientes variables:
   API_KEY=your_api_key APP_ID=your_app_id

Uso

Instalación mediante herrería

Para instalar Omi MCP Server para Claude Desktop automáticamente a través de Smithery :

Construyendo el servidor

Ejecución del servidor

Modo de desarrollo

Para desarrollo con recarga en caliente:

Probando el servidor

Se incluye un cliente de prueba sencillo para interactuar con el servidor MCP. Tras compilar el proyecto, ejecute:

O directamente:

Esto iniciará el servidor MCP y proporcionará un menú interactivo para probar las herramientas disponibles. El cliente de prueba utiliza un ID de usuario de prueba predeterminado ( test-user-123 ) para todas las operaciones.

Limpiar y reconstruir

Para limpiar el directorio de compilación y reconstruir desde cero:

Configuración con Claude y Cursor

Configuración de Claude

Para utilizar este servidor MCP con Claude a través de Anthropic Console o API:

1. Inicie el servidor MCP localmente:
   npm run start
2. Al configurar su conversación de Claude, configure la conexión MCP:
   { "mcp_config": { "transports": [ { "type": "stdio", "executable": { "path": "/path/to/your/omi-mcp-local/dist/index.js", "args": [] } } ] } }
3. Ejemplo de mensaje para Claude:
   Please fetch the latest 5 conversations for user "user123" using the Omi API.
4. Claude utilizará el MCP para ejecutar la herramienta read_omi_conversations :
   { "id": "req-1", "type": "request", "method": "tools.read_omi_conversations", "params": { "user_id": "user123", "limit": 5 } }

Configuración del cursor

Para utilizar este servidor MCP con Cursor:

1. Inicie el servidor MCP en una terminal:
   npm run start
2. En Cursor, vaya a Configuración > Extensiones > Servidores MCP
3. Agregue un nuevo servidor MCP con estas configuraciones:
   • Nombre: Omi API
   • URL: stdio:/ruta/a/su/omi-mcp-local/dist/index.js
   • Habilitar el servidor
4. Ahora puedes usar las herramientas de Omi directamente desde Cursor. Por ejemplo:
   @Omi API Please fetch memories for user "user123" and summarize them.
5. El cursor se comunicará con su servidor MCP para ejecutar las llamadas API necesarias.

Herramientas disponibles

El servidor MCP proporciona las siguientes herramientas:

leer_conversaciones_omi

Recupera conversaciones de Omi para un usuario específico, con filtros opcionales.

Parámetros:

• user_id (cadena): El ID del usuario para el que se buscarán las conversaciones
• limit (número, opcional): Número máximo de conversaciones a devolver
• offset (número, opcional): Número de conversaciones a omitir para la paginación
• include_discarded (booleano, opcional): si se deben incluir las conversaciones descartadas
• statuses (cadena, opcional): lista de estados separados por comas para filtrar conversaciones

leer_omi_memorias

Recupera recuerdos de Omi para un usuario específico.

Parámetros:

• user_id (cadena): El ID del usuario para el que se buscarán los recuerdos
• limit (número, opcional): Número máximo de memorias a devolver
• offset (número, opcional): Número de memorias a omitir para la paginación

crear_conversación_omi

Crea una nueva conversación en Omi para un usuario específico.

Parámetros:

• text (cadena): El contenido de texto completo de la conversación
• user_id (cadena): El ID del usuario para el que se creará la conversación
• text_source (cadena): Fuente del contenido del texto (opciones: "audio_transcript", "message", "other_text")
• started_at (cadena, opcional): cuándo comenzó la conversación/evento (formato ISO 8601)
• finished_at (cadena, opcional): cuándo finalizó la conversación/evento (formato ISO 8601)
• language (cadena, opcional): Código de idioma (predeterminado: "en")
• geolocation (objeto, opcional): Datos de ubicación para la conversación
  • latitude (número): coordenada de latitud
  • longitude (número): coordenada de longitud
• text_source_spec (cadena, opcional): Especificación adicional sobre la fuente

crear_recuerdos_omi

Crea nuevos recuerdos en Omi para un usuario específico.

Parámetros:

• user_id (cadena): El ID del usuario para el que se crearán recuerdos
• text (cadena, opcional): El contenido del texto del que se extraerán las memorias
• memories (matriz, opcional): una matriz de objetos de memoria explícitos que se crearán directamente
  • content (cadena): El contenido de la memoria
  • tags (matriz de cadenas, opcional): etiquetas para la memoria
• text_source (cadena, opcional): Fuente del contenido del texto
• text_source_spec (cadena, opcional): Especificación adicional sobre la fuente

Pruebas

Para probar el servidor MCP, puede utilizar el cliente de prueba proporcionado:

Esto iniciará un cliente de prueba interactivo que le permitirá:

1. Obtener conversaciones
2. Consigue recuerdos
3. Crear una conversación
4. Abandonar

El cliente de prueba utiliza un ID de usuario de prueba predeterminado ( test-user-123 ) para todas las operaciones.

Explotación florestal

El servidor MCP incluye una función de registro integrada que escribe tanto en la consola como en un archivo de registro. Esto resulta útil para depurar y supervisar la actividad del servidor.

Ubicación del archivo de registro

Los registros se guardan en logs/mcp-server.log en el directorio del proyecto. El archivo de registro incluye marcas de tiempo e información detallada sobre:

• Inicio y apagado del servidor
• Todas las solicitudes y respuestas de API
• Mensajes de error y seguimientos de pila
• Llamadas API a Omi
• Parámetros de solicitud y datos de respuesta

Visualización de registros

Puede ver los registros en tiempo real utilizando el comando tail :

Esto le mostrará actualizaciones en vivo a medida que el servidor procesa solicitudes e interactúa con la API de Omi.

Formato de registro

Cada entrada de registro sigue este formato:

La marca de tiempo está en formato ISO 8601, lo que facilita la correlación de eventos y la depuración de problemas.