@tonk/tonk-mcp
v1.0.1
Published
Worker service for Tonk Obsidian with MCP support
Downloads
7
Readme
Tonk MCP
MCP server and helper for Obsidian notes. This package provides a Model Context Protocol (MCP) server that allows Claude to interact with your Obsidian documents using RAG (Retrieval Augmented Generation).
Features
- MCP server for Claude integration
- ChromaDB integration for RAG capabilities
- Document management tools
- Daemon management for background services
- Built with Tonk
Installation
# Install globally
npm install -g tonk-mcp
# Or run directly with npx
npx tonk-mcpUsage
Basic MCP Server
# Run the MCP server (default command)
tonk-mcp
# Install Tonk MCP server configuration for Claude desktop
tonk-mcp installChromaDB Management
# Install ChromaDB and start the server
tonk-mcp chroma start
# Check Chroma daemon status
tonk-mcp chroma status
# Stop the Chroma daemon
tonk-mcp chroma stop
# Show Chroma logs
tonk-mcp chroma logsDaemon Management
# Start the Tonk worker daemon
tonk-mcp daemon start
# Check daemon status
tonk-mcp daemon status
# Stop the daemon
tonk-mcp daemon stop
# Show daemon logs
tonk-mcp daemon logs
# Install as a system service (survives restarts)
tonk-mcp daemon install-service
# Check system service status
tonk-mcp daemon service-statusClaude Integration
After installing, you can use the Tonk MCP server with Claude desktop. The server provides the following tools:
query_documents- Ask questions about your documentslist_documents- List all documents in the databaseadd_document- Add a document to the databasedelete_documents- Delete documents from the database
Configuration
The MCP server uses environment variables for configuration. You can create a .env file in your working directory with the following variables:
CHROMA_URL=http://localhost:8888
COLLECTION_NAME=tonk-docsDaemon Files
The daemon creates the following files in the user's home directory:
~/.tonk/tonk-worker.pid: Contains the process ID of the running daemon~/.tonk/logs/tonk-worker.log: Standard output log~/.tonk/logs/tonk-worker-error.log: Error log
Requirements
- Node.js 18+
- Python 3.8+ (for ChromaDB)
