Skip to main content

Joplin MCP Server - A Model Context Protocol Server for Joplin

Project description

📝 Joplin MCP Server

A Model Context Protocol (MCP) Server for Joplin that enables note access through the Model Context Protocol. Perfect for integration with AI assistants like Claude.

✨ Features

  • 🔍 Search Notes: Full-text search across all notes
  • 📖 Read Notes: Retrieve individual notes
  • ✏️ Edit Notes: Create new notes and update existing ones
  • 🗑️ Delete Notes: Move notes to trash or delete permanently
  • 📥 Markdown Import: Import markdown files as notes
  • 🤖 AI Integration: Seamless integration with Claude and other MCP-capable AI assistants

🚀 Installation

Prerequisites

  • Python 3.10 or higher
  • Joplin Desktop with Web Clipper Service enabled
  • uv (Python package manager)
# Clone repository
git clone https://github.com/dweigend/joplin-mcp.git
cd joplin-mcp

# Create and activate virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
```bash
uv pip install -e .

⚙️ Configuration

Joplin API Token

  1. Open Joplin Desktop
  2. Go to Tools -> Options -> Web Clipper
  3. Enable the Web Clipper Service
  4. Copy the API Token

Create a .env file in the project directory:

JOPLIN_TOKEN=your_api_token_here

Claude Desktop Setup

  1. Install Claude Desktop

    • Download Claude Desktop
    • Ensure you have the latest version (Menu: Claude -> Check for Updates...)
  2. Configure MCP Server

    {
      "mcpServers": {
        "joplin": {
          "command": "/PATH/TO/UV/uv",
          "args": [
            "--directory",
            "/PATH/TO/YOUR/PROJECT/joplin_mcp",
            "run",
            "src/mcp/joplin_mcp.py"
          ]
        }
      }
    }
    
    • Replace /PATH/TO/UV/uv with the absolute path to your uv installation
      • Find the path with: which uv
      • Example macOS: /Users/username/.local/bin/uv
      • Example Windows: C:\Users\username\AppData\Local\Microsoft\WindowsApps\uv.exe
    • Replace /PATH/TO/YOUR/PROJECT/joplin_mcp with the absolute path to your project

    Important: Claude Desktop needs the full path to uv as it cannot access shell environment variables.

🛠️ Available Tools

search_notes

Search for notes in Joplin.

Parameters:

  • query (string): Search query
  • limit (int, optional): Maximum number of results (default: 100)

get_note

Retrieve a specific note by its ID.

Parameters:

  • note_id (string): ID of the note

create_note

Create a new note.

Parameters:

  • title (string): Note title
  • body (string, optional): Note content in Markdown
  • parent_id (string, optional): ID of parent folder
  • is_todo (boolean, optional): Whether this is a todo item

update_note

Update an existing note.

Parameters:

  • note_id (string): ID of note to update
  • title (string, optional): New title
  • body (string, optional): New content
  • parent_id (string, optional): New parent folder ID
  • is_todo (boolean, optional): New todo status

delete_note

Delete a note.

Parameters:

  • note_id (string): ID of note to delete
  • permanent (boolean, optional): If true, permanently delete the note

import_markdown

Import a markdown file as a new note.

Parameters:

  • file_path (string): Path to the markdown file

🧪 Development

Debug Mode

To start the server in debug mode:

MCP_LOG_LEVEL=debug mcp dev src/mcp/joplin_mcp.py

This starts the MCP Inspector at http://localhost:5173 where you can test the tools.

📄 License

MIT License - Copyright (c) 2025 David Weigend

👤 Author

David Weigend

🤝 Contributing

Contributions, issues and feature requests are welcome! Visit the issues page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_dweigend_joplin_mcp-0.1.0.tar.gz (46.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_dweigend_joplin_mcp-0.1.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_dweigend_joplin_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: iflow_mcp_dweigend_joplin_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 46.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_dweigend_joplin_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c059fb9fb607ed49222971fc56957f118aec501b7697a70db7439c4b15f70f34
MD5 2ef7a21488209bed40c634ee3314911d
BLAKE2b-256 336f43aedfdef5f4b07ba3dc6685f39b7b75ecb7faf459c74ed6c853dca985c6

See more details on using hashes here.

File details

Details for the file iflow_mcp_dweigend_joplin_mcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_dweigend_joplin_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_dweigend_joplin_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc2f4e0c9964b76a142530f5fc50065c03f5afa2ed11ce7c25a1fcd4e68ccf4d
MD5 27aeeb099274232da0522e64323d7fc2
BLAKE2b-256 49b17b241a59985aac38b4b89ff50fdc5689211a1e1a4af616b479580c691e56

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page