Servidor REST de Obsidian MCP

Una implementación de servidor MCP (Protocolo de Contexto de Modelo) que proporciona acceso a las bóvedas de Obsidian mediante una API REST local. Este servidor permite a los asistentes de IA interactuar con las notas de Obsidian y gestionar el contenido de la bóveda mediante una interfaz estandarizada.

Características

• Acceda al contenido de la bóveda de Obsidian a través de MCP
• Leer y escribir notas
• Listar el contenido de la bóveda
• Funcionalidad de búsqueda
• Integración segura de API REST local
• Compatible con Claude Desktop y otros asistentes de IA

Prerrequisitos

• Node.js 16 o superior
• Obsidian con el complemento API REST local instalado y configurado
• Una bóveda de Obsidian con API REST local habilitada

Instalación

Instalar el paquete globalmente:

O si prefieres usar una versión/rama específica:

Configuración

1. Primero, configure el complemento API REST local de Obsidian:
   • Instalar el complemento API REST local en Obsidian
   • Configurar el puerto API (predeterminado: 27123)
   • Generar y guardar una clave API
2. Crea un archivo de configuración config.json :

Uso

1. Iniciar el servidor:

2. El servidor se iniciará y escuchará las solicitudes MCP a través de stdin/stdout.

Uso con Claude Desktop

1. Configurar Claude Desktop para utilizar este servidor MCP:
   • Abra la configuración de Claude Desktop
   • Navegar a la sección MCP
   • Agregar nueva configuración del servidor:
     { "name": "obsidian-mcp", "command": "obsidian-mcp-rest", "args": ["--config", "path/to/config.json"] }
2. Claude ahora puede acceder a su bóveda de obsidiana a través de comandos como:
   Read note "Projects/MyProject.md" List all notes in "Projects" folder Search for notes containing "typescript"

Herramientas disponibles

• listNotes : enumera todas las notas en la bóveda o en una carpeta específica
• readNote : Lee el contenido de una nota específica
• writeNote : Crea o actualiza una nota
• searchNotes : busca notas mediante una cadena de consulta
• getMetadata : Obtener metadatos para una nota específica

Seguridad

• El servidor solo se ejecuta localmente y se comunica a través de stdin/stdout
• Todas las solicitudes a la API REST de Obsidian se autentican con su clave API
• No se requiere acceso a red externa
• Los datos permanecen locales en su máquina

Desarrollo

1. Clonar el repositorio:

2. Instalar dependencias:

3. Construir el proyecto:

4. Ejecutar pruebas:

Solución de problemas

Problemas de instalación

Si encuentra algún problema de instalación, pruebe estas alternativas:

1. Clonar e instalar localmente:

2. Si ve errores relacionados con TypeScript, asegúrese de que TypeScript esté instalado globalmente:

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios. Para cambios importantes, primero abra una incidencia para comentar qué desea cambiar.

Licencia

Licencia MIT: consulte el archivo de LICENCIA para obtener más detalles