MCP Obsidian

by gregkonush
Verified
MIT License
1,801
1

Integrations

  • Allows AI assistants to read, create, and manipulate notes in Obsidian vaults, with capabilities for reading active files, deleting files, inserting content at specific positions, appending content, opening files, listing vault files, and searching through notes.

Obsidiana MCP

Una implementación de servidor del Protocolo de Contexto de Modelo (MCP) para la integración con Obsidian . Esto permite que los asistentes de IA lean, creen y manipulen notas en su bóveda de Obsidian.

Características

  • Leer el archivo activo en Obsidian
  • Eliminar el archivo activo
  • Insertar contenido en posiciones específicas (encabezados, referencias de bloque, portadas)
  • Añadir contenido a los archivos
  • Abrir archivos específicos
  • Lista de archivos en tu bóveda
  • Busca entre tus notas

Prerrequisitos

  • Tiempo de ejecución de Bun
  • Aplicación de escritorio Obsidian
  • Un asistente de IA compatible con MCP

Añadir al cursor

Coloque su secreto en el archivo .env

Seleccione el comando MCP y luego ingrese este comando

bun __REPO_PATH__/src/index.ts

Instalación

  1. Clonar este repositorio:
    git clone https://github.com/gregkonush/mcp-obsidian.git cd mcp-obsidian
  2. Instalar dependencias:
    bun install
  3. Copie el archivo de entorno de ejemplo y configúrelo:
    cp .env.example .env

Configuración

Edite el archivo .env con sus configuraciones específicas:

OBSIDIAN_BASE_URL=http://localhost:27123 OBSIDIAN_TOKEN=your_token_here DEBUG=false

Uso

Inicie el servidor MCP:

bun run src/index.ts

El servidor se iniciará y se comunicará con los asistentes de IA compatibles con MCP a través de E/S estándar.

Herramientas disponibles

Esta implementación proporciona las siguientes herramientas a los asistentes de IA:

  • get_active_file - Devuelve el contenido del archivo actualmente activo
  • delete_active_file - Elimina el archivo actualmente activo
  • insert_active_file - Modifica el contenido relativo a un encabezado, una referencia de bloque o un campo frontmatter
  • append_active_file - Agrega contenido al final del archivo activo
  • open_file - Abre un archivo específico en Obsidian
  • search_simple - Busca documentos que coincidan con una consulta de texto
  • list_files - Enumera los archivos en el directorio raíz de su bóveda
  • list_directory_files : enumera los archivos en un directorio específico de su bóveda

Desarrollo

Estructura del proyecto

mcp-obsidian/ ├── src/ │ ├── index.ts # Main server implementation │ └── tools/ # Individual tool implementations │ ├── get-active-file.ts │ ├── delete-active-file.ts │ └── ... ├── .env # Environment configuration ├── package.json # Project dependencies └── tsconfig.json # TypeScript configuration

Agregar nuevas herramientas

Para agregar una nueva herramienta:

  1. Crea un nuevo archivo en el directorio src/tools/
  2. Implementar la herramienta utilizando el SDK de MCP
  3. Importar y registrar la herramienta en src/index.ts

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo LICENSE.md para obtener más detalles.

Contribuyendo

¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.

-
security - not tested
A
license - permissive license
-
quality - not tested

Una implementación de servidor que permite a los asistentes de IA leer, crear y manipular notas en bóvedas de Obsidian a través del Protocolo de Contexto de Modelo.

  1. Features
    1. Prerequisites
      1. Add to cursor
        1. Installation
          1. Configuration
            1. Usage
              1. Available Tools
                1. Development
                  1. Project Structure
                  2. Adding New Tools
                2. License
                  1. Contributing
                    ID: 4jgajfksuj