Obsidian MCP Server

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Provides access to Obsidian vault contents, allowing retrieval of vault files and metadata through the 'get_vault_contents' tool. Connects to the Obsidian API to retrieve information about the vault structure and file contents.

Un servidor de protocolo de contexto de modelo para la integración de Obsidian

Este es un servidor MCP basado en TypeScript que implementa la integración con Obsidian. Demuestra los conceptos básicos de MCP al proporcionar:

  • Recursos que representan el contenido de la bóveda de obsidiana
  • Herramientas para acceder a los datos de la bóveda
  • Integración de API con Obsidian

Estadísticas del proyecto

  • Total de líneas de código: 345
  • Archivos principales:
    • src/tool-handlers.ts (76 líneas)
    • src/resource-handlers.ts (45 líneas)
    • src/server.ts (32 líneas)
    • src/api-client.ts (25 líneas)

Estructura del directorio

obsidian-mcp/ ├── .codegpt/ │ └── head ├── src/ │ ├── api-client.ts │ ├── index.ts │ ├── resource-handlers.ts │ ├── server.ts │ └── tool-handlers.ts ├── .SourceSageignore ├── package.json ├── README.md └── tsconfig.json

Características

Recursos

  • Acceda a la información del servidor de Obsidian a través del URI obsidian://server-info
  • Obtener el contenido de la bóveda con metadatos
  • Formato JSON para una fácil integración

Herramientas

  • get_vault_contents - Recupera el contenido de la bóveda de Obsidian
    • Toma la ruta como parámetro opcional (predeterminado: directorio raíz)
    • Devuelve una respuesta JSON estructurada

Integración de API

  • Conexión HTTPS segura con la API de Obsidian
  • Cliente axios personalizado con gestión de errores
  • Compatibilidad con la normalización de rutas de Windows

Desarrollo

Prerrequisitos

  • Node.js v18+
  • TypeScript 5.3+
  • Clave API de Obsidian (establecida como variable de entorno OBSIDIAN_API_KEY)

Configuración

# Install dependencies npm install # Build the server npm run build # Start development server with auto-rebuild npm run watch

Instalación

Para utilizar con Claude Desktop, agregue la configuración del servidor:

En MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json En Windows: %APPDATA%/Claude/claude_desktop_config.json

{ "mcpServers": { "obsidian-mcp": { "command": "/path/to/obsidian-mcp/build/index.js", "env": { "OBSIDIAN_API_KEY": "your-api-key-here" } } } }

Depuración

Recomendamos utilizar el Inspector MCP :

npm run inspector

El Inspector proporcionará una URL para acceder a las herramientas de depuración en su navegador.

Dependencias

Tiempo de ejecución

  • @modelcontextprotocol/sdk: Implementación del servidor MCP
  • axios: cliente HTTP para comunicación API

Desarrollo

  • @types/node: definiciones de TypeScript para Node.js
  • typescript: compilador de TypeScript

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

Este servidor MCP basado en TypeScript permite a los usuarios administrar y resumir notas de texto, brindando herramientas para la creación de notas y solicitudes de resumen.

  1. Directory Structure
    1. Features
      1. Resources
      2. Tools
      3. API Integration
    2. Development
      1. Prerequisites
      2. Setup
    3. Installation
      1. Debugging
        1. Dependencies
          1. Runtime
          2. Development
        ID: 02n7aazeu1