JSPM

@tonk/tonk-mcp

1.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q27853F
  • License MIT

Worker service for Tonk Obsidian with MCP support

Package Exports

  • @tonk/tonk-mcp
  • @tonk/tonk-mcp/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tonk/tonk-mcp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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-mcp

Usage

Basic MCP Server

# Run the MCP server (default command)
tonk-mcp

# Install Tonk MCP server configuration for Claude desktop
tonk-mcp install

ChromaDB 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 logs

Daemon 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-status

Claude 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 documents
  • list_documents - List all documents in the database
  • add_document - Add a document to the database
  • delete_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-docs

Daemon 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)