local-only server
The server can only run on the client’s local machine because it depends on local resources.
Integrations
Allows interaction with Obsidian via the Local REST API community plugin. Capabilities include listing files in vault, retrieving file contents, searching across vault files, patching content into existing notes, and appending content to new or existing files.
Servidor MCP para Obsidian
Servidor MCP para interactuar con Obsidian a través del complemento de la comunidad API REST local.
Componentes
Herramientas
El servidor implementa múltiples herramientas para interactuar con Obsidian:
- list_files_in_vault: enumera todos los archivos y directorios en el directorio raíz de su bóveda de Obsidian
- list_files_in_dir: enumera todos los archivos y directorios en un directorio específico de Obsidian
- get_file_contents: Devuelve el contenido de un solo archivo en su bóveda.
- Buscar: busca documentos que coincidan con una consulta de texto específica en todos los archivos del almacén.
- patch_content: Inserta contenido en una nota existente relativa a un encabezado, referencia de bloque o campo frontmatter.
- append_content: agrega contenido a un archivo nuevo o existente en el almacén.
- delete_file: elimina un archivo o directorio de tu bóveda.
Ejemplos de indicaciones
Es bueno indicarle primero a Claude que use Obsidian. Así, siempre llamará a la herramienta.
El uso indica lo siguiente:
- Obtenga el contenido de la última nota de llamada de arquitectura y resúmalo
- Busque todos los archivos donde se menciona Azure CosmosDb y explíqueme rápidamente el contexto en el que se menciona
- Resume las notas de la última reunión y guárdalas en una nueva nota llamada "resumenreunión.md". Añade una introducción para que pueda enviarla por correo electrónico.
Configuración
Clave API REST de Obsidian
Hay dos formas de configurar el entorno con la clave API REST de Obsidian.
- Agregar a la configuración del servidor (preferible)
- Cree un archivo
.env
en el directorio de trabajo con la siguiente variable requerida:
Nota: Puede encontrar la clave en la configuración del complemento Obsidian.
Inicio rápido
Instalar
API REST de Obsidian
Necesita el complemento comunitario Obsidian REST API en ejecución: https://github.com/coddingtonbear/obsidian-local-rest-api
Instálelo y habilítelo en la configuración y copie la clave API.
Escritorio de Claude
En MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
En Windows: %APPDATA%/Claude/claude_desktop_config.json
Desarrollo
Edificio
Para preparar el paquete para su distribución:
- Sincronizar dependencias y actualizar archivo de bloqueo:
Depuración
Dado que los servidores MCP se ejecutan en stdio, la depuración puede ser complicada. Para una experiencia óptima, recomendamos usar el Inspector MCP .
Puede iniciar el Inspector MCP a través de npm
con este comando:
Al iniciarse, el Inspector mostrará una URL a la que podrá acceder en su navegador para comenzar a depurar.
También puedes ver los registros del servidor con este comando:
You must be authenticated.
Servidor MCP para interactuar con Obsidian a través del complemento de la comunidad API REST local.