Skip to main content

Crate turbovault

Crate turbovault 

Source
Expand description

§TurboVault Server

Main server implementation and CLI for the Model Context Protocol (MCP) Obsidian vault manager.

TurboVault provides a production-grade MCP server that transforms Obsidian vaults into intelligent knowledge systems for AI agents. It offers advanced editing, search, graph analysis, and batch operations.

§Features

  • MCP Server Framework: Full Model Context Protocol implementation
  • Vault Management: File operations, watching, and atomic changesets
  • Advanced Search: Full-text search with Tantivy
  • Graph Analysis: Link relationships, backlinks, and health analysis
  • Batch Operations: Validated, sequential fail-fast file operations
  • Multiple Transports: Stdio (default), HTTP, WebSocket, TCP, Unix sockets
  • Export & Reporting: JSON/CSV export for analysis results

§Architecture

The crate is organized into several modules:

§Quick Start

use turbovault_core::ServerConfig;
use turbovault_vault::VaultManager;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize vault configuration
    let config = ServerConfig::default();
     
    // Create vault manager
    let _manager = VaultManager::new(config)?;
     
    Ok(())
}

§Transport Features

By default, the server uses stdio transport (suitable for Claude Desktop). Optional transports can be enabled via Cargo features:

  • stdio - Standard input/output (always included)
  • http - HTTP server support
  • websocket - WebSocket support
  • tcp - TCP socket support
  • unix - Unix domain socket support
  • full - All transports combined

§Documentation

See the main modules for detailed API documentation:

Re-exports§

pub use tools::ObsidianMcpServer;

Modules§

cli
TurboVault command-line parsing and runtime orchestration.
resources
Static resource documentation embedded directly in code. These resources are served via MCP resources and tool endpoints.
security
Who can reach the server and which directories it will serve.
tool_visibility
Which tools a client sees and may call: the tool_visibility config section, its CLI and environment overrides, and the TurboMCP visibility layer they build.
tools
MCP tool implementations for Obsidian vault